← InícioFleetPay / API

Consultar parcelas de repasse de um lote de contra-CT-e

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/carriers/parcelas-repasse/lote/{batchId}
consultarParcelasLoteContraCteBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Lista todas as parcelas de repasse e respectivos status financeiros derivadas de um lote de contra-CT-e.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Subcontratação
Perfis Aplicáveis
Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

batchIdpath · stringObrigatório

UUID ou identificador do lote de contra-CT-e.

Restrições
{
  "type": "string"
}

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

404 Resposta HTTP

Lote não encontrado.

Definição Completa da Operação
{
  "tags": [
    "CT-e de subcontratação",
    "Parcelas"
  ],
  "operationId": "consultarParcelasLoteContraCte",
  "summary": "Consultar parcelas de repasse de um lote de contra-CT-e",
  "description": "Lista todas as parcelas de repasse e respectivos status financeiros derivadas de um lote de contra-CT-e.",
  "parameters": [
    {
      "name": "batchId",
      "in": "path",
      "required": true,
      "description": "UUID ou identificador do lote de contra-CT-e.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Operação processada com sucesso.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "404": {
      "description": "Lote não encontrado."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "subcontratacao",
  "x-fleetpay-profiles": [
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/carriers/parcelas-repasse/lote/{batchId}"
}