{"openapi":"3.0.0","info":{"title":"5 - Contratos - CIOT Emissão","description":"<img src=\"https://content.pstmn.io/cdc1b90c-f25d-47ed-bfba-bcdb7218fb39/YW1iaXBhcl9jYXJnb18yMDIzLnBuZw==\">\n\n# Introdução\n\nColeção de serviços referente ao Contrato de Frete\n\n<img src=\"https://content.pstmn.io/9eb79569-bd3b-4669-b61c-950abfd06e6f/Z2VyYWwgLSBnYXRld2F5LWZpbmFsLnBuZw==\">\n\n# Chaves Primárias\n\n### Viagem\n\nIdentificador da viagem fornecido pelo TMS: \\[_travelCode\\]_\n\n### Contrato\n\nIdentificador do Contrato Criado pelo Amipar Cargo: \\[_contractId\\]_\n\n\\*Um contrato pode ser acessado pelo código da viagem fornecido pelo TMS, ou pelo id do contrato que é retornado pela Ambipar Cargo.\n\n# \uD83D\uDE80 Comece aqui\n\nThis template guides you through CRUD operations (GET, POST, PUT, DELETE), variables, and tests.\n\n## \uD83D\uDD16 Como usar esta documentação\n\n#### **Passo 1: Envie requisições**\n\nRESTful APIs allow you to perform CRUD operations using the POST, GET, PUT, and DELETE HTTP methods.\n\nThis collection contains each of these [request](null) types. Open each request and click \"Send\" to see what happens.\n\n#### **Passo 2: Visualize respostas**\n\nObserve the response tab for status code (200 OK), response time, and size.\n\n#### **Passo 3: Envie novos bodies**\n\nUpdate or add new data in \"Body\" in the POST request. Typically, Body data is also used in PUT request.\n\n```\n{\n    \"name\": \"Add your name in the body\"\n}\n\n ```\n\n#### **Passo 4: Atualize a variavel**\n\nVariables enable you to store and reuse values in Postman. We have created a [variable](null) called `base_url` with the sample request [https://postman-api-learner.glitch.me](null). Replace it with your API endpoint to customize this collection.\n\n#### **Passo 5: Adicione testes na aba \"Tests\"**\n\nTests help you confirm that your API is working as expected. You can write test scripts in JavaScript and view the output in the \"Test Results\" tab.\n\n<img src=\"https://content.pstmn.io/b5f280a7-4b09-48ec-857f-0a7ed99d7ef8/U2NyZWVuc2hvdCAyMDIzLTAzLTI3IGF0IDkuNDcuMjggUE0ucG5n\">\n\n## \uD83D\uDCAA Dicas Pro\n\n- Use folders to group related requests and organize the collection.\n- Add more [scripts](null) in \"Tests\" to verify if the API works as expected and execute workflows.\n- Quando um campo estiver marcado como opcional, não é necessário informa-lo na integração,  \n    basta omitir o campo em questão, ou informá-lo com vazio, branco ou nulo e será considerado como preenchido e aplicaremos as regras de validação.\n    \n\n## \uD83D\uDCA1Assuntos relacionados\n\n[API testing basics](null)  \n[API documentation](null)  \n[Authorization methods](null)\n\n# Autenticação\n\nToken JWT\n\n# Códigos de Erros\n\n100, indica que a solicitação foi recebida.  \n200, indica sucesso da solicitação.  \n301, indica que um endpoint foi movido para outro endereço.  \n302, indica que um endpoint foi movido temporariamente.  \n400, indica que a solicitação está incorreta.  \n403, indica que o acesso é proibido.  \n404, indica que o endpoint não foi encontrada.  \n410, indica que o recurso não está mais disponível.  \n500, indica um erro interno do servidor.","version":"1.0.0"},"servers":[{"url":"http://{{server}}"}],"paths":{"/contracts":{"post":{"tags":["General"],"summary":"Emitir Contrato Frete","description":"| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| travelCode | string | Código da Viagem fornecido pelo TMS | Não |\n| name | string | Nome | Não |\n| branchContractorCNPJ | string | CNPJ da filial contratante | Não |\n\n##### contracted\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| CNPJ | string | CNPJ | Não |\n| IE | string | Inscrição Estadual | Não |\n| RNTRC | string | RNTRC | Não |\n| email | string | email | Não |\n| name | string | nome | Não |\n\n###### address\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| street | string | Rua do ndereço | Não |\n| number | string | Número do endereço | Não |\n| complement | string | Complemento do endereço | Não |\n| zip | string |  | Não |\n| IBGE | string | IBGE | Não |\n\n###### phones\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| number | string | Némro de telefone | Não |\n| areaCode | string | código de área | Não |\n| type | string | tipo de número telefônico | Não |\n\n###### address\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| street | string | endereço | Não |\n| complement | string | complemento | Não |\n| neighborhood | string | Bairo | Não |\n| zip | string |  | Não |\n| IBGE | string | IBGE | Não |\n\n###### recipient\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| name | string | nome | Não |\n| CNPJ | string | CNPJ | Não |\n\n###### address\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| street | string | rua do endereço | Não |\n| complement | string | compplemento | Não |\n| neighborhood | string | bairo | Não |\n| zip | string |  | Não |\n| IBGE | string | IBGE | Não |\n\n###### Driver\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| CPF | string | CPF | Não |\n\n##### vehicles\n\n###### truck\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| contractorCNPJ | string | CNPJ do contratante | Não |\n| plate | string | placa | Não |\n| RNTRC | string | RNTRC | Não |\n| axes | string | quantidade de eixos | Não |\n| branch | string | Filial | Não |\n| model | string | modelo | Não |\n| color | string | cor | Não |\n| manufactureYear | string | ano de fabricação | Não |\n| modelYear | string | modelo / ano | Não |\n| typeVehicle | string | tipo de veículo | Não |\n| IBGE | string | IBGE | Não |\n| renavam | string | renavam | Não |\n| chassis | string |  | Não |\n| plateIBGE | string | Placa IBGE | Não |\n| name | string | nome | Não |\n\n###### semiTrailer\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| contractorCNPJ | string | CNPJ do contratante | Não |\n| plate | string | placa | Não |\n| RNTRC | string | RNTRC | Não |\n| axes | string | eixos | Não |\n| branch | string | Filial | Não |\n| model | string | modelo | Não |\n| color | string | cor | Não |\n| manufactureYear | string | ano de fabricação | Não |\n| modelYear | string | modelo / ano | Não |\n| typeVehicle | string | tipo de veículo | Não |\n| IBGE | string | IBGE | Não |\n| renavam | string | renavam | Não |\n| chassis | string |  | Não |\n| plateIBGE | string | placa IBGE | Não |\n| name | string | nome | Não |\n\n###### cargoDetails\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| cargoTypeAnttCode | string | código do tipo de carga ANTT | Não |\n| unitFreightValue | string | Valor de frete unitário | Não |\n| goodsKgValue | string | Valor da mercadoria em KG | Não |\n| cargoType | string | Tipo de carga | Não |\n| tripType | string | Tipo de viagem. Default \"standard\" | Não |\n| NCMCode | string | Código NCM | Não |\n| weightTotalQuantity | string | Peso da quantidade total de saída | Não |\n\n###### journeyTime\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| start | string | Começou | Não |\n| finish | string | Acabou | Não |\n\n###### costDetails\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| tollAmount | number | Valor de pedágio | Não |\n| branchCothersValueontractorCNPJ | string |  | Não |\n| totalFreightValue | string | Valor total do frete | Não |\n\n###### taxesFees\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| cargoTypeAnttCode | string | Código do tipo de carga ANTTC | Não |\n| INSSValue | string | Valor do INSS | Não |\n| IRValue | string | Valor do imposto de renda | Não |\n| sestSenatValue | string | sestSenatValue | Não |\n| insuranceValue | string |  | Não |\n| othersValues | string | Outros valores | Não |\n\n##### Pagamento de Frete\n\n###### Regras de Quitação\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| typeTolerance | string | Tipo de tolerância que será aplicado na quitação:  <br>\"perc\" (porcentagem) ou \"kilo\" (Kg). | Não |\n| tolerance | number | Valor da tolerância (kg ou %) |  |\n| weightType | string | Tipo do peso que será utilizado no momento da quitação do frete:  <br>\"departure\" Cálculo do frete será realizado pelo peso de saída.  <br>\"arrival\" Cálculo do frete será realizado pelo peso de chegada. \"lower-weight\" Cálculo do frete será realizado pelo  <br>menor peso. | Não |\n| breakageTypeCharge | string | Tipo de cobrança que será aplicado  <br>para quebra (quando houver):  <br>\"not-charge\" Não será realizado  <br>nenhum desconto na quitação.  <br>\"partial-charge\" Será descontado apenas o  <br>que ultrapassar do valor informado em  <br>quebraTolerancia.  <br>\"full-charge\" Se ultrapassar do valor  <br>informado em quebraTolerancia,  <br>será descontado na quitação cem  <br>por cento da quebra. | Não |\n| breakageTolerance | string | Margem de tolerância para quebra, conforme o TipoTolerância  <br>definido (Porcentagem ou peso).  <br> | Não |\n| damageTypeCharge | string | Tipo de cobrança que será aplicado para avaria(quando houver):  <br>\"not-charge\" Não será realizado nenhum desconto na quitação. \"full-charge\" Será descontado na  <br>quitação cem por cento da avaria.  <br> | Não |\n| upperLimit |  | É o limite máximo para  <br>pagamento do excedente, seja de  <br>acordo com tipoTolerância  <br>definido:  <br>Padrão = 0% ou 0kg.  <br>SE o valor máximo para  <br>pagamento do excedente, seja  <br>diferente do \"Padrão\" (0% ou 0kg)  <br>é obrigatório o Contratante enviar  <br>esta tag com valor máximo (% ou  <br>kg) que será permitido. |  |\n| breakageCharge | boolean | Indicador se há cobrança por quebra | Não |\n| damageCharge | boolean | Indicador se há cobrança por avaria | Não |\n\n###### Informações Obrigatórias na Quitação\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| deliveryDate | boolean | Indica se a data de entrega de cada Nfe deve ser exigida no momento  <br>da quitação do frete. | Não |\n| weight | boolean | Peso | Não |\n| roadScale | boolean | roadScale | Não |\n| breakdown | boolean | Indica se o valor de avaria deve ser  <br>informado para cada Nfe no  <br>momento da quitação do frete. | Não |\n| invoiceStub | boolean | Indica se o canhoto de recebimento  <br>da Nfe deve ser recolhido no  <br>momento da quitação do frete.  <br>(por Nfe) | Não |\n| tollReceipt | boolean | Indica se o comprovante de  <br>pedágio deve ser recolhido no  <br>momento da quitação do frete. | Não |\n| DACTe | boolean | Indica se o DACTE deve ser  <br>recolhido no momento da quitação  <br>do frete. (por documento de  <br>viagem) | Não |\n\n###### Adiantamento\n\nValores de adiantamento do frete.\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| date | string | Data | Não |\n| parcelType | string | Tipo de parcela: \"percent\" ou \"amount\" | Não |\n| value | number | Valor do adiantamento em porcentagem ou em valor |  |\n\n##### Participação no valor do frete\n\n###### Participação do Motorista\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| advancePercent | number | Porcentagem do adiantamento | Não |\n| acquittalsPercent | number | Porcentagem na quitação | Não |\n| advanceAmount | number | Valor do adiantamento | Não |\n| acquittalsPercent | number | Valor da quitação | Não |\n\n###### Participação do Contratado\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| advancePercent | number | Porcentagem do adiantamento | Não |\n| acquittalsPercent | number | Porcentagem na quitação | Não |\n| advanceAmount | number | Valor do adiantamento | Não |\n| acquittalsPercent | number | Valor da quitação | Não |\n\n##### travelDocuments\n\n###### documents (CTe)\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| series | string | Série | Não |\n| number | string | Número | Não |\n| type | string | Tipo | Não |\n\n###### invoices (NFe)\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| series | string | Série | Não |\n| number | string | Número | Não |\n| type | string | Tipo | Não |\n\n| Campos | Tipo | Descrição | Obrigatório |\n| --- | --- | --- | --- |\n| series | string | Série | Não |","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":{"travelCode":"123","branchContractorCNPJ":"","roundTrip":true,"issueTollVoucher":false,"hiredCo":{"document":"12345679000","IE":"ISENTA","RNTRC":"55555","email":"teste2@teste.com","name":"Nome Empresa Teste 2","address":{"street":"Rua Silvia Crinstina","number":"99","complement":"Casa","neighborhood":"Jardim das paineiras","zip":"05555000","IBGE":"966"},"phones":[{"number":"999999999","areaCode":"11","type":"mobile"},{"number":"33333333","areaCode":"11","type":"business"}]},"sender":{"name":"Sender name","CNPJ":"","address":{"street":"Rua Silvia Crinstina","number":"99","complement":"Casa","neighborhood":"Jardim das paineiras","zip":"05555000","IBGE":"966"}},"recipient":{"name":"Recipiente name","CNPJ":"","address":{"street":"Rua Silvia Crinstina","number":"99","complement":"Casa","neighborhood":"Jardim das paineiras","zip":"05555000","IBGE":"966"}},"driver":{"name":"","email":"","birthDate":"","document":"","CNH":{"category":"E","number":"12345","validity":"2025-01-01"},"address":{"street":"Rua Silvia Crinstina","number":"99","complement":"Casa","neighborhood":"Jardim das paineiras","zip":"05555000","IBGE":"966"},"phones":[{"areaCode":"11","number":"999999999","type":""}],"payment":{"pix":"","cardNumber":"","type":"card"}},"vehicles":{"truck":{"plate":"","axes":"","branch":"","model":"","color":"","manufactureYear":"","modelYear":"","renavam":"","chassis":"","plateIBGE":"","axleType":"duplo"},"semiTrailer":{"plate":"","axes":"","branch":"","model":"","color":"","manufactureYear":"","modelYear":"","renavam":"","chassis":"","plateIBGE":"","axleType":"duplo"}},"liftedAxles":{"going":0,"return":2},"stops":{"going":[{"zip":"05555-000"}],"return":[{"zip":"05555-000","liftedAxles":2}]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"","tripType":"","NCMCode":"","weightTotalQuantity":0},"journeyTime":{"start":"","finish":""},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"acquittanceRules":{"tolerance":false,"tolerancePercent":0,"shippingTypeWeight":"C","breakingTolerance":0,"breakCharge":false,"faultCharge":false},"mandatoryDischarge":{"deliveryDate":false,"weight":false,"roadScale":false,"breakdown":false,"invoiceStub":false,"voucherToll":false,"DACTe":false},"advancePayment":{"date":"","paymentType":"percentage","value":10},"apportionment":{"driver":{"advancePercent":0},"hiredCo":{"advancePercent":0}}},"travelDocuments":[{"document":{"series":"","number":"","type":"CTe"},"invoices":[{"series":"","number":"","type":"NFe"}],"valueDocumentTravel":0}]}}}}},"parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"201":{"description":"Created","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"4fe-eKaG3hZbSwSxvCRCH8Ci5jwsH18\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 04:58:11 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"examples":{"example-0":{"summary":"Emitir Contrato Frete OK","value":{"CIOT":"654","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","_id":"64460c621e62792a099c60b2","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"}},"example-1":{"summary":"Emitir Contrato Frete OK Copy","value":{"CIOT":"987","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","_id":"64460c621e62792a099c60b2","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"}}}}}}}}},"/contracts/":{"get":{"tags":["General"],"summary":"Buscar Contrato","description":"### Status do Contrato\n\n'AguardandoLiberacao'  \n'EmViagem'  \n'Finalizado'  \n'Bloqueado'  \n'Cancelado'  \n'QuitacaoLiberada'  \n'EntregaDigital'  \n'BloqueadoSaldoInsuficiente'\n\n### Status do Pedágio\n\n'AguardandoLiberacao'  \n'AguardandoCarregamento'  \n'AguardandoConfirmacaoCarregamento'  \n'CarregamentoRealizado'  \n'AguardandoCancelamento'  \n'AguardandoConfirmacaoCancelamento'  \n'CarregamentoCancelado'  \n'PedagioEncerrado'  \n'PedagioExpurgado'\n\n###### contracted\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CNPJ | string | \\- | CNPJ | Não |\n| IE | string | \\- | Inscrição Estadual | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| email | string | \\- | Email | Não |\n| name | string | \\- | Nome | Não |\n\n###### sender\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\n###### address\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Rua | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairo | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\n###### recipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\n###### address\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Rua | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairo | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\n###### Diver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| driverLicense | string | \\- | Carteira de motorista | Não |\n| category | string | \\- | Categoria | Não |\n| number | string | \\- | Número | Não |\n| validity | string | \\- | Validade | Não |\n\n##### vehicles\n\n###### truck\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ do contratante | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixos | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veiculo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | Placa IBGE | Não |\n| name | string | \\- | Nome | Não |\n\n###### semiTrailer\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ do contratante | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixos | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veiculo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | PlacA iBGE | Não |\n| name | string | \\- | Nome | Não |\n\n###### cargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor do frete unitário | Não |\n| goodsKgValue | string | \\- | Valor por Kg da mercadoria | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade do peso total | Não |\n\n###### journeyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\n###### costDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\n###### taxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\n##### payment\n\n###### dischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\n###### mandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- |  | Não |\n| breakdown | string | \\- |  | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\n###### advancePayment\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| date | string | \\- | Data | Não |\n| parcelType | string | \\- | Tipo de parcela | Não |\n| units | string | \\- | Unidades | Não |\n\n##### apportionment\n\n###### driver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- |  | Não |\n| settlePercent | string | \\- |  | Não |\n\n###### hiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- |  | Não |\n| settlePercent | string | \\- |  | Não |\n\n##### travelDocuments\n\n###### documents\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\n###### invoices\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |","parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}}}}},"/contract/CIOT":{"get":{"tags":["General"],"summary":"Busca CIOT","description":"This is a GET request and it is used to \"get\" data from an endpoint. There is no request body for a GET request, but you can use query parameters to help specify the resource you want data on (e.g., in this request, we have `id=1`).\n\n###### Retorno\n\n| Campos | Tipo | Tamanho | Descrição |\n| --- | --- | --- | --- |\n| travelCode | string | \\- | Chave da viagem no TMS |\n| CIOT | string | \\- | CIOT grado na ANTT |\n\nA successful GET response will have a `200 OK` status, and should include some kind of response body - for example, HTML web content or JSON data.","parameters":[{"name":"travelCode","in":"query","schema":{"type":"integer"},"example":"1"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"Content-Length":{"schema":{"type":"integer","example":"34"}},"ETag":{"schema":{"type":"string","example":"W/\"22-irc+YXtZHlx83bfYV3FHBnXanjk\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Date":{"schema":{"type":"string","example":"Wed, 26 Jul 2023 12:43:59 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"travelCode":"123","contractID":1324,"CIOT":"777"}}}}}}},"/contracts/payment/authorize":{"put":{"tags":["General"],"summary":"Autorizar Pagamento do Saldo do Contrato","description":"Para autorizar o pagamento é preciso enviar o travelCode, que é o identificador da viagem/frete no TMS, ou enviar o contractID, que é o ID do contrato no Ambipar Cargo que é retornado na emissão do contrato.\n\nBody\n\n<table><tbody><tr><th>Campos</th><th>Tipo</th><th>Descrição</th></tr><tr><td>travelCode</td><td>string</td><td>Código da Viagem no TMS</td></tr><tr><td>shipperDocument</td><td>0</td><td>Documento do Embarcador</td></tr><tr><td>shipperBranchDocument</td><td>0</td><td>Documento da Filial do Embarcador</td></tr><tr><td>carrierDocument</td><td>0</td><td>Documento do Transportador</td></tr><tr><td>driverDocument</td><td>0</td><td>Documento do Motorista</td></tr><tr><td>truckPlate</td><td>0</td><td>Placa do Veículo</td></tr><tr><td>value</td><td>0</td><td>Valor Total da Prestação de Contas</td></tr><tr><td>advance value</td><td>0</td><td>valor Adiantamento</td></tr><tr><td>loadValue</td><td>0</td><td>valor Carga</td></tr><tr><td>loadweight</td><td>0</td><td>peso Carga</td></tr><tr><td>tollvalue</td><td>0</td><td>valor Pedagio</td></tr><tr><td>roundtrip</td><td>true</td><td>roteiro Ida Volta</td></tr><tr><td>axisSuspendedIda</td><td>0</td><td>eixo Suspenso Ida</td></tr><tr><td>axisHoldBack</td><td>0</td><td>eixo Suspenso Volta</td></tr><tr><td>tipoMidiaValePedagio</td><td>0</td><td>tipo Midia Vale Pedagio</td></tr><tr><td>statusContractID</td><td>0</td><td>status Contrato ID</td></tr><tr><td>dataEmission</td><td>2023-02-15T19:01:31.116Z</td><td>data Emissao</td></tr><tr><td>datePrevisaoEntrega</td><td>2023-02-15T19:01:31.116Z</td><td>data Previsao Entrega</td></tr><tr><td>dateUpdate</td><td>2023-02-15T19:01:31.116Z</td><td>data Atualizacao</td></tr><tr><td>dateForecastOutput</td><td>2023-02-15T19:01:31.116Z</td><td>data Prevista Saida</td></tr><tr><td>plannedAccountabilityDate</td><td>2023-02-15T19:01:31.116Z</td><td>data Prevista Prestacao Contas</td></tr><tr><td>accountabilityDate</td><td>2023-02-15T19:01:31.116Z</td><td>data Prestacao Contas</td></tr><tr><td>acquittanceDate</td><td>2023-02-15T19:01:31.116Z</td><td>data Quitacao</td></tr><tr><td>scheduledate</td><td>2023-02-15T19:01:31.116Z</td><td>data Agendamento</td></tr><tr><td>plannedPaymentDate</td><td>2023-02-15T19:01:31.116Z</td><td>data Prevista Pagamento</td></tr><tr><td>paymentDate</td><td>2023-02-15T19:01:31.116Z</td><td>data Pagamento</td></tr><tr><td>cpfCnpjRecipient</td><td>string</td><td>codigo Viagem</td></tr><tr><td>numberVPO</td><td>string</td><td>cpf Cnpj Destinatario</td></tr><tr><td>tag</td><td>string</td><td>numeroVPO</td></tr><tr><td>tagId</td><td>0</td><td>tag</td></tr><tr><td>valueTax</td><td>0</td><td>tagId</td></tr><tr><td>totalAdditions</td><td>0</td><td>valorImpostos</td></tr><tr><td>totalDiscounts</td><td>0</td><td>totalAcrescimos</td></tr><tr><td>valueBalanceAPagar</td><td>0</td><td>totalDescontos</td></tr><tr><td>freightDriverAccount</td><td>true</td><td>valorSaldoAPagar</td></tr><tr><td>PixKeyType</td><td>string</td><td>freteContaMotorista</td></tr><tr><td>TypePixTransporterKey</td><td>string</td><td>tipoChavePix</td></tr><tr><td>keyPix</td><td>string</td><td>tipoChavePixTransportador</td></tr><tr><td>keyPixTransporter</td><td>string</td><td>chavePix</td></tr><tr><td>emitarValePedagio</td><td>true</td><td>chavePixTransportador</td></tr><tr><td>valePedagioCartao</td><td>true</td><td>emitirValePedagio</td></tr><tr><td>TypeCreditVPO</td><td>string</td><td>valePedagioCartao</td></tr><tr><td>carrierAdvanceValue</td><td>0</td><td>tipoCreditoVPO</td></tr><tr><td>carrierpercent</td><td>0</td><td>valorAdiantamentoTransportadora</td></tr><tr><td>percentdriver</td><td>0</td><td>percentualTransportador</td></tr><tr><td>fixedContractrate</td><td>0</td><td>percentualMotorista</td></tr><tr><td>percentContractrate</td><td>0</td><td>tarifaContratoFixa</td></tr><tr><td>contractCiot</td><td></td><td>tarifaContratoPercentual</td></tr><tr><td>CIOT</td><td>string</td><td>contratoCiot</td></tr><tr><td>message</td><td>string</td><td>id</td></tr><tr><td>code</td><td>string</td><td>numeroCiot</td></tr><tr><td>protocol</td><td>string</td><td>mensagem</td></tr><tr><td>dataProtocol</td><td>2023-02-15T19:01:31.116Z</td><td>codigo</td></tr><tr><td>cancellationmessage</td><td>string</td><td>protocolo</td></tr><tr><td>cancellationCode</td><td>string</td><td>dataProtocolo</td></tr><tr><td>cancellationprotocol</td><td>string</td><td>mensagemCancelamento</td></tr><tr><td>cancellationdate</td><td>2023-02-15T19:01:31.116Z</td><td>codigoCancelamento</td></tr><tr><td>closingMessage</td><td>string</td><td>protocoloCancelamento</td></tr><tr><td>enclosureCode</td><td>string</td><td>dataCancelamento</td></tr><tr><td>closingProtocol</td><td>string</td><td>mensagemEncerramento</td></tr><tr><td>closingDate</td><td>2023-02-15T19:01:31.116Z</td><td>codigoEncerramento</td></tr><tr><td>status</td><td>string</td><td>protocoloEncerramento</td></tr><tr><td>statusID</td><td>0</td><td>dataEncerramento</td></tr><tr><td>roadMap</td><td></td><td>status</td></tr><tr><td>id</td><td>0</td><td>statusID</td></tr><tr><td>origin</td><td>string</td><td>roteiro</td></tr><tr><td>destination</td><td>string</td><td>id</td></tr><tr><td>contractDocuments</td><td></td><td>origem</td></tr><tr><td>id</td><td>0</td><td>destino</td></tr><tr><td>contractID</td><td>0</td><td>contratoDocumentos</td></tr><tr><td>TypeDocumentID</td><td>0</td><td>id</td></tr><tr><td>documentType</td><td>string</td><td>contratoID</td></tr><tr><td>number</td><td>string</td><td>tipoDocumentoID</td></tr><tr><td>series</td><td>string</td><td>tipoDocumento</td></tr><tr><td>dateInclusion</td><td>2023-02-15T19:01:31.116Z</td><td>numero</td></tr><tr><td>dateUpdate</td><td>2023-02-15T19:01:31.116Z</td><td>serie</td></tr><tr><td>axisSuspendedStopIda</td><td></td><td>dataInclusao</td></tr><tr><td>order</td><td>0</td><td>dataAtualizacao</td></tr><tr><td>axesSuspended</td><td>0</td><td>eixoSuspensoParadasIda</td></tr><tr><td>hangingAxisTurnStop</td><td></td><td>ordem</td></tr><tr><td>order</td><td>0</td><td>eixosSuspenso</td></tr><tr><td>axesSuspended</td><td>0</td><td>eixoSuspensoParadasVolta</td></tr><tr><td>acquittanceRules</td><td></td><td>ordem</td></tr><tr><td>typeTolerance</td><td>perc</td><td>eixosSuspenso</td></tr><tr><td>tolerance</td><td>0</td><td>Valor da Tolerancia</td></tr><tr><td>upperLimit</td><td>0</td><td>id</td></tr><tr><td>breakageTolerance</td><td>0</td><td>tolerancia</td></tr><tr><td>weightType</td><td>string</td><td>percentualTolerancia</td></tr><tr><td>breakageCharge</td><td>true</td><td>limiteSuperior</td></tr><tr><td>damageCharge</td><td>true</td><td>quebraTolerancia</td></tr><tr><td>taxes</td><td></td><td>tipoPeso</td></tr><tr><td>value</td><td>0</td><td>tipoCobrancaQuebra</td></tr><tr><td>description</td><td>string</td><td>tipoCobrancaAvaria</td></tr><tr><td>base</td><td>string</td><td>impostos</td></tr><tr><td>percentage</td><td>string</td><td>valor</td></tr><tr><td>manualLaunches</td><td></td><td>descricao</td></tr><tr><td>description</td><td>string</td><td>base</td></tr><tr><td>transactionType</td><td>string</td><td>percentual</td></tr><tr><td>value</td><td>0</td><td>lancamentosManuais</td></tr><tr><td>date</td><td>2023-02-15T19:01:31.116Z</td><td>descricao</td></tr></tbody></table>\n\nfim\n\nRetorno\n\n<table><tbody><tr><th>Campos</th><th>Tipo</th><th>Descrição</th></tr><tr><td>travelCode</td><td>string</td><td></td></tr><tr><td>id</td><td>0</td><td></td></tr><tr><td>shipperID</td><td>0</td><td></td></tr><tr><td>shipperBranchID</td><td>0</td><td></td></tr><tr><td>carrierID</td><td>0</td><td></td></tr><tr><td>driverID</td><td>0</td><td></td></tr><tr><td>cardID</td><td>0</td><td></td></tr><tr><td>transporterIDcard</td><td>0</td><td></td></tr><tr><td>vehicleID</td><td>0</td><td></td></tr><tr><td>carretaID</td><td>0</td><td></td></tr><tr><td>scriptID</td><td>0</td><td></td></tr><tr><td>typeOperationID</td><td>0</td><td></td></tr><tr><td>typeCommodityID</td><td>0</td><td></td></tr><tr><td>value</td><td>0</td><td></td></tr><tr><td>advance value</td><td>0</td><td></td></tr><tr><td>loadValue</td><td>0</td><td></td></tr><tr><td>loadweight</td><td>0</td><td></td></tr><tr><td>tollvalue</td><td>0</td><td></td></tr><tr><td>roundtrip</td><td>true</td><td></td></tr><tr><td>axisSuspendedIda</td><td>0</td><td></td></tr><tr><td>axisHoldBack</td><td>0</td><td></td></tr><tr><td>tipoMidiaValePedagio</td><td>0</td><td></td></tr><tr><td>statusContractID</td><td>0</td><td></td></tr><tr><td>dataEmission</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>datePrevisaoEntrega</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>dateUpdate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>dateForecastOutput</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>plannedAccountabilityDate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>accountabilityDate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>acquittanceDate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>scheduledate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>plannedPaymentDate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>paymentDate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>cpfCnpjRecipient</td><td>string</td><td></td></tr><tr><td>numberVPO</td><td>string</td><td></td></tr><tr><td>tag</td><td>string</td><td></td></tr><tr><td>tagId</td><td>0</td><td></td></tr><tr><td>valueTax</td><td>0</td><td></td></tr><tr><td>totalAdditions</td><td>0</td><td></td></tr><tr><td>totalDiscounts</td><td>0</td><td></td></tr><tr><td>ValueBalanceAPagar</td><td>0</td><td></td></tr><tr><td>freightDriverAccount</td><td>true</td><td></td></tr><tr><td>PixKeyType</td><td>string</td><td></td></tr><tr><td>TypePixTransporterKey</td><td>string</td><td></td></tr><tr><td>keyPix</td><td>string</td><td></td></tr><tr><td>keyPixTransporter</td><td>string</td><td></td></tr><tr><td>emitarValePedagio</td><td>true</td><td></td></tr><tr><td>valePedagioCartao</td><td>true</td><td></td></tr><tr><td>TypeCreditVPO</td><td>string</td><td></td></tr><tr><td>carrierAdvanceValue</td><td>0</td><td></td></tr><tr><td>carrierpercent</td><td>0</td><td></td></tr><tr><td>percentdriver</td><td>0</td><td></td></tr><tr><td>fixedContractrate</td><td>0</td><td></td></tr><tr><td>percentContractrate</td><td>0</td><td></td></tr><tr><td>contractCiot</td><td></td><td></td></tr><tr><td>CIOT</td><td>string</td><td></td></tr><tr><td>message</td><td>string</td><td></td></tr><tr><td>code</td><td>string</td><td></td></tr><tr><td>protocol</td><td>string</td><td></td></tr><tr><td>dataProtocol</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>cancellationmessage</td><td>string</td><td></td></tr><tr><td>cancellationCode</td><td>string</td><td></td></tr><tr><td>cancellationprotocol</td><td>string</td><td></td></tr><tr><td>cancellationdate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>closingMessage</td><td>string</td><td></td></tr><tr><td>enclosureCode</td><td>string</td><td></td></tr><tr><td>closingProtocol</td><td>string</td><td></td></tr><tr><td>closingDate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>status</td><td>string</td><td></td></tr><tr><td>statusID</td><td>0</td><td></td></tr><tr><td>roadMap</td><td></td><td></td></tr><tr><td>id</td><td>0</td><td></td></tr><tr><td>origin</td><td>string</td><td></td></tr><tr><td>destination</td><td>string</td><td></td></tr><tr><td>contractDocuments</td><td></td><td></td></tr><tr><td>id</td><td>0</td><td></td></tr><tr><td>contractID</td><td>0</td><td></td></tr><tr><td>TypeDocumentID</td><td>0</td><td></td></tr><tr><td>documentType</td><td>string</td><td></td></tr><tr><td>number</td><td>string</td><td></td></tr><tr><td>series</td><td>string</td><td></td></tr><tr><td>dateInclusion</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>dateUpdate</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr><tr><td>axisSuspendedStopIda</td><td></td><td></td></tr><tr><td>order</td><td>0</td><td></td></tr><tr><td>axesSuspended</td><td>0</td><td></td></tr><tr><td>hangingAxisTurnStop</td><td></td><td></td></tr><tr><td>order</td><td>0</td><td></td></tr><tr><td>axesSuspended</td><td>0</td><td></td></tr><tr><td>acquittanceRules</td><td></td><td></td></tr><tr><td>typeTolerance</td><td>perc</td><td></td></tr><tr><td>tolerance</td><td>0</td><td></td></tr><tr><td>upperLimit</td><td>0</td><td></td></tr><tr><td>breakageTolerance</td><td>0</td><td></td></tr><tr><td>weightType</td><td>string</td><td></td></tr><tr><td>breakageCharge</td><td>true</td><td></td></tr><tr><td>damageCharge</td><td>true</td><td></td></tr><tr><td>taxes</td><td></td><td></td></tr><tr><td>value</td><td>0</td><td></td></tr><tr><td>description</td><td>string</td><td></td></tr><tr><td>base</td><td>string</td><td></td></tr><tr><td>percentage</td><td>string</td><td></td></tr><tr><td>manualLaunches</td><td></td><td></td></tr><tr><td>description</td><td>string</td><td></td></tr><tr><td>transactionType</td><td>string</td><td></td></tr><tr><td>value</td><td>0</td><td></td></tr><tr><td>date</td><td>2023-02-15T19:01:31.116Z</td><td></td></tr></tbody></table>\n\nfim","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":[{"travelCode":"teste123","contractID":101,"arrivalTotalWeight":10000,"damagesTotalAmount":341,"isDocumentsDelivered":true,"comments":"Sem observações"}]}}}},"parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"Content-Length":{"schema":{"type":"integer","example":"34"}},"ETag":{"schema":{"type":"string","example":"W/\"22-irc+YXtZHlx83bfYV3FHBnXanjk\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Date":{"schema":{"type":"string","example":"Wed, 26 Jul 2023 13:14:05 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}}},"content":{"application/json":{"schema":{"type":"object"},"example":[{"travelCode":"string","id":0,"shipperID":0,"shipperBranchID":0,"carrierID":0,"driverID":0,"cardID":0,"transporterIDcard":0,"vehicleID":0,"carretaID":0,"scriptID":0,"typeOperationID":0,"typeCommodityID":0,"value":0,"advance value":0,"loadValue":0,"loadweight":0,"tollvalue":0,"roundtrip":true,"axisSuspendedIda":0,"axisHoldBack":0,"tipoMidiaValePedagio":0,"statusContractID":0,"dataEmission":"2023-02-15T19:01:31.116Z","datePrevisaoEntrega":"2023-02-15T19:01:31.116Z","dateUpdate":"2023-02-15T19:01:31.116Z","dateForecastOutput":"2023-02-15T19:01:31.116Z","plannedAccountabilityDate":"2023-02-15T19:01:31.116Z","accountabilityDate":"2023-02-15T19:01:31.116Z","acquittanceDate":"2023-02-15T19:01:31.116Z","scheduledate":"2023-02-15T19:01:31.116Z","plannedPaymentDate":"2023-02-15T19:01:31.116Z","paymentDate":"2023-02-15T19:01:31.116Z","cpfCnpjRecipient":"string","numberVPO":"string","tag":"string","tagId":0,"valueTax":0,"totalAdditions":0,"totalDiscounts":0,"ValueBalanceAPagar":0,"freightDriverAccount":true,"PixKeyType":"string","TypePixTransporterKey":"string","keyPix":"string","keyPixTransporter":"string","emitarValePedagio":true,"valePedagioCartao":true,"TypeCreditVPO":"string","carrierAdvanceValue":0,"carrierpercent":0,"percentdriver":0,"fixedContractrate":0,"percentContractrate":0,"contractCiot":{"CIOT":"string","message":"string","code":"string","protocol":"string","dataProtocol":"2023-02-15T19:01:31.116Z","cancellationmessage":"string","cancellationCode":"string","cancellationprotocol":"string","cancellationdate":"2023-02-15T19:01:31.116Z","closingMessage":"string","enclosureCode":"string","closingProtocol":"string","closingDate":"2023-02-15T19:01:31.116Z","status":"string","statusID":0},"roadMap":{"id":0,"origin":"string","destination":"string"},"contractDocuments":[{"id":0,"contractID":0,"TypeDocumentID":0,"documentType":"string","number":"string","series":"string","dateInclusion":"2023-02-15T19:01:31.116Z","dateUpdate":"2023-02-15T19:01:31.116Z"}],"axisSuspendedStopIda":[{"order":0,"axesSuspended":0}],"hangingAxisTurnStop":[{"order":0,"axesSuspended":0}],"acquittanceRules":{"typeTolerance":"perc","tolerance":0,"upperLimit":0,"breakageTolerance":0,"weightType":"string","breakageCharge":true,"damageCharge":true},"taxes":[{"value":0,"description":"string","base":"string","percentage":"string"}],"manualLaunches":[{"description":"string","transactionType":"string","value":0,"date":"2023-02-15T19:01:31.116Z"}]}]}}}}}},"/contracts/payment/pending":{"get":{"tags":["General"],"summary":"Buscar Contrato Pendente Pagameto","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n\n###### contracted\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CNPJ | string | \\- | CNPJ | Não |\n| IE | string | \\- | Inscrição Estadual | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| email | string | \\- | Email | Não |\n| name | string | \\- | Nome | Não |\n\n###### sender\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\n###### address\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairro | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | INGE | Não |\n\n###### recipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\n###### address\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairro | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\n###### Diver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| driverLicense | string | \\- | Carteira de motorista | Não |\n| category | string | \\- | Categoria | Não |\n| number | string | \\- | Número do documento | Não |\n| validity | string | \\- | Validade | Não |\n\n##### vehicles\n\n###### truck\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ do contratante | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixos | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veículo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | Placa IBGE | Não |\n| name | string | \\- | Nome | Não |\n\n###### semiTrailer\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ cdo contratante | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixo | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veículo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | Placa IBGE | Não |\n| name | string | \\- | Nome | Não |\n\n###### cargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor do frete unitário | Não |\n| goodsKgValue | string | \\- | Valor da mercadoria por Kg | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade do peso total | Não |\n\n###### journeyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\n###### costDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\n###### taxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do inposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\n##### payment\n\n###### dischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\n###### mandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala do percurso | Não |\n| breakdown | string | \\- | Desciminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\n###### advancePayment\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| date | string | \\- | Data | Não |\n| parcelType | string | \\- | Tipo de parcela | Não |\n| units | string | \\- | Unidades | Não |\n\n##### apportionment\n\n###### driver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- |  | Não |\n| settlePercent | string | \\- |  | Não |\n\n###### hiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- |  | Não |\n| settlePercent | string | \\- |  | Não |\n\n##### travelDocuments\n\n###### documents\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\n###### invoices\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |","parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}}}}},"/contracts/scheduled":{"get":{"tags":["General"],"summary":"Buscar Contratos Agendados Por dia","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| _id | string | \\- | Id | Não |\n\nsender\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\nrecipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\nvehicles\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| semitraler | string | \\- | semitraler | Não |\n\ncargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor do frete unitário | Não |\n| goodsKgValue | string | \\- | Valor da mercadoria por Kg | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade total de peso | Não |\n\njourneyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\ncostDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\ntaxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\npayment\n\ndischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\nmandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala de viagem | Não |\n| breakdown | string | \\- | Discriminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\napportionment\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- |  | Não |\n| settlePercent | string | \\- |  | Não |\n\nhiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem adiantada | Não |\n| settlePercent | string | \\- |  | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePayment | Array | \\- | Pagamento adiantado | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| released | string | \\- |  | Não |\n| status | string | \\- | Status | Não |\n| ampcId | string | \\- |  | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n| travelDocuments | Array | \\- | Documento de viagem | Não |\n| logs | Array | \\- |  | Não |\n| createdAt | string | \\- | Data de criação | Não |\n| updatedAt | string | \\- | Data de atualização | Não |\n\ninvoices\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |","parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}}}}},"/contracts/failed":{"get":{"tags":["General"],"summary":"Buscar Contratos Reprovados","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| _id | string | \\- | id | Não |\n\nsender\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\nrecipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\nvehicles\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| semitraler | string | \\- | semitrailer | Não |\n\ncargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor unitário do frete | Não |\n| goodsKgValue | string | \\- | Valor por Kg da mercadoria | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade total de peso | Não |\n\njourneyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Terminou | Não |\n\ncostDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\ntaxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\npayment\n\ndischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\nmandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala de rota | Não |\n| breakdown | string | \\- | Discriminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\napportionment\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem adiantada | Não |\n| settlePercent | string | \\- | Porcentagem a liquidadar | Não |\n\nhiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem adiantada | Não |\n| settlePercent | string | \\- | Porcentagem a liquidar | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePayment | Array | \\- | Pagamento adiantado | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| released | string | \\- |  | Não |\n| status | string | \\- | Status | Não |\n| ampcId | string | \\- |  | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n| travelDocuments | Array | \\- | Documentos de viagem | Não |\n| logs | Array | \\- |  | Não |\n| createdAt | string | \\- | Data de criação | Não |\n| updatedAt | string | \\- | Data de atualização | Não |","parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}}}}},"/contracts/advance":{"post":{"tags":["General"],"summary":"Lança um Adiantamento do Contrato","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n\ncontracted\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CNPJ | string | \\- | CNPJ | Não |\n| IE | string | \\- | Inscrição estatudal | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| email | string | \\- | Email | Não |\n| name | string | \\- | Nome | Não |\n\naddress\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| number | string | \\- | Número | Não |\n| complement | string | \\- | Complemento | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\nphones\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| number | string | \\- |  | Não |\n| areaCode | string | \\- |  | Não |\n| type | string | \\- |  | Não |\n\naddress\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairro | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\nrecipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\naddress\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairro | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\nDiver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\nvehicles\n\ntruck\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ do contratente | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixos | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veículo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | Placa IBGE | Não |\n| name | string | \\- | Nome | Não |\n\nsemiTrailer\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ do contratante | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixos | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veículo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | Placa IBGE | Não |\n| name | string | \\- | Nome | Não |\n\ncargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor de frete unitário | Não |\n| goodsKgValue | string | \\- | Valor da mercadoria por Kg | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código do NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade total de peso | Não |\n\njourneyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\ncostDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\ntaxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\npayment\n\ndischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\nmandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala de rote | Não |\n| breakdown | string | \\- | Discriminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\nadvancePayment\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| date | string | \\- | Data | Não |\n| parcelType | string | \\- | Tipo de parcela | Não |\n| units | string | \\- | Unidades | Não |\n\napportionment\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | number | \\- | Porcentagem adiantada | Não |\n| settlePercent | number | \\- | Porcentagem a liquidar | Não |\n\nhiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | number | \\- | Porcentagem adiantada | Não |\n| settlePercent | number | \\- | Porcentagem a liquidar | Não |\n\ntravelDocuments\n\ndocuments\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\ninvoices\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| valueDocumentTravel | number | \\- |  | Não |","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"contractId":{"type":"integer","example":"123"},"travelCode":{"type":"string","example":"abc"}}}}}},"parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"201":{"description":"Created","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"4fe-eKaG3hZbSwSxvCRCH8Ci5jwsH18\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 04:58:11 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","_id":"64460c621e62792a099c60b2","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"}}}}}}},"/contracts/awaitingApproval":{"get":{"tags":["General"],"summary":"Buscar Contratos Aguardando Aprovação","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| _id | string | \\- | id | Não |\n\nsender\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\nrecipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\nvehicles\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| semitraler | string | \\- | semitrailer | Não |\n\ncargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor unitário do frete | Não |\n| goodsKgValue | string | \\- | Valor por Kg da mercadoria | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de rota | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade total do peso | Não |\n\njourneyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\ncostDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor do total do frete | Não |\n\ntaxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\npayment\n\ndischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\nmandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala de viagem | Não |\n| breakdown | string | \\- | Discriminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\napportionment\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem adiantada | Não |\n| settlePercent | string | \\- | Porcentagem a liquidar | Não |\n\nhiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem adiantada | Não |\n| settlePercent | string | \\- | Porcentagem a liquidar | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePayment | Array | \\- | Porcentagem adiantada | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| released | string | \\- |  | Não |\n| status | string | \\- | Status | Não |\n| ampcId | string | \\- |  | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n| travelDocuments | Array | \\- | Documentos de viagem | Não |\n| logs | Array | \\- |  | Não |\n| createdAt | string | \\- | Data de criação | Não |\n| updatedAt | string | \\- | Data de atualização | Não |","parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}}}}},"/contracts/approveds":{"get":{"tags":["General"],"summary":"Buscar Contratos Aprovados","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| _id | string | \\- | id | Não |\n\nsender\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\nrecipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\nvehicles\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| semitraler | string | \\- | semitrailer | Não |\n\ncargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor unitário do frete | Não |\n| goodsKgValue | string | \\- | Valor da mercadoria por Kg | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade total de peso | Não |\n\njourneyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\ncostDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\ntaxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valoe do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\npayment\n\ndischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\nmandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala de estrada | Não |\n| breakdown | string | \\- | Discriminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\napportionment\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem adiantada | Não |\n| settlePercent | string | \\- | Porcentagem a liquidar | Não |\n\nhiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Pocentagem adiantada | Não |\n| settlePercent | string | \\- | Porcentagem a liquidar | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePayment | Array | \\- | Pagamento adiantado | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| released | string | \\- |  | Não |\n| status | string | \\- | Status | Não |\n| ampcId | string | \\- | ampcld | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n| travelDocuments | Array | \\- | Documentos de viagem | Não |\n| logs | Array | \\- |  | Não |\n| createdAt | string | \\- | Data de criação | Não |\n| updatedAt | string | \\- | Data de atualização | Não |","parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}}}}},"/contracts/paid/dayBefore":{"get":{"tags":["General"],"summary":"Buscar Contratos Pagamento Dia Anterior","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| _id | string | \\- | id | Não |\n\nsender\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\nrecipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\nvehicles\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| semitraler | string | \\- | semitrailer | Não |\n\ncargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor unitário do frete | Não |\n| goodsKgValue | string | \\- | Valor da mercadoria por Kg | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade total de peso | Não |\n\njourneyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\ncostDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\ntaxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\npayment\n\ndischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\nmandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala de estrada | Não |\n| breakdown | string | \\- | Discriminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\napportionment\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem de adiantamentro | Não |\n| settlePercent | string | \\- | Porcentagem a liquidar | Não |\n\nhiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem de adiantamento | Não |\n| settlePercent | string | \\- | Porcentagem a liquidar | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePayment | Array | \\- | Pagamento adiantado | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| released | string | \\- |  | Não |\n| status | string | \\- | Status | Não |\n| ampcId | string | \\- | ampcld | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n| travelDocuments | Array | \\- | Documentos de viagem | Não |\n| logs | Array | \\- |  | Não |\n| createdAt | string | \\- | Data de criação | Não |\n| updatedAt | string | \\- | Data de atualização | Não |","parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}}}}},"/contracts/financial/adjustment/":{"post":{"tags":["General"],"summary":"Lança Acréscimos e Descontos","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| branchContractorCNPJ | string | \\- | CNPJ da filial contratante | Não |\n\ncontracted\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CNPJ | string | \\- | CNPJ | Não |\n| IE | string | \\- | Inscrição estadual | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| email | string | \\- | Email | Não |\n| name | string | \\- | Nome | Não |\n\naddress\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| number | string | \\- | Número | Não |\n| complement | string | \\- | Complemento | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\nphones\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| number | string | \\- | Número | Não |\n| areaCode | string | \\- | Código de área | Não |\n| type | string | \\- | Tipo | Não |\n\naddress\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairro | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\nrecipient\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| name | string | \\- | Nome | Não |\n| CNPJ | string | \\- | CNPJ | Não |\n\naddress\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| street | string | \\- | Endereço | Não |\n| complement | string | \\- | Complemento | Não |\n| neighborhood | string | \\- | Bairro | Não |\n| zip | string | \\- |  | Não |\n| IBGE | string | \\- | IBGE | Não |\n\nDiver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| CPF | string | \\- | CPF | Não |\n\nvehicles\n\ntruck\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ do contratante | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixos | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veículo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | Placa IBGE | Não |\n| name | string | \\- | Nome | Não |\n\nsemiTrailer\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractorCNPJ | string | \\- | CNPJ do contratante | Não |\n| plate | string | \\- | Placa | Não |\n| RNTRC | string | \\- | RNTRC | Não |\n| axes | string | \\- | Eixos | Não |\n| branch | string | \\- | Filial | Não |\n| model | string | \\- | Modelo | Não |\n| color | string | \\- | Cor | Não |\n| manufactureYear | string | \\- | Ano de fabricação | Não |\n| modelYear | string | \\- | Ano do modelo | Não |\n| typeVehicle | string | \\- | Tipo de veículo | Não |\n| IBGE | string | \\- | IBGE | Não |\n| renavam | string | \\- | Renavam | Não |\n| chassis | string | \\- |  | Não |\n| plateIBGE | string | \\- | Placa IBGE | Não |\n| name | string | \\- | Nome | Não |\n\ncargoDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| unitFreightValue | string | \\- | Valor unitário do frete | Não |\n| goodsKgValue | string | \\- | Valor da mercadoria por Kg | Não |\n| cargoType | string | \\- | Tipo de carga | Não |\n| tripType | string | \\- | Tipo de viagem | Não |\n| NCMCode | string | \\- | Código NCM | Não |\n| weightTotalQuantity | string | \\- | Quantidade de peso total | Não |\n\njourneyTime\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| start | string | \\- | Começou | Não |\n| finish | string | \\- | Finalizou | Não |\n\ncostDetails\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| tollAmount | number | \\- | Valor do pedágio | Não |\n| branchCothersValueontractorCNPJ | string | \\- |  | Não |\n| totalFreightValue | string | \\- | Valor total do frete | Não |\n\ntaxesFees\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| cargoTypeAnttCode | string | \\- | Código do tipo de carga ANTT | Não |\n| INSSValue | string | \\- | Valor do INSS | Não |\n| IRValue | string | \\- | Valor do imposto de renda | Não |\n| sestSenatValue | string | \\- |  | Não |\n| insuranceValue | string | \\- |  | Não |\n| othersValues | string | \\- | Outros valores | Não |\n\npayment\n\ndischargeRules\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| typeTolerance | string | \\- |  | Não |\n| shippingTypeWeight | string | \\- |  | Não |\n| breakTypeCharge | string | \\- |  | Não |\n| breakingtolerance | string | \\- |  | Não |\n| faultTypeCharge | string | \\- |  | Não |\n\nmandatoryDischarge\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| deliveryDate | string | \\- | Data de entrega | Não |\n| weight | string | \\- | Peso | Não |\n| roadScale | string | \\- | Escala de estrada | Não |\n| breakdown | string | \\- | Discriminação | Não |\n| invoiceStub | string | \\- |  | Não |\n| voucherToll | string | \\- | Vale pedágio | Não |\n| DACTe | string | \\- | DACTe | Não |\n\nadvancePayment\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| date | string | \\- | Data | Não |\n| parcelType | string | \\- | Tipo de parcela | Não |\n| units | string | \\- | Unidades | Não |\n\napportionment\n\ndriver\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem de adiantamento | Não |\n| settlePercent | string | \\- | Porcentagem a ser liquidada | Não |\n\nhiredCo\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| advancePercent | string | \\- | Porcentagem de adiantamento | Não |\n| settlePercent | string | \\- | Porcentagem a ser liquidada | Não |\n\ntravelDocuments\n\ndocuments\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\ninvoices\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |\n| number | string | \\- | Número | Não |\n| type | string | \\- | Tipo | Não |\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| series | string | \\- | Série | Não |","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":{"contractId":123,"travelCode":"abc","receiver":"Motorista","reason":"Estadia","note":"string","AdjustmentValue":0,"grossAdjustmentValue":0,"INSS":0,"PIS":0,"COFINS":0,"CSLL":0,"IR":0,"sestSenat":0,"insurance":0,"others":0}}}}},"parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"201":{"description":"Created","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"4fe-eKaG3hZbSwSxvCRCH8Ci5jwsH18\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 04:58:11 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","_id":"64460c621e62792a099c60b2","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"}}}}}}},"/contracts/cancel":{"put":{"tags":["General"],"summary":"Cancelar Contrato","description":"Para autorizar o pagamento é preciso enviar o travelCode, que é o identificador da viagem/frete no TMS, ou enviar o contractID, que é o ID do contrato no Ambipar Cargo que é retornado na emissão do contrato.\n\n| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| travelCode | string | \\- | Identificador da viagem/frete no TMS | Não |\n| contractID | number |  | ID do contrato no Ambipar Cargo | Não |\n| cancelationReason | string |  | Motivo do canelamento | Não |\n\nfim","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":[{"travelCode":"teste123","contractID":101,"cancelationReason":"Solicitado pelo contratante"}]}}}},"parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"docs":[{"_id":"64460c621e62792a099c60b2","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-24T04:58:10.977Z","updatedAt":"2023-04-24T04:58:10.977Z"},{"_id":"64456d5c1d9cc04fce7dd8e7","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","status":"unprocessed","ampcId":0,"branchContractorCNPJ":"unknown","travelDocuments":[],"logs":[],"createdAt":"2023-04-23T17:39:40.841Z","updatedAt":"2023-04-23T17:39:40.841Z"},{"_id":"643c18b9037df9f736e98f50","sender":{"name":"unknown","CNPJ":"unknown"},"recipient":{"name":"unknown","CNPJ":"unknown"},"driver":{"CPF":"unknown"},"vehicles":{"semiTrailer":[]},"cargoDetails":{"cargoTypeAnttCode":0,"unitFreightValue":0,"goodsKgValue":0,"cargoType":"unknown","tripType":"unknown","NCMCode":"unknown","weightTotalQuantity":0},"journeyTime":{"start":"unknown","finish":"unknown"},"costDetails":{"tollAmount":0,"othersValue":0,"totalFreightValue":0},"taxesFees":{"cargoTypeAnttCode":"unknown","INSSValue":0,"IRValue":0,"sestSenatValue":0,"insuranceValue":0,"othersValues":0},"payment":{"dischargeRules":{"typeTolerance":"unknown","shippingTypeWeight":"unknown","breakTypeCharge":"unknown","breakingtolerance":"unknown","faultTypeCharge":"unknown"},"mandatoryDischarge":{"deliveryDate":"unknown","weight":"unknown","roadScale":"unknown","breakdown":"unknown","invoiceStub":"unknown","voucherToll":"unknown","DACTe":"unknown"},"apportionment":{"driver":{"advancePercent":0,"settlePercent":0},"hiredCo":{"advancePercent":0,"settlePercent":0}},"advancePayment":[]},"released":"unknown","branchContractorCNPJ":"19856439000149","travelDocuments":[],"logs":[],"createdAt":"2023-04-16T15:48:09.603Z","updatedAt":"2023-04-23T17:12:05.186Z","status":"unprocessed","hiredCo":{"document":"12345678909"}}],"totalDocs":3,"limit":5,"totalPages":1,"page":1,"pagingCounter":1,"hasPrevPage":false,"hasNextPage":false,"prevPage":null,"nextPage":null}}}},"422":{"description":"Unprocessable Entity","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"Content-Length":{"schema":{"type":"integer","example":"33"}},"ETag":{"schema":{"type":"string","example":"W/\"21-XhN90igNLZQH7mdQQoVnRyAngAA\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 06:05:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}}},"content":{"application/json":{"schema":{"type":"object"},"example":{"errors":{"msg":"ID_MALFORMED"}}}}}}}},"/contracts/status":{"put":{"tags":["General"],"summary":"Alterar status contrato","description":"| Campos | Tipo | Tamanho | Descrição | Obrigatório |\n| --- | --- | --- | --- | --- |\n| contractId | number | \\- | Id do contrato | Sim se travelCode vazio |\n| travelCode | string | \\- | Código do contrato do TMS | Sim se contractId vazio |\n| reason | string | \\- | Motivo da alteração do status | Não |\n| contractStatus | string  <br>('interrupt', 'cancel', 'reprove', 'approve') | \\- | Novo status do contrato | Sim |","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":{"contractId":2,"travelCode":"dasasdd","reason":"Motivo do cancelamento, reprovação ou aprovação","contractStatus":"cancel"}}}}},"parameters":[{"name":"Authorization","in":"header","schema":{"type":"string"},"example":"Bearer {{authToken}}"}],"responses":{"200":{"description":"OK","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string","example":"*"}},"Content-Security-Policy":{"schema":{"type":"string","example":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"}},"X-DNS-Prefetch-Control":{"schema":{"type":"string","example":"off"}},"Expect-CT":{"schema":{"type":"string","example":"max-age=0"}},"X-Frame-Options":{"schema":{"type":"string","example":"SAMEORIGIN"}},"Strict-Transport-Security":{"schema":{"type":"string","example":"max-age=15552000; includeSubDomains"}},"X-Download-Options":{"schema":{"type":"string","example":"noopen"}},"X-Content-Type-Options":{"schema":{"type":"string","example":"nosniff"}},"X-Permitted-Cross-Domain-Policies":{"schema":{"type":"string","example":"none"}},"Referrer-Policy":{"schema":{"type":"string","example":"no-referrer"}},"X-XSS-Protection":{"schema":{"type":"integer","example":"0"}},"Content-Type":{"schema":{"type":"string","example":"application/json; charset=utf-8"}},"ETag":{"schema":{"type":"string","example":"W/\"fb2-mrOaoPiXexhm9oOZwmkXbD5oU7A\""}},"Vary":{"schema":{"type":"string","example":"Accept-Encoding"}},"Content-Encoding":{"schema":{"type":"string","example":"gzip"}},"Date":{"schema":{"type":"string","example":"Mon, 24 Apr 2023 05:01:45 GMT"}},"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=5"}},"Transfer-Encoding":{"schema":{"type":"string","example":"chunked"}}},"content":{"application/json":{"schema":{"type":"object"},"examples":{"example-0":{"summary":"Cancelar contrato","value":{}},"example-1":{"summary":"Interromper contrato","value":{}},"example-2":{"summary":"Reprovar contrato","value":{}},"example-3":{"summary":"Aprovar contrato","value":{}}}}}}}}}}}