Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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.

Parâmetros da Query:

  • countryCode: Código do País
  • pageSize: Quantidade de ocorrências retornadas.

Definição de campos no Formato Json:

CampoFormatoDefinição 
countryCodeCharacterCódigo do País.
stateCodeCharacterCódigo Estado/Unidade Federação. 
taxCodeCharacterCódigo do Imposto
taxDescriptionCharacterDescrição do Imposto
taxTypeInteger

Tipo do Imposto:

(1) Imposto de Vendas
(2) Imposto Sobre Valor Agregado
(3) Imposto Sobre Serviços
(4) Imposto Sobre Operações Financeiras
(5) Imposto de Renda Retido na Fonte
(6) Imposto Sobre Movimen Financeira
(7) SEST/SENAT
(8)Inst Nacional Seguro Social (INSS)
(9)Imposto COFINS PIS CSLL Retido

versionCharacterVersão
taxDocumentTypeCharacterEspécie de Documento para Imposto
taxDocumentPrefixCharacterSérie de Documento para Imposto
baseDueTaxInteger

Base de Vencimento de Imposto:

(1 ) Emissão

(2) Transação

(3) Vencto

(4) Pagto

(5) Implantação

taxClassTypeInteger

Tipo de Classificação do Imposto:

(1) Retido

(2) Taxado

(3) Valor Agregado

taxCompetenceInteger

Competência:

(1) Federal

(2) Estadual

.

controlLimitInteger

Controle Limite

(1) Valor do Imposto

(2) Salário Contribuição

taxBaseDateInteger
 Tipo de Data

 Data Base para Cálculo do Vencimento:

(1)

baseCalcType

Emissão Documento

(2) Baixa Documento

baseCalcDayTypeInteger
baseCalcDate

Contagem de Dias para Cálculo de Vencimento

(1) Dias úteis

(2) Dias Corridos

Integer

taxDueTypeInteger

Período para cálculo de vencimento

(1) Semana

(2) Decêndio

(3) Quinzena

(4) Mês

(5) Bimestre

(6) Trimestre

paymentoAccumPeriodLogicalAcumula dados DIRF
enableLinkTaxLogicalHabilita Vinculação na Implantação?
truncateValueTaxLogicalTrunca Valor de Imposto
nameMonthInitialCharacterInício Período 
numDayDueTax"IntegerNúmero de Dias para cálculo de Vencimento
baseInitialValueDecimalValor Base de início de Retenção
maxInssValue"DecimalValor 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:

  • 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.


CampoFormatoDefinição 
countryCodeCharacterCódigo do País



Informações
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.

...