{"info":{"_postman_id":"50db80f1-a5ca-4bd3-a784-6aac60504002","name":"FleetPay API Documentation","description":"

API de comunicação de sistemas parceiros com a FleetPay

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"40665015","collectionId":"50db80f1-a5ca-4bd3-a784-6aac60504002","publishedId":"2sAYJAfyJW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-09-19T19:50:37.000Z"},"item":[{"name":"Documents","item":[{"name":"Novo Documento","id":"8a4682b6-ee09-416a-8273-0af750fb432b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{BEARER_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"service_id\": \"3882013-x\",\n \"service_date\": \"2025-10-08\",\n \"service_type_id\": 1,\n \"document_type_id\": 3,\n \"customer_name\": \"Joana Tamiris Macedo Damas\",\n \"customer_cpf\": \"000.000.000-00\",\n \"customer_phone\": \"(00) 00000-0000\",\n \"origin_address\": {\n \"address\": \"Rua Teste\",\n \"number\": \"0\",\n \"district\": \"Centro\",\n \"city\": \"Florianópolis\",\n \"state\": \"SC\",\n \"zip\": \"00000-000\"\n },\n \"destination_address\": {\n \"address\": \"Rua Hoepcke\",\n \"number\": \"168\",\n \"complement\": \"1304 - Top tower\",\n \"district\": \"Centro\",\n \"city\": \"Florianópolis\",\n \"state\": \"SC\",\n \"zip\": \"88010-130\",\n \"country\": \"BR\"\n },\n \"cnpj_shipper\": \"23.353.693/0019-20\",\n \"cnpj_carrier\": \"60.882.872/0001-52\",\n \"cpf_driver\": \"138.179.929-98\",\n \"service_cost\": 132,\n \"split_rule_id\": null,\n \"driver_split_value\": null,\n \"driver_payment_date\": null,\n \"driver_quarantine_days\": 0,\n \"percentage_paid_at_start\": 0,\n \"shipper_payment_date\": \"2025-11-15\",\n \"status\": \"finished\",\n \"delivery_datetime\": \"2025-10-08 14:52:36\",\n \"scan_datetime\": \"2025-10-08 12:56:31\",\n \"origin_geolocation\": {\n \"lat\": null,\n \"lng\": null\n },\n \"destination_geolocation\": {\n \"lat\": -27.5933715,\n \"lng\": -48.5582441\n },\n \"route_id\": \"202576978\",\n \"route_date\": \"2025-10-08\",\n \"depot_id\": \"670d5f322bd551f0a553b326\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents","description":"

Cria novo Documento conforme os campos abaixo:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Obrigatório / Condicional	Exemplo	Descrição
service_id	string	Obrigatório	`\"ABC123\"`	Identificador interno do serviço na transportadora. Deve ser único dentro da mesma empresa.
route_id	string	Obrigatório (Caso o document_type_id = 4 e Service_type_id = 2)	`2`	ID da rota que deve ter sido previamente criada em nosso sistema. O campo service_id enviado para a criação da rota deve ser colocado aqui.
document_type_id	integer	Obrigatório	`2`	ID de um tipo de documento cadastrado em `pay_document_types`. Se for `CTE` (por ex. valor `1`), então `cte_key` se torna obrigatório. Tabela em anexo.
service_date	string (YYYY-MM-DD)	Obrigatório	`\"2025-06-10\"`	Data do serviço, formato ISO (ex.: 2025-06-10).
service_type_id	integer	Obrigatório	`1`	ID de um tipo de serviço em `pay_service_types`. Se for `ENTREGA` (por ex. valor `1`), Use 2 para enviar uma rota (Requer que o documento já tenha sido criado). Tabela em anexo.
customer_name	string (max 255)	Obrigatório	`\"João da Silva\"`	Nome do cliente (nome da pessoa ou razão social), até 255 caracteres.
customer_phone	string (regex)	Obrigatório	`\"(11) 91234-5678\"`	Telefone do cliente, no formato `(DD) NNNN-NNNN` ou `(DD) NNNNN-NNNN`.
customer_cpf	string (regex)	Obrigatório	`\"123.456.789-00\"`	CPF do cliente, no formato `000.000.000-00`.
origin_address	object	Obrigatório	`{ ... }`	Objeto JSON com 7 subcampos (ver detalhes abaixo).
└─ address	string	Obrigatório	`\"Rua X\"`	Logradouro (nome da rua, av., etc.)
└─ number	string	Obrigatório	`\"123\"`	Número do endereço
└─ complement	string or null	Opcional	`\"Bloco A\"` ou `null`	Complemento (apartamento, bloco, etc.)
└─ district	string	Obrigatório	`\"Centro\"`	Bairro ou distrito
└─ city	string	Obrigatório	`\"São Paulo\"`	Cidade
└─ state	string (2)	Obrigatório	`\"SP\"`	Sigla da Unidade Federativa (ex.: SP, RJ, MG)
└─ zip	string (regex)	Obrigatório	`\"01234-567\"`	CEP, no formato `00000-000`.
destination_address	object	Obrigatório	`{ ... }`	Mesma estrutura de `origin_address`, mas para o local de entrega.
└─ address	string	Obrigatório	`\"Av. Y\"`	Logradouro do destino.
└─ number	string	Obrigatório	`\"456\"`	Número do endereço de destino.
└─ complement	string or null	Opcional	`\"Sala 2\"`	Complemento do destino.
└─ district	string	Obrigatório	`\"Jardins\"`	Bairro de destino.
└─ city	string	Obrigatório	`\"Rio de Janeiro\"`	Cidade de destino.
└─ state	string (2)	Obrigatório	`\"RJ\"`	Sigla do Estado de destino.
└─ zip	string (regex)	Obrigatório	`\"20000-000\"`	CEP de destino no formato `00000-000`.
origin_geolocation.lat	numeric	Opcional	`-23.55052`	Latitude do ponto de origem (decimal).
origin_geolocation.lng	numeric	Opcional	`-46.633309`	Longitude do ponto de origem (decimal).
destination_geolocation.lat	numeric	Opcional	`-22.9035`	Latitude do ponto de destino (decimal).
destination_geolocation.lng	numeric	Opcional	`-43.2096`	Longitude do ponto de destino (decimal).
cnpj_shipper	string (regex)	Obrigatório	`\"12.345.678/0001-90\"`	CNPJ do remetente, no formato `00.000.000/0000-00`.
cnpj_carrier	string (regex)	Obrigatório	`\"98.765.432/0001-55\"`	CNPJ da transportadora, no formato `00.000.000/0000-00`.
service_cost	numeric	Obrigatório	`1500.50`	Valor numérico do custo do serviço.
shipper_payment_date	string (YYYY-MM-DD)	Obrigatório	`\"2025-06-20\"`	Data de pagamento do Embarcador para a Transportadora
split_rule_id	integer	Condicional (Não obrigatório se for usar split_value diretamente)	`3`	ID de regra de divisão de pagamento. Opcional se usar `driver_split_value`.
driver_split_value	numeric	Condicional (Não obrigatório se for usar split_rule_id)	`20.00`	Porcentagem ou valor a ser pago ao motorista. Opcional se usar `split_rule_id`.
driver_payment_date	string (YYYY-MM-DD)	Condicional (Não obrigatório se for usar split_rule_id)	`\"2025-06-20\"`	Data de pagamento ao motorista; exige estar após a `service_date`.
driver_quarantine_days	integer (0-30)	Condicional (Não obrigatório se for usar split_rule_id)	`7`	Quantidade de dias de quarentena do motorista.
percentage_paid_at_start	integer (0-100)	Condicional (Não obrigatório se for usar split_rule_id)	`50`	Percentual pago ao motorista no início (0-100).
cpf_driver	string (regex)	Obrigatório	`\"123.456.789-10\"`	CPF do motorista no formato `000.000.000-00`. Deve existir em nossa base de dados.
scan_datetime	string (YYYY-MM-DD HH:MM:SS)	Condicional (Obrigatório caso incluir delivery_datetime)	`\"2025-06-10 14:30:00\"`	Data e hora de leitura/scan. Se informado, deve ser uma data antes de `delivery_datetime`.
delivery_datetime	string (YYYY-MM-DD HH:MM:SS)	Opcional (Posterior a scan_datetime)	`\"2025-06-10 15:00:00\"`	Data e hora de entrega.
cte_key	string (regex)	Condicional (Obrigatório se service_type_id = CTE)	`\"12345678901234567890123456789012345678901234\"`	Chave do CT-e (só obrigatória quando `service_type_id` for CTE). Deve conter apenas dígitos (tamanho conforme seu padrão, ex. 44 dígitos).
nfe_key	string (regex)	Opcional	`\"43210987654321098765432109876543210987654321\"`	Chave da NF-e (se houver). Deve conter apenas dígitos (por exemplo, 44 dígitos).

DocumentType (document_type_id)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Tipo	Descrição
3	SHIPPER_INTERNAL_ID	Utilizado para envio de um documento cujo o código interno é administrado pelo próprio embarcador.
4	ROUTE	Utilizado para envio de uma rota.

ServiceType (document_type_id)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Tipo	Descrição
1	DELIVERY	Documento padrão de entrega
2	ROUTE	Serviço de Rota

","urlObject":{"path":["v1","documents"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d4101115-886b-456b-b013-fa4c247c9317","name":"Novo Documento Entregue","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123486\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"56.931.316/0001-51\",\n \"service_cost\": 300.00,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\",\n \"delivery_datetime\": \"2025-05-15 12:17:09\",\n \"scan_datetime\": \"2025-05-15 12:07:09\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 17:47:06 GMT"},{"key":"phpdebugbar-id","value":"01JW6V946BJEXNZCANB5ZG5FM8"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"id\": 109264,\n \"service_id\": 2686,\n \"message\": \"Documento criado com sucesso!\"\n}"},{"id":"4861c83d-cca4-4c6b-8289-f70530c8f99f","name":"Novo Documento Pendente de Bipagem","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123494\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"56.931.316/0001-51\",\n \"service_cost\": 300.00,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 19:13:03 GMT"},{"key":"phpdebugbar-id","value":"01JW706FPJD9PKCS1T40205AXB"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"id\": 109272,\n \"service_id\": 2690,\n \"message\": \"Documento criado com sucesso!\"\n}"},{"id":"a2df14a2-61cb-40e8-966c-237eb052d83a","name":"ID do Documento já existe","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123486\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"56.931.316/0001-51\",\n \"service_cost\": 300.00,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\",\n \"delivery_datetime\": \"2025-05-15 12:17:09\",\n \"scan_datetime\": \"2025-05-15 12:07:09\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 17:54:15 GMT"},{"key":"phpdebugbar-id","value":"01JW6VP6CAPDHQTE3SP59NY1GT"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Validation errors\",\n \"errors\": {\n \"service_id\": [\n \"O campo service_id já está em uso para esta transportadora.\"\n ]\n }\n}"},{"id":"c3b03d34-c82b-4020-9e73-d8575fc1926d","name":"Campos inválidos","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123487\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\",\n \"delivery_datetime\": \"2025-05-15 12:17:09\",\n \"scan_datetime\": \"2025-05-15 12:07:09\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 17:55:41 GMT"},{"key":"phpdebugbar-id","value":"01JW6VRTAY4MKBH7P5RZXTJ4ND"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Validation errors\",\n \"errors\": {\n \"cnpj_carrier\": [\n \"O campo cnpj_shipper é obrigatório.\"\n ],\n \"service_cost\": [\n \"O campo service_cost é obrigatório.\"\n ],\n \"cpf_driver\": [\n \"O CPF informado não corresponde a um motorista válido.\"\n ]\n }\n}"}],"_postman_id":"8a4682b6-ee09-416a-8273-0af750fb432b"},{"name":"Novo Documento em Massa","event":[{"listen":"prerequest","script":{"id":"b9e4ab08-535f-49a9-8bc7-8bf3572c2ad3","exec":["// ===== Configurações =====","const SERVICE_ID_PREFIX = \"DOC-\";","const PAD_WIDTH = 8; // DOC-0001, DOC-0002, ...","const TZ_OFFSET_MINUTES = -3 * 60; // America/Sao_Paulo (UTC-03)","const START_NUMBER_DEFAULT = 11; // <<<< ponto de partida (ex.: 11 => DOC-0011)","","// (Opcional) Você pode sobrescrever sem editar o script:","// Defina a env var SERVICE_START=42, por exemplo.","let START_NUMBER = parseInt("," pm.environment.get(\"SERVICE_START\") ??"," pm.collectionVariables.get(\"SERVICE_START\") ??"," START_NUMBER_DEFAULT,"," 10",");","","// ===== Helpers =====","function pad(num, width) {"," const s = String(num);"," return s.length >= width ? s : \"0\".repeat(width - s.length) + s;","}","","// Retorna um Date \"ajustado\" para o fuso informado.","// Usamos getUTC* depois, pois deslocamos o relógio manualmente.","function nowAtOffset(offsetMinutes) {"," const now = new Date();"," const utcMs = now.getTime() + now.getTimezoneOffset() * 60000;"," return new Date(utcMs + offsetMinutes * 60000);","}","","function addDays(date, days) {"," return new Date(date.getTime() + days * 24 * 60 * 60 * 1000);","}","","function formatYYYYMMDD(dateShifted) {"," const y = dateShifted.getUTCFullYear();"," const m = String(dateShifted.getUTCMonth() + 1).padStart(2, \"0\");"," const d = String(dateShifted.getUTCDate()).padStart(2, \"0\");"," return `${y}-${m}-${d}`;","}","","function randomInt(min, max) { // inclusivo"," return Math.floor(Math.random() * (max - min + 1)) + min;","}","","// ===== Gera service_id incremental persistente na Collection =====","let counter = pm.collectionVariables.get(\"service_id_counter\");","if (counter === undefined || counter === null || counter === \"\") {"," counter = START_NUMBER - 1; // primeira execução começa a partir do START_NUMBER","} else {"," counter = parseInt(counter, 10);"," if (Number.isNaN(counter)) counter = START_NUMBER - 1;","}","counter += 1;","pm.collectionVariables.set(\"service_id_counter\", counter);","","const service_id = `${SERVICE_ID_PREFIX}${pad(counter, PAD_WIDTH)}`;","","// ===== Datas no fuso America/Sao_Paulo =====","const todaySP = nowAtOffset(TZ_OFFSET_MINUTES);","const service_date = formatYYYYMMDD(todaySP);","const driver_payment_date = formatYYYYMMDD(addDays(todaySP, 30));","","// ===== Valores dinâmicos =====","const service_cost = randomInt(10, 100); // inteiro","const driver_split_value = Math.floor(service_cost * 0.15); // 15% sem centavos","","// ===== Payload =====","const payload = {"," \"service_id\": service_id,"," \"route_id\": \"\","," \"document_type_id\": 3,"," \"service_date\": service_date,"," \"service_type_id\": 1,"," \"cte_key\": \"\","," \"nfe_key\": \"\","," \"customer_name\": \"Cliente Teste 2\","," \"customer_cpf\": \"123.456.789-00\","," \"customer_phone\": \"(11) 98887-8766\","," \"origin_address\": {"," \"address\": \"Rua Jose de Souza\","," \"number\": \"99\","," \"complement\": null,"," \"district\": \"Lajeado\","," \"city\": \"São Paulo\","," \"zip\": \"08980-120\","," \"state\": \"SP\""," },"," \"origin_geolocation\": {"," \"lat\": 48.5949048698283,"," \"lng\": 7.746650936813134"," },"," \"destination_address\": {"," \"address\": \"Avenida Presidente Kennedy\","," \"number\": \"9988\","," \"complement\": null,"," \"district\": \"Vila Paulista\","," \"city\": \"São Paulo\","," \"zip\": \"08500-000\","," \"state\": \"SP\""," },"," \"destination_geolocation\": {"," \"lat\": 48.5949048698283,"," \"lng\": 7.746650936813134"," },"," \"cnpj_shipper\": \"96.378.310/7734-08\","," \"cnpj_carrier\": \"43.026.113/2162-29\","," \"service_cost\": service_cost,"," \"split_rule_id\": null,"," \"driver_split_value\": driver_split_value,"," \"driver_payment_date\": driver_payment_date,"," \"driver_quarantine_days\": 0,"," \"percentage_paid_at_start\": 0,"," \"cpf_driver\": \"\","," \"delivery_datetime\": null,"," \"scan_datetime\": null","};","","// Disponibiliza o JSON para usar no Body como {{payload}}","pm.variables.set(\"payload\", JSON.stringify(payload));","","// Debug opcional","console.log({ service_id, service_cost, driver_split_value, service_date, driver_payment_date });",""],"type":"text/javascript","packages":{}}}],"id":"ee035e36-5801-411f-9d05-bf38899c49dc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{BEARER_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{{payload}}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents","description":"

Cria novo Documento conforme os campos abaixo:

Campo	Tipo	Obrigatório / Condicional	Exemplo	Descrição
service_id	string	Obrigatório	`\"ABC123\"`	Identificador interno do serviço na transportadora. Deve ser único dentro da mesma empresa.
document_type_id	integer	Obrigatório	`2`	ID de um tipo de documento cadastrado em `pay_document_types`. Se for `CTE` (por ex. valor `1`), então `cte_key` se torna obrigatório.
service_date	string (YYYY-MM-DD)	Obrigatório	`\"2025-06-10\"`	Data do serviço, formato ISO (ex.: 2025-06-10).
service_type_id	integer	Obrigatório	`1`	ID de um tipo de serviço em `pay_service_types`. Se for `ENTREGA` (por ex. valor `1`), Use 2 para enviar uma rota (Requer que o documento já tenha sido criado).
customer_name	string (max 255)	Obrigatório	`\"João da Silva\"`	Nome do cliente (nome da pessoa ou razão social), até 255 caracteres.
customer_phone	string (regex)	Obrigatório	`\"(11) 91234-5678\"`	Telefone do cliente, no formato `(DD) NNNN-NNNN` ou `(DD) NNNNN-NNNN`.
customer_cpf	string (regex)	Obrigatório	`\"123.456.789-00\"`	CPF do cliente, no formato `000.000.000-00`.
origin_address	object	Obrigatório	`{ ... }`	Objeto JSON com 7 subcampos (ver detalhes abaixo).
└─ address	string	Obrigatório	`\"Rua X\"`	Logradouro (nome da rua, av., etc.)
└─ number	string	Obrigatório	`\"123\"`	Número do endereço
└─ complement	string or null	Opcional	`\"Bloco A\"` ou `null`	Complemento (apartamento, bloco, etc.)
└─ district	string	Obrigatório	`\"Centro\"`	Bairro ou distrito
└─ city	string	Obrigatório	`\"São Paulo\"`	Cidade
└─ state	string (2)	Obrigatório	`\"SP\"`	Sigla da Unidade Federativa (ex.: SP, RJ, MG)
└─ zip	string (regex)	Obrigatório	`\"01234-567\"`	CEP, no formato `00000-000`.
destination_address	object	Obrigatório	`{ ... }`	Mesma estrutura de `origin_address`, mas para o local de entrega.
└─ address	string	Obrigatório	`\"Av. Y\"`	Logradouro do destino.
└─ number	string	Obrigatório	`\"456\"`	Número do endereço de destino.
└─ complement	string or null	Opcional	`\"Sala 2\"`	Complemento do destino.
└─ district	string	Obrigatório	`\"Jardins\"`	Bairro de destino.
└─ city	string	Obrigatório	`\"Rio de Janeiro\"`	Cidade de destino.
└─ state	string (2)	Obrigatório	`\"RJ\"`	Sigla do Estado de destino.
└─ zip	string (regex)	Obrigatório	`\"20000-000\"`	CEP de destino no formato `00000-000`.
origin_geolocation.lat	numeric	Opcional	`-23.55052`	Latitude do ponto de origem (decimal).
origin_geolocation.lng	numeric	Opcional	`-46.633309`	Longitude do ponto de origem (decimal).
destination_geolocation.lat	numeric	Opcional	`-22.9035`	Latitude do ponto de destino (decimal).
destination_geolocation.lng	numeric	Opcional	`-43.2096`	Longitude do ponto de destino (decimal).
cnpj_shipper	string (regex)	Obrigatório	`\"12.345.678/0001-90\"`	CNPJ do remetente, no formato `00.000.000/0000-00`.
cnpj_carrier	string (regex)	Obrigatório	`\"98.765.432/0001-55\"`	CNPJ da transportadora, no formato `00.000.000/0000-00`.
service_cost	numeric	Obrigatório	`1500.50`	Valor numérico do custo do serviço.
invoice_sending_date	string (YYYY-MM-DD)	Obrigatório	`\"2025-06-15\"`	Data de emissão da fatura, formato ISO.
invoice_due_date	string (YYYY-MM-DD)	Obrigatório (Posterior a sending_date)	`\"2025-07-15\"`	Data de vencimento da fatura, deve ser posterior à `invoice_sending_date`.
split_rule_id	integer	Condicional (Não obrigatório se for usar split_value diretamente)	`3`	ID de regra de divisão de pagamento. Opcional se usar `driver_split_value`.
driver_split_value	numeric	Condicional (Não obrigatório se for usar split_rule_id)	`20.00`	Porcentagem ou valor a ser pago ao motorista. Opcional se usar `split_rule_id`.
driver_payment_date	string (YYYY-MM-DD)	Condicional (Não obrigatório se for usar split_rule_id)	`\"2025-06-20\"`	Data de pagamento ao motorista; exige estar após a `service_date`.
driver_quarantine_days	integer (0-30)	Condicional (Não obrigatório se for usar split_rule_id)	`7`	Quantidade de dias de quarentena do motorista.
percentage_paid_at_start	integer (0-100)	Condicional (Não obrigatório se for usar split_rule_id)	`50`	Percentual pago ao motorista no início (0-100).
cpf_driver	string (regex)	Obrigatório	`\"123.456.789-10\"`	CPF do motorista no formato `000.000.000-00`. Deve existir em nossa base de dados.
scan_datetime	string (YYYY-MM-DD HH:MM:SS)	Condicional (Obrigatório caso incluir delivery_datetime)	`\"2025-06-10 14:30:00\"`	Data e hora de leitura/scan. Se informado, deve ser uma data antes de `delivery_datetime`.
delivery_datetime	string (YYYY-MM-DD HH:MM:SS)	Opcional (Posterior a scan_datetime)	`\"2025-06-10 15:00:00\"`	Data e hora de entrega.
cte_key	string (regex)	Condicional (Obrigatório se service_type_id = CTE)	`\"12345678901234567890123456789012345678901234\"`	Chave do CT-e (só obrigatória quando `service_type_id` for CTE). Deve conter apenas dígitos (tamanho conforme seu padrão, ex. 44 dígitos).
nfe_key	string (regex)	Opcional	`\"43210987654321098765432109876543210987654321\"`	Chave da NF-e (se houver). Deve conter apenas dígitos (por exemplo, 44 dígitos).

","urlObject":{"path":["v1","documents"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"5898cd65-4e42-4b04-b796-0f7cb17f34fc","name":"Novo Documento Entregue","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123486\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"56.931.316/0001-51\",\n \"service_cost\": 300.00,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\",\n \"delivery_datetime\": \"2025-05-15 12:17:09\",\n \"scan_datetime\": \"2025-05-15 12:07:09\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 17:47:06 GMT"},{"key":"phpdebugbar-id","value":"01JW6V946BJEXNZCANB5ZG5FM8"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"id\": 109264,\n \"service_id\": 2686,\n \"message\": \"Documento criado com sucesso!\"\n}"},{"id":"718a1bef-1410-4491-8707-bf41afcde313","name":"Novo Documento Pendente de Bipagem","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123494\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"56.931.316/0001-51\",\n \"service_cost\": 300.00,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 19:13:03 GMT"},{"key":"phpdebugbar-id","value":"01JW706FPJD9PKCS1T40205AXB"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"id\": 109272,\n \"service_id\": 2690,\n \"message\": \"Documento criado com sucesso!\"\n}"},{"id":"502d61e1-30d0-4add-8d5b-ee7f7d91e241","name":"ID do Documento já existe","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123486\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"56.931.316/0001-51\",\n \"service_cost\": 300.00,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\",\n \"delivery_datetime\": \"2025-05-15 12:17:09\",\n \"scan_datetime\": \"2025-05-15 12:07:09\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 17:54:15 GMT"},{"key":"phpdebugbar-id","value":"01JW6VP6CAPDHQTE3SP59NY1GT"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Validation errors\",\n \"errors\": {\n \"service_id\": [\n \"O campo service_id já está em uso para esta transportadora.\"\n ]\n }\n}"},{"id":"1f243903-802d-4392-a9cf-d080d2671534","name":"Campos inválidos","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"service_id\": \"DOC-123487\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_cpf\": \"223.921.058-59\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": {\n \"address\": \"Rua Jose de Souza\",\n \"number\": \"99\",\n \"complement\": null,\n \"district\": \"Lajeado\",\n \"city\": \"São Paulo\",\n \"zip\": \"08980-120\",\n \"state\": \"SP\"\n },\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": {\n \"address\": \"Avenida Presidente Kennedy\",\n \"number\": \"9988\",\n \"complement\": null,\n \"district\": \"Vila Paulista\",\n \"city\": \"São Paulo\",\n \"zip\": \"08500-000\",\n \"state\": \"SP\"\n },\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-02-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220.00,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"367.510.678-01\",\n \"delivery_datetime\": \"2025-05-15 12:17:09\",\n \"scan_datetime\": \"2025-05-15 12:07:09\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/documents"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 17:55:41 GMT"},{"key":"phpdebugbar-id","value":"01JW6VRTAY4MKBH7P5RZXTJ4ND"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Validation errors\",\n \"errors\": {\n \"cnpj_carrier\": [\n \"O campo cnpj_shipper é obrigatório.\"\n ],\n \"service_cost\": [\n \"O campo service_cost é obrigatório.\"\n ],\n \"cpf_driver\": [\n \"O CPF informado não corresponde a um motorista válido.\"\n ]\n }\n}"}],"_postman_id":"ee035e36-5801-411f-9d05-bf38899c49dc"},{"name":"Busca Documentos","id":"9a9bc31d-f0f9-45ce-8f26-65283465458f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API_TOKEN}}"},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}/v1/documents/{{$id}}","description":"

Cria novo Documento

\n","urlObject":{"path":["v1","documents","{{$id}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8e446b6d-30fe-4435-a608-6f2bf42777bf","name":"Busca Documento Existentes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_TOKEN}}","description":"Authorization for API Token","type":"text"}],"url":"https://core.fleetpay.site/api//v1/documents/14"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 14,\n \"internal_id\": \"DOC-123456\",\n \"service_id\": \"DOC-123456\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": \"Rua Jose de Souza, 99 Lajeado - São Paulo - SP\",\n \"origin_cep\": \"08980-120\",\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": \"Avenida Presidente Kennedy, 9988 Vila Paulista - São Paulo - SP\",\n \"destination_cep\": \"08500-000\",\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"26.263.149/0001-57\",\n \"service_cost\": 300,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-01-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"500.495.360-01\",\n \"delivery_datetime\": \"2025-05-15 12:07:09\"\n }\n}"},{"id":"c8e23a8b-440f-496a-954d-4d110de5ed9e","name":"Busca Documento Inexistente","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_TOKEN}}","description":"Authorization for API Token","type":"text"}],"url":"{{URL}}/v1/documents/22"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"data\": {}\n}"},{"id":"b883031f-c88c-4a30-948d-758d8de5065f","name":"Busca Documentos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_TOKEN}}","description":"Authorization for API Token","type":"text"}],"url":"{{URL}}/v1/documents/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 14,\n \"internal_id\": \"DOC-123456\",\n \"service_id\": \"DOC-123456\",\n \"document_type_id\": 3,\n \"service_date\": \"2025-02-10\",\n \"service_type_id\": 1,\n \"customer_name\": \"Joao da Silva\",\n \"customer_phone\": \"(11) 98887-8766\",\n \"origin_address\": \"Rua Jose de Souza, 99 Lajeado - São Paulo - SP\",\n \"origin_cep\": \"08980-120\",\n \"origin_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"destination_address\": \"Avenida Presidente Kennedy, 9988 Vila Paulista - São Paulo - SP\",\n \"destination_cep\": \"08500-000\",\n \"destination_geolocation\": {\n \"lat\": 48.5949048698283,\n \"lng\": 7.746650936813134\n },\n \"cnpj_shipper\": \"07.578.865/0001-89\",\n \"cnpj_carrier\": \"26.263.149/0001-57\",\n \"service_cost\": 300,\n \"invoice_sending_date\": \"2025-01-07\",\n \"invoice_due_date\": \"2025-01-07\",\n \"split_rule_id\": null,\n \"driver_split_value\": 220,\n \"driver_payment_date\": \"2025-05-25\",\n \"driver_quarantine_days\": 7,\n \"percentage_paid_at_start\": 0,\n \"cpf_driver\": \"500.495.360-01\",\n \"delivery_datetime\": \"2025-05-15 12:07:09\"\n },\n {\n \"id\": 15,\n \"internal_id\": \"DOC-654321\",\n \"service_id\": \"DOC-654321\",\n \"document_type_id\": 2,\n \"service_date\": \"2025-03-01\",\n \"service_type_id\": 2,\n \"customer_name\": \"Maria Oliveira\",\n \"customer_phone\": \"(19) 97777-6655\",\n \"origin_address\": \"Rua das Flores, 123 Centro - Campinas - SP\",\n \"origin_cep\": \"13010-000\",\n \"origin_geolocation\": {\n \"lat\": 22.9099388,\n \"lng\": -47.0626332\n },\n \"destination_address\": \"Av. Paulista, 1000 Bela Vista - São Paulo - SP\",\n \"destination_cep\": \"01310-100\",\n \"destination_geolocation\": {\n \"lat\": -23.564224,\n \"lng\": -46.654156\n },\n \"cnpj_shipper\": \"11.222.333/0001-55\",\n \"cnpj_carrier\": \"33.444.555/0001-66\",\n \"service_cost\": 450,\n \"invoice_sending_date\": \"2025-02-28\",\n \"invoice_due_date\": \"2025-03-05\",\n \"split_rule_id\": null,\n \"driver_split_value\": 300,\n \"driver_payment_date\": \"2025-06-01\",\n \"driver_quarantine_days\": 5,\n \"percentage_paid_at_start\": 20,\n \"cpf_driver\": \"888.777.666-55\",\n \"delivery_datetime\": \"2025-06-01 09:30:00\"\n },\n {\n \"id\": 16,\n \"internal_id\": \"DOC-789012\",\n \"service_id\": \"DOC-789012\",\n \"document_type_id\": 1,\n \"service_date\": \"2025-04-20\",\n \"service_type_id\": 3,\n \"customer_name\": \"Carlos Pereira\",\n \"customer_phone\": \"(21) 96666-5544\",\n \"origin_address\": \"Av. Brasil, 500 Jardim América - Rio de Janeiro - RJ\",\n \"origin_cep\": \"22430-060\",\n \"origin_geolocation\": {\n \"lat\": -22.971964,\n \"lng\": -43.182544\n },\n \"destination_address\": \"Rua XV de Novembro, 200 Centro - Curitiba - PR\",\n \"destination_cep\": \"80020-310\",\n \"destination_geolocation\": {\n \"lat\": -25.428954,\n \"lng\": -49.273251\n },\n \"cnpj_shipper\": \"22.333.444/0001-66\",\n \"cnpj_carrier\": \"44.555.666/0001-77\",\n \"service_cost\": 520,\n \"invoice_sending_date\": \"2025-04-15\",\n \"invoice_due_date\": \"2025-04-20\",\n \"split_rule_id\": null,\n \"driver_split_value\": 380,\n \"driver_payment_date\": \"2025-06-10\",\n \"driver_quarantine_days\": 10,\n \"percentage_paid_at_start\": 10,\n \"cpf_driver\": \"777.666.555-44\",\n \"delivery_datetime\": \"2025-06-10 16:45:30\"\n }\n ],\n \"first_page_url\": \"{{URL}}/api/v1/documents?page=1\",\n \"from\": 1,\n \"last_page\": 6,\n \"last_page_url\": \"{{URL}}/api/v1/documents?page=6\",\n \"links\": [\n { \"url\": null, \"label\": \"« Previous\", \"active\": false },\n { \"url\": \"{{URL}}/api/v1/documents?page=1\", \"label\": \"1\", \"active\": true },\n { \"url\": \"{{URL}}/api/v1/documents?page=2\", \"label\": \"2\", \"active\": false },\n { \"url\": \"{{URL}}/api/v1/documents?page=3\", \"label\": \"3\", \"active\": false },\n { \"url\": \"{{URL}}/api/v1/documents?page=4\", \"label\": \"4\", \"active\": false },\n { \"url\": \"{{URL}}/api/v1/documents?page=5\", \"label\": \"5\", \"active\": false },\n { \"url\": \"{{URL}}/api/v1/documents?page=6\", \"label\": \"6\", \"active\": false },\n { \"url\": \"{{URL}}/api/v1/documents?page=2\", \"label\": \"Next »\", \"active\": false }\n ],\n \"next_page_url\": \"{{URL}}/api/v1/documents?page=2\",\n \"path\": \"{{URL}}/api/v1/documents\",\n \"per_page\": 3,\n \"prev_page_url\": null,\n \"to\": 3,\n \"total\": 16\n }\n}\n"},{"id":"7cc1210f-76cd-4423-8b7f-788bfd82043f","name":"Busca Documentos Vazios","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_TOKEN}}","description":"Authorization for API Token","type":"text"}],"url":"{{URL}}/v1/documents/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"current_page\": 1,\n \"data\": [],\n \"first_page_url\": \"{{URL}}/api/v1/documents?page=1\",\n \"from\": null,\n \"last_page\": 0,\n \"last_page_url\": \"{{URL}}/api/v1/documents?page=0\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"{{URL}}/api/v1/documents?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"{{URL}}/api/v1/documents\",\n \"per_page\": 3,\n \"prev_page_url\": null,\n \"to\": null,\n \"total\": 0\n }\n}\n"}],"_postman_id":"9a9bc31d-f0f9-45ce-8f26-65283465458f"}],"id":"8be3a73e-91c1-42c7-b81f-2595bfcc80ac","description":"

Adiciona novo documento no sistema

\n","_postman_id":"8be3a73e-91c1-42c7-b81f-2595bfcc80ac"},{"name":"Shippers","item":[{"name":"get-carrier","id":"0cd9f1ac-9caa-493d-b231-6d4fc734ef83","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{BEARER_TOKEN}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cpf\": \"059.698.402-55\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/shippers/get-carrier","urlObject":{"path":["v1","shippers","get-carrier"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"afd714c4-b955-4494-82c3-a14912425363","name":"CPF não encontrado","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cpf\": \"059.698.402-55\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/shippers/get-carrier"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 30 Sep 2025 00:02:45 GMT"},{"key":"phpdebugbar-id","value":"01K6BYVH0RZEJEN2XE5X9G6WTF"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"CPF não encontrado na base de dados.\",\n \"errors\": {\n \"cpf\": [\n \"CPF não encontrado na base de dados.\"\n ]\n }\n}"},{"id":"cd5764d2-fb8b-4f60-8497-bf60dd20c4b3","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cpf\": \"059.698.402-55\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/v1/shippers/get-carrier"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.3.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 30 Sep 2025 01:29:35 GMT"},{"key":"phpdebugbar-id","value":"01K6C3TGW9XKZP5TD1ANCC3M2X"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"user_id\": 6,\n \"user_name\": \"Usuário 6\",\n \"user_cpf\": \"059.698.402-55\",\n \"carrier\": {\n \"id\": 4,\n \"name\": \"Empresa 4\",\n \"cnpj\": \"43.026.113/2162-29\",\n \"legal_name\": \"Empresa 4 LTDA\"\n }\n }\n}"}],"_postman_id":"0cd9f1ac-9caa-493d-b231-6d4fc734ef83"}],"id":"83429f77-8c1c-4693-9ead-eac664cd5b77","_postman_id":"83429f77-8c1c-4693-9ead-eac664cd5b77","description":""},{"name":"Investor","item":[{"name":"Banking","item":[{"name":"Listar Contas","id":"8d93968b-9543-43cd-a10a-6f6d53bd7ab4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","description":"

Token de autenticação

\n","type":"text"}],"url":"{{URL}}/api/v1/investors/banking/list-account/{{ID}}?per_page&page","description":"

Listar Contas de um Veículo de Investimento
Método: GET
URL: {{BASE_URL}}/api/v1/investors/banking/list-account/{{vehicleId}}

Descrição do Endpoint:

Listar Contas de um Veículo de Investimento

Retorna as contas bancárias associadas a um veículo de investimento específico, incluindo a conta do próprio veículo e as contas das empresas relacionadas através de factorings.

Headers:

Authorization: Bearer {{token}}
\n
Accept: application/json
\n

Path Parameters:

vehicleId (integer, obrigatório): ID do veículo de investimento

Query Parameters:

per_page (integer, opcional): Quantidade de itens por página (1-100). Padrão: 15
\n
page (integer, opcional): Número da página. Padrão: 1
\n

Resposta de Sucesso (200):
{
\"vehicle_account\": {
\"vehicle_name\": \"Fundo de Investimento XYZ\",
\"account_id\": 100
},
\"companies_accounts\": {
\"current_page\": 1,
\"data\": [
{
\"company_name\": \"Transportadora ABC Ltda\",
\"account_id\": 200
},
{
\"company_name\": \"Transportadora XYZ Ltda\",
\"account_id\": 201
}
],
\"first_page_url\": \"...\",
\"from\": 1,
\"last_page\": 1,
\"last_page_url\": \"...\",
\"links\": [...],
\"next_page_url\": null,
\"path\": \"...\",
\"per_page\": 15,
\"prev_page_url\": null,
\"to\": 2,
\"total\": 2
}
}

Campos da Resposta:

vehicle_account:

vehicle_name: Nome do veículo de investimento
\n
account_id: ID da conta bancária do veículo
\n

companies_accounts:

company_name: Nome da empresa transportadora
\n
account_id: ID da conta bancária da empresa
\n

Observações:

A vehicle_account pode ser null se o veículo não possuir conta bancária vinculada
\n
As companies_accounts incluem apenas contas de empresas que possuem factorings liquidados associados ao veículo através de limites de crédito
\n

\n","urlObject":{"path":["api","v1","investors","banking","list-account","{{ID}}"],"host":["{{URL}}"],"query":[{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"per_page","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"page","value":null}],"variable":[]}},"response":[],"_postman_id":"8d93968b-9543-43cd-a10a-6f6d53bd7ab4"},{"name":"Obter Saldo","id":"df8ea16f-6ed7-4768-b847-e270ee8761d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","description":"

Token de autenticação

\n","type":"text"}],"url":"{{URL}}/api/v1/investors/banking/get-account-balance/{{ID}}","description":"

Consultar Saldo de uma Conta
Método: GET
URL: {{BASE_URL}}/api/v1/investors/banking/get-account-balance/{{accountId}}

Descrição do Endpoint:

Consultar Saldo de uma Conta

Retorna o saldo atual de uma conta bancária específica.

Headers:

Authorization: Bearer {{token}}
\n
Accept: application/json
\n

Path Parameters:

accountId (integer, obrigatório): ID da conta bancária

Resposta de Sucesso (200):
{
\"balance\": 150000.00
}

Campos da Resposta:

balance: Saldo atual da conta (valor numérico)

Observações:

Contas vinculadas a motoristas não podem ser consultadas (retorna erro 403)
\n
O usuário deve ter acesso à conta através de veículos de investimento ou factorings relacionados
\n

\n","urlObject":{"path":["api","v1","investors","banking","get-account-balance","{{ID}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"df8ea16f-6ed7-4768-b847-e270ee8761d3"},{"name":"Transações da Conta","id":"baadfec6-7efb-413e-84d0-b51dd9f4e943","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","description":"

Token de autenticação

\n","type":"text"}],"url":"{{URL}}/api/v1/investors/banking/list-transactions/{{ID}}?per_page&page&date_from&date_to&search","description":"

Listar Transações de uma Conta
Método: GET
URL: {{BASE_URL}}/api/v1/investors/banking/list-transactions/{{accountId}}

Descrição do Endpoint:

Listar Transações de uma Conta

Retorna o extrato de transações de uma conta bancária específica.

Headers:

Authorization: Bearer {{token}}
\n
Accept: application/json
\n

Path Parameters:

accountId (integer, obrigatório): ID da conta bancária

Query Parameters:

per_page (integer, opcional): Quantidade de itens por página (1-100). Padrão: 15
\n
page (integer, opcional): Número da página. Padrão: 1
\n
date_from (string, opcional): Data inicial do filtro (formato: YYYY-MM-DD)
\n
date_to (string, opcional): Data final do filtro (formato: YYYY-MM-DD)
\n
search (string, opcional): Termo de busca
\n

Resposta de Sucesso (200):
{
\"current_page\": 1,
\"data\": [
{
\"id\": \"trans-001\",
\"date\": \"2024-01-15\",
\"description\": \"Transferência recebida\",
\"amount\": 50000.00,
\"type\": \"credit\",
\"balance\": 150000.00
}
],
\"first_page_url\": \"...\",
\"from\": 1,
\"last_page\": 1,
\"last_page_url\": \"...\",
\"links\": [...],
\"next_page_url\": null,
\"path\": \"...\",
\"per_page\": 15,
\"prev_page_url\": null,
\"to\": 1,
\"total\": 1
}

Observações:

A estrutura exata dos dados retornados depende da API externa de pagamentos (PaymentService)
\n
Contas vinculadas a motoristas não podem ser consultadas (retorna erro 403)
\n
O usuário deve ter acesso à conta através de veículos de investimento ou factorings relacionados
\n

\n","urlObject":{"path":["api","v1","investors","banking","list-transactions","{{ID}}"],"host":["{{URL}}"],"query":[{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"per_page","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"date_from","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"date_to","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"search","value":null}],"variable":[]}},"response":[],"_postman_id":"baadfec6-7efb-413e-84d0-b51dd9f4e943"}],"id":"d0b4c245-0536-4d85-918d-3617c71f2119","description":"

========================================
Banking
========================================

Descrição da Pasta:

Endpoints relacionados a contas bancárias e transações de veículos de investimento.

Todas as rotas da API de Investidores estão prefixadas com /api/v1/investors.

Exemplo: Se a BASE_URL for https://teste.fleetpay.tech, a URL completa seria:
https://teste.fleetpay.tech/api/v1/investors/...

\n","_postman_id":"d0b4c245-0536-4d85-918d-3617c71f2119"},{"name":"Duplicatas","item":[{"name":"Listar Veículos","id":"e1838b6a-e382-485c-ae24-1d5636701738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","description":"

Token de autenticação

\n","type":"text"}],"url":"{{URL}}/api/v1/investors/vehicles/list?per_page=1&page=1","description":"

DESCRIÇÃO:
Retorna lista paginada de todos os veículo de investimento disponíveis para o usuário.

AUTORIZAÇÃO:

Retorna 403 se não tiver acesso

PARÂMETROS DE QUERY:

ENDPOINT: Listar Veículos de Investimento
Método: GET
URL: {{BASE_URL}}/api/v1/investors/vehicles/list

Descrição do Endpoint:

Listar Veículos de Investimento

Retorna a lista de veículos de investimento (vehicles) disponíveis para o usuário autenticado.

Headers:

Authorization: Bearer {{token}}
\n
Accept: application/json
\n

Query Parameters:

per_page (integer, opcional): Quantidade de itens por página (1-100). Padrão: 15

Resposta de Sucesso (200):
{
\"current_page\": 1,
\"data\": [
{
\"id\": 2,
\"name\": \"Fundo de Investimento XYZ\",
\"valor_operacao\": 1000000.00,
\"quantidade_cotas\": 1000
}
],
\"first_page_url\": \"https://{BASE_URL}/api/v1/investors/vehicles/list?page=1\",
\"from\": 1,
\"last_page\": 1,
\"last_page_url\": \"https://{BASE_URL}/api/v1/investors/vehicles/list?page=1\",
\"links\": [...],
\"next_page_url\": null,
\"path\": \"https://{BASE_URL}/api/v1/investors/vehicles/list\",
\"per_page\": 15,
\"prev_page_url\": null,
\"to\": 1,
\"total\": 1
}

Campos da Resposta:

id: ID do veículo de investimento
\n
name: Nome do veículo de investimento
\n
valor_operacao: Valor total da operação
\n
quantidade_cotas: Quantidade de cotas disponíveis
\n

per_page (opcional, integer, padrão: 15)
\n
page (implicitamente via paginate)
\n

\n","urlObject":{"path":["api","v1","investors","vehicles","list"],"host":["{{URL}}"],"query":[{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"per_page","value":"1"},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"e1838b6a-e382-485c-ae24-1d5636701738"},{"name":"Consultar Duplicatas","id":"d06d9f07-b3cd-4c56-94cf-8026efb8e531","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","description":"

Token de autenticação

\n","type":"text"}],"url":"{{URL}}/api/v1/investors/vehicles/duplicatas/{{ID}}?per_page&sort&direction&search&date_from&date_to&page","description":"

Consultar Duplicatas de um Veículo
Método: GET
URL: {{BASE_URL}}/api/v1/investors/vehicles/duplicatas/{{vehicleId}}

Descrição do Endpoint:

Consultar Duplicatas de um Veículo

Retorna a lista de duplicatas (receivables) associadas a um veículo de investimento específico.

Headers:

Authorization: Bearer {{token}}
\n
Accept: application/json
\n

Path Parameters:

vehicleId (integer, obrigatório): ID do veículo de investimento

Query Parameters:

per_page (integer, opcional): Quantidade de itens por página (1-100). Padrão: 15
\n
page (integer, opcional): Número da página. Padrão: 1
\n
sort (string, opcional): Campo para ordenação. Opções: due_date, numero_fatura, status_duplicata, data_antecipacao, data_conclusao_servico, taxa_desagio, tipo_duplicata, valor_duplicata, valor_desembolsado, cnpj_embarcador, cnpj_transportadora. Padrão: due_date
\n
direction (string, opcional): Direção da ordenação. Opções: asc ou desc. Padrão: desc
\n
search (string, opcional): Termo de busca (busca em múltiplos campos)
\n
date_from (string, opcional): Data inicial do filtro (formato: YYYY-MM-DD)
\n
date_to (string, opcional): Data final do filtro (formato: YYYY-MM-DD)
\n

Resposta de Sucesso (200):
{
\"current_page\": 1,
\"data\": [
{
\"cnpj_embarcador\": \"12.345.678/0001-90\",
\"cnpj_transportadora\": \"98.765.432/0001-10\",
\"numero_fatura\": \"FAT-2024-001\",
\"status_duplicata\": \"Liquidada\",
\"data_antecipacao\": \"2024-01-15\",
\"data_conclusao_servico\": \"2024-01-10\",
\"data_vencimento\": \"2024-02-15\",
\"tipo_duplicata\": \"NFe\",
\"valor_duplicata\": 50000.00,
\"valor_desembolsado\": 47500.00,
\"taxa_desagio\": 5.00
}
],
\"first_page_url\": \"...\",
\"from\": 1,
\"last_page\": 1,
\"last_page_url\": \"...\",
\"links\": [...],
\"next_page_url\": null,
\"path\": \"...\",
\"per_page\": 15,
\"prev_page_url\": null,
\"to\": 1,
\"total\": 1
}

Campos da Resposta:

cnpj_embarcador: CNPJ da empresa embarcadora
\n
cnpj_transportadora: CNPJ da empresa transportadora
\n
numero_fatura: Número interno da fatura/documento
\n
status_duplicata: Status atual da duplicata
\n
data_antecipacao: Data em que a duplicata foi antecipada
\n
data_conclusao_servico: Data de conclusão do serviço de transporte
\n
data_vencimento: Data de vencimento da duplicata
\n
tipo_duplicata: Tipo do documento (NFe, CTe)
\n
valor_duplicata: Valor total da duplicata
\n
valor_desembolsado: Valor efetivamente desembolsado na antecipação
\n
taxa_desagio: Taxa de deságio calculada (percentual)
\n

Observações:

O campo tipo_duplicata pode retornar \"NFe\" ou \"CTe\" conforme o tipo de documento
\n
A busca (search) funciona nos seguintes campos: ID da duplicata, ID do documento, número da fatura, tipo de duplicata, status, nome/CNPJ da transportadora, nome/CNPJ do embarcador, e ID do factoring
\n
O filtro de data aplica-se ao campo data_vencimento
\n

\n","urlObject":{"path":["api","v1","investors","vehicles","duplicatas","{{ID}}"],"host":["{{URL}}"],"query":[{"description":{"content":"

(Opcional) Itens por página

\n","type":"text/plain"},"key":"per_page","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"direction","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"search","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"date_from","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"date_to","value":null},{"description":{"content":"

(Opcional)

\n","type":"text/plain"},"key":"page","value":null}],"variable":[]}},"response":[],"_postman_id":"d06d9f07-b3cd-4c56-94cf-8026efb8e531"}],"id":"a0914896-fc84-4229-b6e2-385a4df12c73","_postman_id":"a0914896-fc84-4229-b6e2-385a4df12c73","description":""}],"id":"8ab2a444-b439-4c35-b97d-e437374cd328","description":"

========================================
Veículos de Investimento
========================================

Endpoints relacionados a veículos de investimento (vehicles) e suas duplicatas.

Todas as rotas da API de Investidores estão prefixadas com /api/v1/investors.

Exemplo: Se a BASE_URL for https://teste.fleetpay.tech, a URL completa seria:
https://teste.fleetpay.tech/api/v1/investors/...

========================================
INFORMAÇÕES GERAIS
========================================

Códigos de Status HTTP:

200: OK - Requisição bem-sucedida
\n
403: Forbidden - Usuário não possui permissão ou acesso ao recurso solicitado
\n
404: Not Found - Recurso não encontrado (veículo, conta, etc.)
\n
422: Unprocessable Entity - Erro de validação nos dados enviados
\n
500: Internal Server Error - Erro interno do servidor
\n

Estrutura de Respostas Paginadas:
Todos os endpoints que retornam listas utilizam paginação padrão do Laravel. A estrutura inclui:
{
\"current_page\": 1,
\"data\": [...],
\"first_page_url\": \"...\",
\"from\": 1,
\"last_page\": 1,
\"last_page_url\": \"...\",
\"links\": [
{
\"url\": null,
\"label\": \"« Previous\",
\"active\": false
},
{
\"url\": \"...\",
\"label\": \"1\",
\"active\": true
},
{
\"url\": null,
\"label\": \"Next »\",
\"active\": false
}
],
\"next_page_url\": null,
\"path\": \"...\",
\"per_page\": 15,
\"prev_page_url\": null,
\"to\": 1,
\"total\": 1
}

Estrutura de Respostas de Erro:
Todas as respostas de erro seguem o padrão:
{
\"message\": \"Mensagem de erro descritiva\"
}

Em caso de erro de validação (422), a resposta inclui detalhes:
{
\"message\": \"Dados de entrada inválidos.\",
\"errors\": {
\"campo\": [
\"Mensagem de erro específica do campo\"
]
}
}

Notas Importantes:

Autenticação Obrigatória: Todos os endpoints (exceto login) requerem o header Authorization: Bearer {token}
\n
Controle de Acesso: O sistema verifica automaticamente se o usuário possui acesso aos recursos solicitados. Caso não possua, retornará erro 403.
\n
Paginação: Utilize os parâmetros page e per_page para navegar entre páginas de resultados. O máximo de itens por página é 100.
\n
Filtros de Data: Utilize o formato YYYY-MM-DD para os parâmetros de data (date_from, date_to).
\n
Busca: O parâmetro search realiza busca em múltiplos campos dependendo do endpoint.
\n
Ordenação: Utilize sort e direction para ordenar os resultados conforme necessário.
\n
Rate Limiting: Considere implementar controle de taxa de requisições para evitar sobrecarga.
\n
Tratamento de Erros: Sempre verifique os códigos de status HTTP e trate adequadamente os erros retornados.
\n

========================================
VARIÁVEIS DO POSTMAN
========================================

Configure as seguintes variáveis na Collection ou Environment:

BASE_URL: https://teste.fleetpay.tech
token: (será preenchido automaticamente após o login)

Para configurar o token automaticamente após o login, adicione este script no Test do endpoint de Login:

var jsonData = pm.response.json();
if (jsonData.token) {
pm.collectionVariables.set(\"token\", jsonData.token);
console.log(\"Token salvo: \" + jsonData.token);
}

\n","_postman_id":"8ab2a444-b439-4c35-b97d-e437374cd328"},{"name":"login","event":[{"listen":"test","script":{"id":"95756b91-387f-4087-9af1-147adf6003f0","exec":["const responseJson = pm.response.json();","pm.environment.set(\"BEARER_TOKEN\", responseJson.bearer_token);"],"type":"text/javascript","packages":{}}}],"id":"05df7401-11eb-4eb7-ad37-9e258d7a8764","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"{{EMAIL}}\",\n \"password\": \"{{PASSWORD}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/login","description":"\n

This endpoint is used to authenticate a user and obtain a bearer token for accessing protected resources.

Request Body

email (string, required): The email address of the user.
\n
password (string, required): The password of the user.
\n

Success response

The response is in JSON format and has the following schema:

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"success\": {\n            \"type\": \"boolean\"\n        },\n        \"message\": {\n            \"type\": \"string\"\n        },\n        \"bearer_token\": {\n            \"type\": \"string\"\n        }\n    }\n}\n\n

Failure response

The response is in JSON format and has the following schema:

442 - invalid field(s)

{\n    \"message\": \"The selected email is invalid.\",\n    \"errors\": {\n        \"email\": [\n            \"The selected email is invalid.\"\n        ]\n    }\n}\n\n

403 - invalid email and/or password

{\n    \"success\": false,\n    \"message\": \"Email e/ou senha inválido(s).\"\n}\n\n

\n","urlObject":{"path":["login"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05df7401-11eb-4eb7-ad37-9e258d7a8764"}],"variable":[{"key":"service_id_counter","value":""}]}