Consultar as parcelas de repasse de um documento

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

GET/carriers/parcelas-repasse/{documento}

consultarParcelasRepasseBase 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.

O livro completo do repasse deste documento: quanto o motorista recebe, em quantas parcelas, em que estado cada uma está e qual já virou pagamento.

É por aqui que você descobre o que fazer em seguida — o campo status diz se a parcela espera evento, espera a sua ordem de pagamento, ou já está a caminho.

Documento de outra transportadora responde 404, não 403: um 403 confirmaria que aquele documento existe na FleetPay.

Autenticação

[
  {
    "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

documentopath · stringObrigatório

O ID interno FleetPay, o número do documento (internal_id) ou a chave do CT-e de 44 dígitos. A chave aceita a máscara com pontos.

Para contra-CT-e vale também o counter_cte_id (o UUID devolvido pelo lote de subcontratação), o documento_financeiro da perna (ROUTE:<lote>:<hex>) e, depois de autorizado, a chave do próprio contra-CT-e. No 1:1 o documento é o CT-e da contratante importado como seu — a chave dele resolve.

Restrições

{
  "type": "string"
}

Respostas

200 Resposta HTTP

As parcelas do documento

`application/json`

RespostaParcelasRepasse ↗

dataobjectOpcional

ParcelaRepasse ↗

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Credencial sem o escopo operacao habilitado. O livro expõe quanto cada motorista recebe e quando — habilite o escopo no painel antes de consultar.

`application/json`

Erro ↗

errorobjectOpcional

404 Resposta HTTP

Documento não encontrado, ou de outra transportadora.

`application/json`

Erro ↗

errorobjectOpcional

422 Resposta HTTP

O documento existe e é seu, mas não está sob uma regra de repasse parcelada — não há livro para mostrar (regra_nao_parcelada). Nos endpoints de liberação e ordem o mesmo estado responde sem_regra_parcelada.

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "tags": [
    "Parcelas"
  ],
  "summary": "Consultar as parcelas de repasse de um documento",
  "operationId": "consultarParcelasRepasse",
  "description": "O livro completo do repasse deste documento: quanto o motorista recebe, em quantas\nparcelas, em que estado cada uma está e qual já virou pagamento.\n\nÉ por aqui que você descobre **o que fazer em seguida** — o campo `status` diz se a parcela\nespera evento, espera a sua ordem de pagamento, ou já está a caminho.\n\nDocumento de outra transportadora responde `404`, não `403`: um `403` confirmaria que\naquele documento existe na FleetPay.\n",
  "parameters": [
    {
      "name": "documento",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "O ID interno FleetPay, o número do documento (`internal_id`) ou a chave do CT-e de 44\ndígitos. A chave aceita a máscara com pontos.\n\nPara **contra-CT-e** vale também o `counter_cte_id` (o UUID devolvido pelo lote de\nsubcontratação), o `documento_financeiro` da perna (`ROUTE:<lote>:<hex>`) e, depois\nde autorizado, a chave do próprio contra-CT-e. No 1:1 o documento é o CT-e da\ncontratante importado como seu — a chave dele resolve.\n"
    }
  ],
  "responses": {
    "200": {
      "description": "As parcelas do documento",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaParcelasRepasse"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "description": "Credencial sem o escopo `operacao` habilitado. O livro expõe quanto cada motorista recebe e quando — habilite o escopo no painel antes de consultar.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "404": {
      "description": "Documento não encontrado, ou de outra transportadora.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "O documento existe e é seu, mas não está sob uma regra de repasse parcelada — não há\nlivro para mostrar (`regra_nao_parcelada`). Nos endpoints de liberação e ordem o mesmo\nestado responde `sem_regra_parcelada`.\n",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "GET",
  "path": "/carriers/parcelas-repasse/{documento}"
}