Consultar movimentação analítica

Permite ao cliente obter um relatório detalhado de todas as transações de vale-pedágio e frete emitidas, filtradas por intervalo de datas, empresa e parceiro.

Método e rota

• Consulta (GET): /consulta/movimentacaoVPOAnalitica/{enterpriseId}

Estrutura da requisição

Cabeçalhos

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

  Authorization: Bearer {token}

Corpo

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

{
  "dataInicial": "2023-08-01T00:00:00",
  "dataFinal":   "2023-08-30T00:00:00",
  "cnpjEmpresa": "41966902000128"
  "idParceiro": "67890"
}

Layout

Campo	Tipo	Obrigatório	Observação
dataInicial	string	Sim	Data/hora inicial (ISO 8601).
dataFinal	string	Sim	Data/hora final (ISO 8601).
idParceiro	string	Não	Código interno do parceiro.

Resposta do GET

Após o processamento da consulta, a API retornará um JSON com os seguintes dados:

Exemplo de resposta bem-sucedida:

{
    {
      "Tipo":                    "VPO",
      "Empresa":                 "Contratante",
      "CNPJ":                    "12345678000199",
      "Favorecido":              "Transportador",
      "CIOT":                    "880005224760/3822",
      "Numero":                  "987654321",
      "Serie":                   "A1",
      "Parcela":                 "",
      "Valor":                    150.75,
      "PontoEmissor":            "Matriz",
      "Condutor":                "Nome motorista",
      "CPF":                     "08088845604",
      "TipoDocumentoOriginario": "",
      "DocumentoOriginario":     "",
      "DataEmissao":             "2023-08-15T00:00:00"
      "DataPagamento":           "2023-08-15T00:00:00",
      "OperadoraTag":            "Operadora Y",
      "Parceiro":                "Parceiro Z",
      "StatusPagamento":         1,
      "CategoriaPedagio":        3,
      "Placa":                   "ABC-1234",
      "IDVPO":                   "46554474",
      "NDVP":                    "5247893641"
    }, 
    {
      "Tipo":                    "Frete",
      "Empresa":                 "Contratante",
      "CNPJ":                    "12345678000199", 
      "Favorecido":              "Transportador", 
      "CIOT":                    "880005224760/3822", 
      "Numero":                  "987654321",
      "Serie":                   "A1", 
      "Parcela":                 "ADT_87",
      "Valor":                    1000.00,
      "PontoEmissor":            "Matriz", 
      "Condutor":                "Nome motorista",
      "CPF":                     "08088845604", 
      "TipoDocumentoOriginario": "nfe",
      "DocumentoOriginario":     "4286", 
      "DataEmissao":             "2023-08-15T00:00:00"
      "DataPagamento":           "2023-08-15T00:00:00",
      "OperadoraTag":            "",
      "Parceiro":                "",
      "StatusPagamento":         1,
      "CategoriaPedagio":        "",
      "Placa":                   "ABC-1234", 
      "IDVPO":                   "",
      "NDVP":                    "" 
    }
}

Layout

Campo	Tipo	Observação
Empresa	string	Nome da contratante.
CNPJ	string	CNPJ da contratante.
PontoEmissor	string	Ponto emissor que gerou o vale-pedágio.
Numero	string	Número da operação de vale-pedágio.
Serie	string	Série da operação.
idNDD	string	Código interno gerado pelo NDD.
DataEmissao	string	Data/hora de emissão (ISO 8601).
Valor	decimal	Valor pago ao condutor.
OperadoraTag	string	Nome da operadora da TAG.
Parceiro	string	Nome do parceiro de emissão.
StatusPagamento	number	1 = Pago, 2 = Pendente, 3 = Cancelado.
CategoriaPedagio	number	Categoria de pedágio (conforme tabela de anexos).
Placa	string	Placa do veículo.

Códigos de Status HTTP

• 200 ou 201: Lista (possivelmente vazia) de transações atendendo aos filtros.
• 400: Parâmetro ausente ou intervalo inválido.
• 401: Não autorizado (token JWT ausente ou inválido).
• 500: Erro interno do servidor ou exceções não tratadas.