Pular para o conteúdo principal

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étodoRotaO que faz
GET/external/v1/accounting-accountsLista com paginação
GET/external/v1/accounting-accounts/:idBusca 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:

CampoTipoDescrição
codestringCódigo estruturado para Caixa.
namestringNome da conta contábil.
descriptionstringDescrição da conta.
typeenumDefine a natureza da conta. Valores: ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE.
allowsEntriesbooleanIndica se esta conta permite lançamentos diretos (false para contas sintéticas/agrupadoras).
parentIdstringID de conta contábil.

Lançamentos contábeis​

Recurso do plano: Contabilidade.

MétodoRotaO que faz
GET/external/v1/accounting-journal-entriesLista com paginação
GET/external/v1/accounting-journal-entries/:idBusca 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:

CampoTipoDescrição
datestring (data ISO 8601)Data de competência do fato contábil.
descriptionstringDescrição geral do lançamento contábil.
registeredByIdstringID de usuário da empresa.
sourceenumOrigem 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étodoRotaO que faz
GET/external/v1/accounting-journal-entry-linesLista com paginação
GET/external/v1/accounting-journal-entry-lines/:idBusca 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:

CampoTipoDescrição
journalEntryIdstringID de lançamento contábil.
accountingAccountIdstringID de conta contábil.
typeenumTipo de lançamento contábil. Valores: DEBIT, CREDIT.
amountnumberO 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.

RotaRelatórioParâmetros
/external/v1/accounting-reports/trial-balanceBalancete de verificaçãostartDate, endDate, accountId (opcional, filtra uma conta)
/external/v1/accounting-reports/balance-sheetBalanço patrimonialreferenceDate
/external/v1/accounting-reports/general-ledgerRazão de uma contaaccountingAccountId, startDate, endDate
/external/v1/accounting-reports/account-statementExtrato de uma contaaccountingAccountId, startDate, endDate
/external/v1/accounting-reports/dashboard-summaryResumo do painel contábilstartDate, 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.

Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.