Configurações e consulta
Cadastros de apoio, só para consulta. Use os IDs retornados aqui para preencher campos como businessUnitId e os centros de custo dos lançamentos.
Centros de custo
Recurso do plano: Centros de Custo.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/cost-centers | Lista com paginação |
GET | /external/v1/cost-centers/: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/cost-centers" \
-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/cost-centers/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 único do centro de custo dentro da empresa. |
title | string | Nome ou título do centro de custo. |
description | string | Descrição detalhada do centro de custo. |
tags | string[] | Lista de tags associadas ao centro de custo. Opcional. |
isDefault | boolean | Define se é o centro de custo padrão para a empresa. |
Unidades de negócio
Recurso do plano: Unidades de Negócio.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/business-units | Lista com paginação |
GET | /external/v1/business-units/: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/business-units" \
-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/business-units/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 |
|---|---|---|
unitCode | string | Código único de identificação da unidade de negócio. |
displayName | string | Nome de exibição da unidade de negócio/filial. |
documentNumber | string | CNPJ ou CPF da unidade de negócio/filial. Para CNPJ, aceita o formato numérico legado e o alfanumérico (NT 2026.004) a partir de 01/07/2026. |
name | string | Nome fiscal da unidade de negócio/filial. |
addressMetadata | object | Endereço: objeto com zipCode, street, streetNumber, complement, neighborhood, city, state, country e ibgeCode (código IBGE do município, resolvido pelo CEP quando falta). |
phones | string[] | Telefones da unidade de negócio/filial para contato. |
tag | string[] | Tags para categorizar e organizar a unidade de negócio/filial. |
isMain | boolean | Define se esta é a unidade de negócio principal/matriz da empresa. |
stateRegistration | string | Inscrição estadual da filial (apenas contribuintes de ICMS). |
municipalRegistration | string | Inscrição municipal da filial. |
cnae | string | CNAE principal da filial. Quando vazio, sistema usa o CNAE da empresa. |
Campos customizados
Recurso do plano: Campos Customizados.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/custom-fields | Lista com paginação |
GET | /external/v1/custom-fields/: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/custom-fields" \
-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/custom-fields/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 |
|---|---|---|
fieldName | string | Nome do campo personalizado. |
fieldType | enum | Tipo do campo personalizado, definido pelo enum. Valores: TEXT, NUMBER, CURRENCY, PERCENTAGE, DATE, SINGLE_SELECT, BOOLEAN, TEXTAREA, MULTI_SELECT, FILE. |
targetEntity | string | Entidade alvo do campo customizado |
isRequired | boolean | Define se o preenchimento do campo é obrigatório. |
availableInFilter | boolean | Define se o campo fica disponível como filtro nas listagens. |
placeholder | string | Placeholder do campo. Se vazio, a tela usa um padrão por tipo no idioma da empresa. |
options | string[] | Lista de opções, usada quando o tipo do campo requer valores selecionáveis. |
fieldKeys | string[] | Chaves de mapeamento para preenchimento automático via provedores externos. Formato: 'provedor.campo'. Ex: 'receita_federal.socialName'. |
metadata | object | Objeto JSON livre. |
A nossa equipe ajuda você a configurar e usar esse recurso.