API mantida por Fintera

Ajustes Gerenciais (ManagerialAdjustment)

O recurso ManagerialAdjustment representa um ajuste gerencial cadastrado em uma entidade (Entity) no Financeiro. Os ajustes gerenciais permitem registrar receitas e despesas que não possuem movimentação financeira real, sendo utilizados para fins de controle gerencial.

Atributos

- id                        | Identificador único do ajuste gerencial
- competency_month          | Mês de competência (date)
- adjustment_type           | Tipo do ajuste: "revenue" (receita) ou "expense" (despesa)
- amount                    | Valor do ajuste (decimal, maior que 0)
- description               | Descrição do ajuste (obrigatório)
- category_id               | ID da categoria associada
- person_id                 | ID do cliente/fornecedor associado
- classification_center_id  | ID do centro de custo/receita associado
- observation               | Observação adicional
- created_at                | Data de criação
- updated_at                | Data de atualização

Listar Ajustes Gerenciais

GET /entities/:entity_id/managerial_adjustments

Retorna uma lista (paginada) de todos os Ajustes Gerenciais da entidade especificada. Para designar o número de registros por página, passar o parâmetro per_page no endpoint. Caso o parâmetro não seja passado, o default de 30 será utilizado. O limite superior é de 100 registros por página. Para navegar entre as diferentes páginas, basta usar o parâmetro page. Exemplo:

GET /entities/:entity_id/managerial_adjustments?per_page=15&page=3

O endpoint acima irá retornar a terceira página da listagem de Ajustes Gerenciais com 15 registros em cada.

Exemplo de Resposta

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
  {
    "id": 1,
    "competency_month": "2026-06-01",
    "adjustment_type": "revenue",
    "amount": "1500.0",
    "description": "Ajuste de receita mensal",
    "entity_id": 10,
    "category_id": 5,
    "person_id": 3,
    "classification_center_id": 2,
    "observation": "Referente ao mês de junho",
    "created_at": "2026-06-15T10:30:00-03:00",
    "updated_at": "2026-06-15T10:30:00-03:00"
  },
  {
    "id": 2,
    "competency_month": "2026-05-01",
    "adjustment_type": "expense",
    "amount": "800.0",
    "description": "Ajuste de despesa operacional",
    "entity_id": 10,
    "category_id": 8,
    "person_id": null,
    "classification_center_id": null,
    "observation": null,
    "created_at": "2026-05-10T14:00:00-03:00",
    "updated_at": "2026-05-10T14:00:00-03:00"
  }
]

Exemplo de Busca Avançada

GET /entities/:entity_id/managerial_adjustments?q[description_cont]=receita&q[adjustment_type_eq]=revenue

Filtros disponíveis para Busca Avançada

- q[competency_month_gteq]              | Competência maior ou igual a (date)
- q[competency_month_lteq]              | Competência menor ou igual a (date)
- q[amount_gteq]                        | Valor maior ou igual a (decimal)
- q[amount_lteq]                        | Valor menor ou igual a (decimal)
- q[adjustment_type_eq]                 | Tipo do ajuste: "revenue" ou "expense"
- q[description_cont]                   | Descrição contendo o critério informado
- q[category_full_name_equals]          | Nome completo exato da categoria
- q[person_name_equals]                 | Nome exato do cliente/fornecedor
- q[classification_center_name_equals]  | Nome exato do centro de custo/receita

Exibir um Ajuste Gerencial

GET /entities/:entity_id/managerial_adjustments/:id

Retorna os atributos do ajuste gerencial especificado (via id) com uma resposta 200 Ok.

Exemplo de Resposta

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "id": 1,
  "competency_month": "2026-06-01",
  "adjustment_type": "revenue",
  "amount": "1500.0",
  "description": "Ajuste de receita mensal",
  "entity_id": 10,
  "category_id": 5,
  "person_id": 3,
  "classification_center_id": 2,
  "observation": "Referente ao mês de junho",
  "created_at": "2026-06-15T10:30:00-03:00",
  "updated_at": "2026-06-15T10:30:00-03:00"
}

Criar um Ajuste Gerencial

POST /entities/:entity_id/managerial_adjustments

Cria um novo ajuste gerencial com os parâmetros passados. Em caso de sucesso, retorna 201 Created juntamente com os dados do ajuste criado. Em caso de falha, retorna 422 Unprocessable entity juntamente com a descrição dos erros.

Parâmetros

- competency_month          | obrigatório | Mês de competência (date)
- adjustment_type           | obrigatório | "revenue" ou "expense"
- amount                    | obrigatório | Valor do ajuste (decimal, maior que 0)
- description               | obrigatório | Descrição do ajuste
- category_id               | opcional    | ID da categoria
- person_id                 | opcional    | ID do cliente/fornecedor
- classification_center_id  | opcional    | ID do centro de custo/receita
- observation               | opcional    | Observação adicional

Exemplo de Requisição

{
  "managerial_adjustment": {
    "competency_month": "2026-06-01",
    "adjustment_type": "revenue",
    "amount": 1500.00,
    "description": "Ajuste de receita mensal",
    "category_id": 5,
    "person_id": 3,
    "classification_center_id": 2,
    "observation": "Referente ao mês de junho"
  }
}

Exemplo de Resposta

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
  "id": 1,
  "competency_month": "2026-06-01",
  "adjustment_type": "revenue",
  "amount": "1500.0",
  "description": "Ajuste de receita mensal",
  "entity_id": 10,
  "category_id": 5,
  "person_id": 3,
  "classification_center_id": 2,
  "observation": "Referente ao mês de junho",
  "created_at": "2026-06-15T10:30:00-03:00",
  "updated_at": "2026-06-15T10:30:00-03:00"
}

Alterar um Ajuste Gerencial

PUT /entities/:entity_id/managerial_adjustments/:id

Altera o ajuste gerencial especificado. Retorna 200 Ok com os dados atualizados em caso de sucesso ou uma resposta 422 Unprocessable entity com a descrição dos erros em caso de falha.

Exemplo de Requisição

{
  "managerial_adjustment": {
    "amount": 2000.00,
    "observation": "Valor corrigido"
  }
}

Apagar um Ajuste Gerencial

DELETE /entities/:entity_id/managerial_adjustments/:id

Apaga o ajuste gerencial especificado, retornando uma resposta vazia com status 204 No Content.