Documentação API-REST para retornar os dados da tabela Imposto e Classificação de Imposto
Api_REST - Tabela de Impostos
Quando informado o Código do País na Query/GET serão retornados todos os impostos do País informado, caso contrário serão retornados todos os impostos.
Parâmetros da Query:
Definição de campos no Formato Json:
| Campo | Formato | Definição |
|---|---|---|
| countryCode | Character | Código do País. |
| stateCode | Character | Código Estado/Unidade Federação. |
| taxCode | Character | Código do Imposto |
| taxDescription | Character | Descrição do Imposto |
| taxType | Integer | Tipo do Imposto: (1) Imposto de Vendas |
| version | Character | Versão |
| taxDocumentType | Character | Espécie de Documento para Imposto |
| taxDocumentPrefix | Character | Série de Documento para Imposto |
| baseDueTax | Integer | Base de Vencimento de Imposto: (1 ) Emissão (2) Transação (3) Vencto (4) Pagto (5) Implantação |
| taxClassType | Integer | Tipo de Classificação do Imposto: (1) Retido (2) Taxado (3) Valor Agregado |
| taxCompetence | Integer | Competência: (1) Federal (2) Estadual |
| controlLimit | Integer | Controle Limite (1) Valor do Imposto (2) Salário Contribuição |
| taxBaseDate | Integer | Data Base para Cálculo do Vencimento: (1) Emissão Documento (2) Baixa Documento |
| baseCalcDayType | Integer | Contagem de Dias para Cálculo de Vencimento (1) Dias úteis (2) Dias Corridos |
| taxDueType | Integer | Período para cálculo de vencimento (1) Semana (2) Decêndio (3) Quinzena (4) Mês (5) Bimestre (6) Trimestre |
| paymentoAccumPeriod | Logical | Acumula dados DIRF |
| enableLinkTax | Logical | Habilita Vinculação na Implantação? |
| truncateValueTax | Logical | Trunca Valor de Imposto |
| nameMonthInitial | Character | Início Período |
| numDayDueTax" | Integer | Número de Dias para cálculo de Vencimento |
| baseInitialValue | Decimal | Valor Base de início de Retenção |
| maxInssValue" | Decimal | Valor Limite máximo de Retenção |
API-REST - Tabela de Classificação de Impostos
Para realizar a busca de todas as classificação de determinado imposto, informar na Query/GET os campos: Código do país, Estado e Código do Imposto.
Parâmetros da Query:
| Campo | Formato | Definição |
|---|---|---|
| countryCode | Character | Código do País |
| version | Character | Versão |
| taxClassCode | Character | Código da Classificação de Imposto |
| stateCode | Character | Estado/Unidade Federação |
| taxCode | Character | Código do Imposto |
| taxClassDescription | Character | Descrição da Classificação Imposto |
| progressiveTableCode | Character | |
| accumulatePayments | Integer | |
| taxRetentionType | Integer | |
| gilrat | Logical | Classificação GILRAT? |
| senar | Logical | Classificação SEST |
| senat | Logical | Classificação SENAT |
| sest | Logical | Classificação SEST |
| taxRateValue | Decimal | |
| taxMinValue | Decimal |
field cdd_version AS CHARACTER INITIAL ? SERIALIZE-NAME '':U
FIELD cod_classif_impto AS CHARACTER INITIAL ? SERIALIZE-NAME 'e':U
FIELD cod_pais AS CHARACTER INITIAL ? SERIALIZE-NAME '':U
FIELD cod_unid_federac AS CHARACTER INITIAL ? SERIALIZE-NAME '':U
FIELD cod_imposto AS CHARACTER INITIAL ? SERIALIZE-NAME '':U
field des_classif_impto AS CHARACTER INITIAL ? SERIALIZE-NAME '':U
FIELD cod_tab_prgssiv_impto_retid AS CHARACTER INITIAL ? SERIALIZE-NAME '':U
FIELD idi_tip_acum_pagto AS INTEGER INITIAL ? SERIALIZE-NAME '':U
field idi_tip_retenc_impto AS INTEGER INITIAL ? SERIALIZE-NAME '':U
field log_gilrat as logical initial ? serialize-name ':u
field log_senar as logical initial ? serialize-name '':u
field log_senat as logical initial ? serialize-name '':u
field log_sest as logical initial ? serialize-name '':u
field val_aliq_impto as DECIMAL initial ? serialize-name '':u
field val_min_impto as DECIMAL initial ? serialize-name '':u.
| Conforme padrão de desenvolvimento adotado para BACK_END, os campos do tipo indicadores serão retornados no formato inteiro, respeitando a sequência de valores definidas para a tabela no dicionário de dados. |
Não se aplica.