Consulta parcelas em aberto

Permite ao cliente obter um relatório detalhado de todas as parcelas de CIOT emitidos em determinado período e que ainda estão pendente de pagamento.

Método e rota

• Consulta (GET): /consulta/ParcelasEmAberto?cnpjEmpresa={enterpriseId}&AnoMesEmissao={aaaa-MM}

Parâmetro	Tipo	Obrigatório?	Descrição
cnpjEmpresa	string	Sim	CNPJ da empresa contratante das OTs.
AnoMesEmissao	string (AAAA-MM)	Sim	Mês de referência das OTs emitidas.

Estrutura da requisição

Cabeçalhos

• Authorization: o token JWT deve ser enviado no header.

  Authorization: Bearer {token}

Resposta do GET

Confira o exemplo abaixo e veja aqui a definição completa.

{
  "empresa": {
    "cnpj": "12345678000199",
    "nome": "EMBARCADOR EXEMPLO LTDA"
  },
  "periodo": {
    "AnoMesEmissao": "2025-11"
  },
  "resultados": [
    {
      "ciot": "123456789012",
      "dataEmissao": "2025-11-05T14:33:00",
      "pontoEmissor": "Filial São Paulo",
      "Viagem": {
        "numero": "000123",
        "serie": "1"
      },
      "parcela": {
        "nome": "Parcela 01/02",
        "dataPagamento": "2025-11-10T00:00:00",
        "valor": 1500.25
      },
      "contratado": {
        "nome": "TRANSPORTADOR ABC LOGÍSTICA LTDA",
        "cnpj": "98765432000188"
      },
      "veiculo": {
        "placas": "ABC1D23",
        "condutor": {
          "nome": "JOÃO DA SILVA",
          "cpf": "12345678901"
        }
      },
      "documentosOriginarios": "CTe - 12345 | DTG - 98765"
    }
  ]
}

Layout

Nome do campo	Tipo	Observação
empresa	object	Dados da empresa contratante das OTs.
└─ cnpj	string	CNPJ da empresa contratante.
└─ nome	string	Nome da empresa contratante.
periodo	object	Período utilizado na consulta.
└─ AnoMesEmissao	string (AAAA-MM)	Mês de referência das OTs emitidas.
resultados	array	Lista de resultados retornados. Cada item representa uma parcela em aberto vinculada a uma OT.
└─ ciot	string	Número CIOT da operação de transporte.
└─ dataEmissao	date-time	Data e hora de emissão da OT.
└─ pontoEmissor	string	Local (filial) que gerou a OT.
└─ Viagem	object	Identificação da OT no ERP.
└─ numero	string	Número da OT no ERP.
└─ serie	string	Série da OT no ERP.
└─ parcela	object	Informações da parcela vinculada à OT.
└─ nome	string	Nome da parcela (ex.: "01/02", "Saldo").
└─ dataPagamento	date-time	Data prevista de pagamento da parcela.
└─ valor	decimal	Valor da parcela.
└─ contratado	object	Dados do transportador contratado.
└─ nome	string	Nome do transportador contratado.
└─ cnpj	string	CNPJ do transportador contratado.
└─ veiculo	object	Informações do veículo da viagem.
└─ placas	string	Placa principal da viagem.
└─ condutor	object	Dados do motorista.
└─ nome	string	Nome do motorista.
└─ cpf	string	CPF do motorista.
└─ documentosOriginarios	string	Lista concatenada dos documentos.

Códigos de Status HTTP

• 200: Requisição processada com sucesso.
• 400: Parâmetro ausente, inválido ou intervalo de datas incorreto.
• 401: Não autorizado (token JWT ausente ou inválido).
• 403: Requisição autenticada, porém sem permissão para acessar o recurso.
• 404: Nenhuma parcela encontrada (opcional, depende da implementação).
• 500: Erro interno do servidor durante o processamento da requisição.