documento_idinteger | nullOptionalInternal document ID.
Parameters, data structure and responses from the versioned contract.
/servicos/prestacao-contasTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Records the final accounting settlement date of a document to release the corresponding financial milestone. Returns 201 on first confirmation, 200 on idempotent replay with the same date and 409 if a diverging date is sent.
operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]No parameters declared for this operation.
Required
Document identification data and accounting settlement date.
application/jsondocumento_idinteger | nullOptionalInternal document ID.
chave_acessostring | nullOptional44-digit access key.
data_prestacao_contasstring · dateRequiredFinal accounting settlement date (YYYY-MM-DD).
observacaostring | nullOptionalOptional operational note.
201 HTTP ResponseAccounting settlement confirmed.
application/jsondata—Optionalmetaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP ResponseMissing, invalid or cross-environment credential.
403 HTTP ResponseDashboard scope not enabled or resource outside company scope.
409 HTTP ResponseConflict with an already recorded accounting settlement date.
422 HTTP ResponseBusiness rule or validation rejection.
{
"tags": [
"Parcelas"
],
"operationId": "confirmarPrestacaoContasServico",
"summary": "Confirmar prestação de contas de um serviço",
"description": "Registra a data de prestação final de contas de um documento para liberar o marco financeiro correspondente. Responde `201` na primeira confirmação, `200` no replay idempotente com a mesma data e `409` se enviada data divergente.",
"requestBody": {
"required": true,
"description": "Dados de identificação do documento e data da prestação de contas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data_prestacao_contas"
],
"properties": {
"documento_id": {
"type": [
"integer",
"null"
],
"description": "ID interno do documento."
},
"chave_acesso": {
"type": [
"string",
"null"
],
"description": "Chave de acesso de 44 dígitos."
},
"data_prestacao_contas": {
"type": "string",
"format": "date",
"description": "Data da prestação final de contas (YYYY-MM-DD)."
},
"observacao": {
"type": [
"string",
"null"
],
"description": "Observação operacional opcional."
}
}
}
}
}
},
"responses": {
"201": {
"description": "Prestação de contas confirmada.",
"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."
},
"409": {
"description": "Conflito com data de prestação de contas já registrada."
},
"422": {
"description": "Recusa de regra ou validação."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "repasses-comprovantes",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"transportador_frotista"
],
"method": "POST",
"path": "/servicos/prestacao-contas",
"parameters": []
}