Cadastrar passivo de um cliente

POST

/assets/liabilities/create

Cadastra um passivo (dívida) no patrimônio do cliente informado em clientId, no corpo. São obrigatórios clientId, type, description e value (número maior ou igual a zero). year (ano de referência) e situationAt (histórico de valores, com data e valor) são opcionais. Devolve o ID do passivo criado. Cliente inexistente devolve 404; corpo fora do formato devolve 422. 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 Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Passivo cadastrado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠404Cliente não encontrado

🟠422Dados do passivo inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/assets/liabilities/create' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "type": "BANCARIO",
    "description": "Financiamento de máquinas",
    "value": 450000,
    "year": "2026"
}'

Response Example

200 - Sucesso

{
    "item": {
        "_id": "f1a2b3c4-0000-4000-8000-000000000501"
    }
}

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