Atualizar extração de balanço e DRE

PATCH

/v2/queries/clients/{clientId}/report-extraction/{id}

Atualiza os dados de uma extração de balanço e DRE. Todos os campos são opcionais e só o que vier no corpo é alterado; campos fora da lista são recusados. Cada alteração entra no histórico do registro, com o usuário, a data e os valores antes e depois. Trocar o ano para um já usado é recusado, a menos que overwrite seja true. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200

application/json

Inferred 200 (from source code)

Bodyapplication/json

🟠400Ano base inválido

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v2/queries/clients//report-extraction/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "fileName": "string",
    "fileType": "balanco",
    "status": "string",
    "year": "string",
    "overwrite": true
}'

Response Example

200 - Sucesso

{
    "_id": "string",
    "queryId": "string",
    "status": "FILA",
    "fileName": "string",
    "fileType": "string",
    "year": "2024"
}

Modificado em 2026-10-13 09:47:06

Página anterior

Remover extração de balanço e DRE

Próxima página

Visualizar extração de balanço e DRE (detalhado)