documento_idinteger | nullOpcionalID interno del documento.
Parámetros, estructura de datos y respuestas del contrato versionado.
/servicos/prestacao-contasLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Registra la fecha de rendición final de cuentas de un documento para liberar el hito financiero correspondiente. Responde 201 en la primera confirmación, 200 en repetición idempotente con la misma fecha y 409 si se envía una fecha divergente.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]No hay parámetros declarados para esta operación.
Obligatorio
Datos de identificación del documento y fecha de rendición de cuentas.
application/jsondocumento_idinteger | nullOpcionalID interno del documento.
chave_acessostring | nullOpcionalClave de acceso de 44 dígitos.
data_prestacao_contasstring · dateObligatorioFecha de la rendición final de cuentas (YYYY-MM-DD).
observacaostring | nullOpcionalObservación operativa opcional.
201 Respuesta HTTPRendición de cuentas confirmada.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
409 Respuesta HTTPConflicto con fecha de rendición de cuentas ya registrada.
422 Respuesta HTTPRechazo por regla de negocio o validación.
{
"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": []
}