Árvore de páginas

Versões comparadas

Chave

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

Objetivo

A finalidade deste método é possibilitar a consulta de cenários de Base Composição.

Chamada

GET api/v1/integracao-tributaria/base-composicao?TipoTributo={TipoTributo}&Indicador={Indicador}&_pageNo={_pageNo}&_pageSize={_pageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

NomeDescriçãoTipoInformações Adicionais
TipoTributoTipo de Tributação – Opções: COFINS, ICMS, ICMSANT, IPI, PISstringString length: inclusive between 0 and 14
IndicadorNúmero indicador do cenáriointegerNone.
_pageNo
integerNone.
_pageSize
integerNone.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição dos Dados

GETBaseComposicaoResponseDTO – Lista de cenários de Base Composição

GETBaseComposicaoResponseDTO

NomeDescriçãoTipoInformações Adicionais
VigenciaAteData final de vigenciadateNone.
VigenciaDeData de início de vigenciadateNone.
TributosTipo de Tributação e suas respectivas fórmulas, sendo os tributos: COFINS, ICMS, ICMSANT, IPI, PISTipoTributoDTONone.
DataHoraAlteracaoData e hora da última alteração do cenáriodateNone.
DataHoraInclusaoData e hora de inclusão do cenáriodateNone.
DescricaoDescrição do cenáriostringNone.
IndicadorNúmero indicador do cenáriointegerNone.
TabelaTipo de cenáriostringNone.

Formatos de Resposta (Response Formats)

application/json, text/json

{
“VigenciaAte”: “2020-04-09T14:08:39.6698196-03:00”,
“VigenciaDe”: “2020-04-09T14:08:39.6698196-03:00”,
“Tributos”: {
“COFINS”: {
“FormulaBase”: “sample string 1”,
“FormulaValor”: “sample string 2”
},
“ICMS”: {
“FormulaBase”: “sample string 1”,
“FormulaValor”: “sample string 2”
},
“ICMSANT”: {
“FormulaBase”: “sample string 1”,
“FormulaValor”: “sample string 2”
},
“IPI”: {
“FormulaBase”: “sample string 1”,
“FormulaValor”: “sample string 2”
},
“PIS”: {
“FormulaBase”: “sample string 1”,
“FormulaValor”: “sample string 2”
}
},
“DataHoraAlteracao”: “2020-04-09T14:08:39.6698196-03:00”,
“DataHoraInclusao”: “2020-04-09T14:08:39.6698196-03:00”,
“Descricao”: “sample string 1”,
“Indicador”: 2,
“Tabela”: “sample string 3”
}

application/xml, text/xml

Exemplo (Sample):

<GETBaseComposicaoResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Composicao">
  <DataHoraAlteracao xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.SMIntegracaoTributariaEntityDto.Common">2020-04-09T14:08:39.6698196-03:00</DataHoraAlteracao>
  <DataHoraInclusao xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.SMIntegracaoTributariaEntityDto.Common">2020-04-09T14:08:39.6698196-03:00</DataHoraInclusao>
  <Descricao xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.SMIntegracaoTributariaEntityDto.Common">sample string 1</Descricao>
  <Indicador xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.SMIntegracaoTributariaEntityDto.Common">2</Indicador>
  <Tabela xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.SMIntegracaoTributariaEntityDto.Common">sample string 3</Tabela>
  <Tributos xmlns:d2p1="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common">
    <d2p1:COFINS>
      <d2p1:FormulaBase>sample string 1</d2p1:FormulaBase>
      <d2p1:FormulaValor>sample string 2</d2p1:FormulaValor>
    </d2p1:COFINS>
    <d2p1:ICMS>
      <d2p1:FormulaBase>sample string 1</d2p1:FormulaBase>
      <d2p1:FormulaValor>sample string 2</d2p1:FormulaValor>
    </d2p1:ICMS>
    <d2p1:ICMSANT>
      <d2p1:FormulaBase>sample string 1</d2p1:FormulaBase>
      <d2p1:FormulaValor>sample string 2</d2p1:FormulaValor>
    </d2p1:ICMSANT>
    <d2p1:IPI>
      <d2p1:FormulaBase>sample string 1</d2p1:FormulaBase>
      <d2p1:FormulaValor>sample string 2</d2p1:FormulaValor>
    </d2p1:IPI>
    <d2p1:PIS>
      <d2p1:FormulaBase>sample string 1</d2p1:FormulaBase>
      <d2p1:FormulaValor>sample string 2</d2p1:FormulaValor>
    </d2p1:PIS>
  </Tributos>
  <VigenciaAte>2020-04-09T14:08:39.6698196-03:00</VigenciaAte>
  <VigenciaDe>2020-04-09T14:08:39.6698196-03:00</VigenciaDe>
</GETBaseComposicaoResponseDTO>