Entidades disponíveis
A API oferece acesso somente leitura (GET / Consulta) às entidades listadas abaixo. O nome da entidade (coluna à esquerda) é o valor usado no path /api/v1/{entity}.
Referência
Esta lista reproduz exatamente as entidades nomeadas na especificação da API. Use o nome técnico (ex.: Account) na URL.
Cadastro e gestão
| Entidade |
Descrição |
Account |
Cliente |
Certificado |
Certificado |
RegimeTributario |
Regime Tributário |
InscricaoEstadual |
Inscrição Estadual |
TipoObrigacao |
Tipo de Obrigação |
PrazoEntregaObrigacao |
Prazo da Entrega |
Tag |
Tag |
Obrigações Acessórias
| Entidade |
Descrição |
ObrigacoesAcessoriasReg |
Obrigação |
DetalhesEcd |
ECD |
ObrigacoesDctfweb |
DCTFWeb Em andamento |
ObrigacoesAcessorias |
Serviços Contratados |
Caixas postais
| Entidade |
Descrição |
CaixaPostalDet |
Caixa Postal DET |
CaixaPostalEcac |
Caixa Postal e-CAC |
Certidões
| Entidade |
Descrição |
CndEstadual |
CND – Estadual |
CndFederal |
CND – Federal |
CndTrabalhista |
CND – Trabalhista |
CrfFgts |
CRF – FGTS |
Procurações
| Entidade |
Descrição |
ProcuracaoEcac |
Procuração e-CAC |
ProcuracaoSpe |
Procuração SPE |
Parcelamentos
| Entidade |
Descrição |
ParcelamentoFederalSimplificado |
Parcelamento Federal Simplificado |
ParcelamentoFederalSimplificadoParcelas |
Parcelamento Federal Simplificado Parcelas |
ParcelamentoNaoPrevidenciario |
Parcelamento Não Previdenciário |
ParcelamentoNaoPrevidenciarioParcelas |
Parcelamento Não Previdenciário Parcelas |
ParcelamentoNaoPrevidenciarioTributos |
Parcelamento Não Previdenciário Tributos do Processo |
ParcelamentoPgfn |
Parcelamento PGFN |
ParcelamentoPgfnParcelas |
Parcelamento PGFN Parcelas |
ParcelamentoPrevidenciario |
Parcelamento Previdenciário |
ParcelamentoPrevidenciarioParcelas |
Parcelamento Previdenciário Parcelas |
ParcelamentoSimplesNacional |
Parcelamento Simples Nacional |
ParcelamentoSimplesNacionalDebitosParcelados |
Parcelamento Simples Nacional Débitos Parcelados |
ParcelamentoSimplesNacionalParcelas |
Parcelamento Simples Nacional Parcelas |
Situação Fiscal Federal
| Entidade |
Descrição |
SituacaoFiscalFederal |
Situação Fiscal e-CAC |
SituacaoFiscalFederalArrolbens |
SFF Arrolamento de Bens |
SituacaoFiscalFederalObrigacoes |
SFF Obrigações |
SituacaoFiscalFederalParcelamentos |
SFF Parcelamentos |
SituacaoFiscalFederalRegimeTributario |
SFF Regime Tributário |
SituacaoFiscalFederalSocios |
SFF Sócios |
Sublimite Simples Nacional
| Entidade |
Descrição |
SublimiteSimplesNacional |
Sublimite SN |
SublimiteSimplesNacionalComposicao |
Sublimite SN Composição |
Outras
| Entidade |
Descrição |
Perdcomp |
PER/DCOMP |
Identificadores de obrigação (idObrigacao)
Ao consultar a entidade ObrigacoesAcessoriasReg (Obrigação), deve-se passar o id da obrigação no value, com attribute = "idObrigacao":
{ "type": "equals", "attribute": "idObrigacao", "value": 7 }
| id |
Obrigação |
|
id |
Obrigação |
0 |
OUTRAS |
|
10 |
DIRF |
1 |
EFD MS IPI |
|
11 |
DEFIS |
2 |
EFD CONTRIBUIÇÕES |
|
12 |
DMED |
3 |
DCTF |
|
13 |
DESTDA/MG |
4 |
DAPI/MG |
|
14 |
ECD SPED |
5 |
GIA/SP |
|
15 |
ECF SPED |
6 |
DMA/BA |
|
16 |
ESOCIAL |
7 |
DCTFWEB |
|
17 |
DESTDA/SP |
8 |
PGDAS |
|
18 |
DIME/SC |
9 |
REINF (R-2099) |
|
19 |
REINF (R-4099) |