Pular para o conteúdo principal

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étodoRotaO que faz
GET/external/v1/cost-centersLista com paginação
GET/external/v1/cost-centers/: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/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:

CampoTipoDescrição
codestringCódigo único do centro de custo dentro da empresa.
titlestringNome ou título do centro de custo.
descriptionstringDescrição detalhada do centro de custo.
tagsstring[]Lista de tags associadas ao centro de custo. Opcional.
isDefaultbooleanDefine se é o centro de custo padrão para a empresa.

Unidades de negócio​

Recurso do plano: Unidades de Negócio.

MétodoRotaO que faz
GET/external/v1/business-unitsLista com paginação
GET/external/v1/business-units/: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/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:

CampoTipoDescrição
unitCodestringCódigo único de identificação da unidade de negócio.
displayNamestringNome de exibição da unidade de negócio/filial.
documentNumberstringCNPJ 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.
namestringNome fiscal da unidade de negócio/filial.
addressMetadataobjectEndereço: objeto com zipCode, street, streetNumber, complement, neighborhood, city, state, country e ibgeCode (código IBGE do município, resolvido pelo CEP quando falta).
phonesstring[]Telefones da unidade de negócio/filial para contato.
tagstring[]Tags para categorizar e organizar a unidade de negócio/filial.
isMainbooleanDefine se esta é a unidade de negócio principal/matriz da empresa.
stateRegistrationstringInscrição estadual da filial (apenas contribuintes de ICMS).
municipalRegistrationstringInscrição municipal da filial.
cnaestringCNAE principal da filial. Quando vazio, sistema usa o CNAE da empresa.

Campos customizados​

Recurso do plano: Campos Customizados.

MétodoRotaO que faz
GET/external/v1/custom-fieldsLista com paginação
GET/external/v1/custom-fields/: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/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:

CampoTipoDescrição
fieldNamestringNome do campo personalizado.
fieldTypeenumTipo do campo personalizado, definido pelo enum. Valores: TEXT, NUMBER, CURRENCY, PERCENTAGE, DATE, SINGLE_SELECT, BOOLEAN, TEXTAREA, MULTI_SELECT, FILE.
targetEntitystringEntidade alvo do campo customizado
isRequiredbooleanDefine se o preenchimento do campo é obrigatório.
availableInFilterbooleanDefine se o campo fica disponível como filtro nas listagens.
placeholderstringPlaceholder do campo. Se vazio, a tela usa um padrão por tipo no idioma da empresa.
optionsstring[]Lista de opções, usada quando o tipo do campo requer valores selecionáveis.
fieldKeysstring[]Chaves de mapeamento para preenchimento automático via provedores externos. Formato: 'provedor.campo'. Ex: 'receita_federal.socialName'.
metadataobjectObjeto JSON livre.
Ainda com dúvida?

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