← InícioFleetPay / API

Confirmar prestação de contas de um serviço

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

POST/servicos/prestacao-contas
confirmarPrestacaoContasServicoBase 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.

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.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Repasses e Comprovantes
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · 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

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

Dados de identificação do documento e data da prestação de contas.

application/json

documento_idinteger | nullOpcional

ID interno do documento.

chave_acessostring | nullOpcional

Chave de acesso de 44 dígitos.

data_prestacao_contasstring · dateObrigatório

Data da prestação final de contas (YYYY-MM-DD).

observacaostring | nullOpcional

Observação operacional opcional.

Respostas

201 Resposta HTTP

Prestação de contas confirmada.

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.

409 Resposta HTTP

Conflito com data de prestação de contas já registrada.

422 Resposta HTTP

Recusa de regra ou validação.

Definição Completa da Operação
{
  "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": []
}