Contabilidade
Consulta da contabilidade: plano de contas, lançamentos, partidas e relatórios. Tudo aqui é só leitura e exige o recurso Contabilidade no plano.
Contas contábeis
Recurso do plano: Contabilidade.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/accounting-accounts | Lista com paginação |
GET | /external/v1/accounting-accounts/:id | Busca um registro pelo ID |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
curl -G "https://erp-api.ideros.api.br/external/v1/accounting-accounts" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/accounting-accounts/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Campos do registro
Além de id, isActive, createdAt e updatedAt, o registro traz:
| Campo | Tipo | Descrição |
|---|---|---|
code | string | Código estruturado para Caixa. |
name | string | Nome da conta contábil. |
description | string | Descrição da conta. |
type | enum | Define a natureza da conta. Valores: ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE. |
allowsEntries | boolean | Indica se esta conta permite lançamentos diretos (false para contas sintéticas/agrupadoras). |
parentId | string | ID de conta contábil. |
Lançamentos contábeis
Recurso do plano: Contabilidade.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/accounting-journal-entries | Lista com paginação |
GET | /external/v1/accounting-journal-entries/:id | Busca um registro pelo ID |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"date":{"gte":"2026-10-01","lte":"2026-10-31"}}}):
curl -G "https://erp-api.ideros.api.br/external/v1/accounting-journal-entries" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"date":{"gte":"2026-10-01","lte":"2026-10-31"}}}'
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/accounting-journal-entries/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Campos do registro
Além de id, isActive, createdAt e updatedAt, o registro traz:
| Campo | Tipo | Descrição |
|---|---|---|
date | string (data ISO 8601) | Data de competência do fato contábil. |
description | string | Descrição geral do lançamento contábil. |
registeredById | string | ID de usuário da empresa. |
source | enum | Origem do lançamento contábil. AUTO_SETTLEMENT/AUTO_REVERSAL = gerado pelo sistema (vínculos selados, sem edição manual). MANUAL/MANUAL_ADJUSTMENT = lançado pelo contador (aceita vínculos N:M com FinancialEntry). Valores: AUTO_SETTLEMENT, AUTO_REVERSAL, MANUAL, MANUAL_ADJUSTMENT. |
Partidas dos lançamentos
Recurso do plano: Contabilidade.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/accounting-journal-entry-lines | Lista com paginação |
GET | /external/v1/accounting-journal-entry-lines/:id | Busca um registro pelo ID |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"journalEntryId":"ID_DO_LANCAMENTO"}}):
curl -G "https://erp-api.ideros.api.br/external/v1/accounting-journal-entry-lines" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"journalEntryId":"ID_DO_LANCAMENTO"}}'
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/accounting-journal-entry-lines/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Campos do registro
Além de id, isActive, createdAt e updatedAt, o registro traz:
| Campo | Tipo | Descrição |
|---|---|---|
journalEntryId | string | ID de lançamento contábil. |
accountingAccountId | string | ID de conta contábil. |
type | enum | Tipo de lançamento contábil. Valores: DEBIT, CREDIT. |
amount | number | O valor da partida. |
Relatórios contábeis
Recurso do plano: Contabilidade.
Todos os relatórios são GET e recebem os parâmetros na query string. Datas no formato AAAA-MM-DD.
| Rota | Relatório | Parâmetros |
|---|---|---|
/external/v1/accounting-reports/trial-balance | Balancete de verificação | startDate, endDate, accountId (opcional, filtra uma conta) |
/external/v1/accounting-reports/balance-sheet | Balanço patrimonial | referenceDate |
/external/v1/accounting-reports/general-ledger | Razão de uma conta | accountingAccountId, startDate, endDate |
/external/v1/accounting-reports/account-statement | Extrato de uma conta | accountingAccountId, startDate, endDate |
/external/v1/accounting-reports/dashboard-summary | Resumo do painel contábil | startDate, endDate |
curl -G "https://erp-api.ideros.api.br/external/v1/accounting-reports/trial-balance" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "startDate=2026-10-01" \
--data-urlencode "endDate=2026-10-31"
Formato das respostas
Balancete (trial-balance):
{
"rows": [
{
"accountId": "…",
"accountCode": "1.01.01",
"accountName": "Caixa",
"accountType": "ASSET",
"previousBalance": 1000,
"totalDebits": 500,
"totalCredits": 200,
"finalBalance": 1300
}
],
"totals": { "previousBalance": 1000, "totalDebits": 500, "totalCredits": 200, "finalBalance": 1300 }
}
Balanço (balance-sheet): referenceDate, as árvores assets, liabilities e equity (cada nó com accountId, accountCode, accountName, parentId, balance e children) e totals com totalAssets, totalLiabilities, totalEquity e totalLiabilitiesAndEquity.
Razão (general-ledger) e extrato (account-statement): account (id, code, name, type), previousBalance, movements e finalBalance. Cada movimento traz date, journalEntryId, description, debit, credit e runningBalance; no extrato, também financialEntryId quando o lançamento contábil veio do financeiro.
Resumo do painel (dashboard-summary): cards (totalAccounts, journalEntriesCount, totalDebits, totalCredits, autoEntries, manualEntries), monthlyMovementChart, balanceSheetSummary (currentAssets, nonCurrentAssets, liabilities, equity), recentEntries e topMovedAccounts.
A nossa equipe ajuda você a configurar e usar esse recurso.