Documentação API-REST para retornar os dados da tabela Imposto e Classificação de Imposto
Guia passo a passo
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.
Devem seguir o formato:
/dts/datasul-rest/resources/prg/fin/v1/tax?countryCode='BRA'
GET
Retorna um item ou uma coleção de itens;
Parâmetros da Query
- countryCode: Código do País
- pageSize: Quantidade de ocorrências retornadas.
- filter (não obrigatório): Termo informado para a pesquisa nos seguintes campos: countryCode, stateCode, taxCode, taxDescription e/ou taxType. Serão retornados os registros que coincidam total ou parcialmente com o termo do filtro.
- order (não obrigatório): Informar o campo que será utilizado para ordenar os resultados.
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.
Devem seguir o formato:
/dts/datasul-rest/resources/prg/fin/v1/taxClass?taxCode='29'&stateCode=' '&countryCode='BRA'
GET
Retorna um item ou uma coleção de itens;
Parâmetros da Query:
- countryCode: Código do País.
- stateCode: Código do Estado/Unidade Federação.
- taxCode: Código do Imposto.
- pageSize: Quantidade de ocorrências retornadas.
- filter (não obrigatório): Termo informado para a pesquisa nos seguintes campos: taxClassCode, taxClassDescription, taxRetentionType e/ou taxRateValue. Serão retornados os registros que coincidam total ou parcialmente com o termo do filtro.
- order (não obrigatório): Informar o campo que será utilizado para ordenar os resultados.
Definição de campos no Formato Json:
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 | Código da Tabela Progressiva |
accumulatePayments | Integer | Acumula Pagamentos |
taxRetentionType | Integer | Forma de REtenção |
gilrat | Logical | Classificação GILRAT? |
senar | Logical | Classificação SEST |
senat | Logical | Classificação SENAT |
sest | Logical | Classificação SEST |
taxRateValue | Decimal | Alíquota |
taxMinValue | Decimal | Valor Mínimo Imposto |