Parámetros, estructura de datos y respuestas del contrato versionado.
GET/carriers/parcelas-repasse/{documento}
consultarParcelasRepasseBase de Pruebas: https://api.fleetpay.site/v1
Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Registro completo de las transferencias de este documento: cuánto recibe el conductor, en cuántas cuotas, el estado de cada una y cuáles ya generaron un pago.
Aquí puede determinar qué hacer a continuación: status indica si la cuota espera un evento, su orden de pago o si ya está en proceso de pago.
Un documento de otra transportista devuelve 404, no 403: un 403 confirmaría que ese documento existe en FleetPay.
Autenticación
[
{
"oauth2": []
},
{
"chaveApi": []
}
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.
Parámetros
documentopath · stringObligatorio
ID interno de FleetPay, número del documento (internal_id) o clave de CT-e de 44 dígitos. La clave admite el formato con puntos.
Para contra-CT-e, también acepta counter_cte_id (el UUID devuelto por el lote de subcontratación), el documento_financeiro del tramo (ROUTE:<lote>:<hex>) y, tras la autorización, la clave del propio contra-CT-e. En el modo 1:1, el documento es el CT-e de la contratante importado como propio: su clave permite localizarlo.
Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.
La credencial no tiene habilitado el ámbito operacao. El registro muestra cuánto recibe cada conductor y cuándo; habilita el ámbito en el panel antes de consultar.
El documento existe y le pertenece, pero no está sujeto a una regla de transferencias en cuotas: no hay un registro de cuotas que mostrar (regra_nao_parcelada). En los endpoints de liberación y orden de pago, el mismo estado devuelve sem_regra_parcelada.
Límite de solicitudes excedido (limite_requisicoes). Espera el intervalo indicado en el encabezado Retry-After antes de reintentar. Puede provenir del proveedor o del límite antiabuso de FleetPay, calculado por empresa autenticada y grupo de rutas, con una ventana corta para ráfagas y otra larga para tráfico automatizado lento. Los límites son amplios deliberadamente: las integraciones reales, incluidos lotes grandes procesados de una vez, deberían quedar muy por debajo. Si tu integración alcanza un límite, contacta con FleetPay.
{
"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}"
}
