Árvore de páginas

Objetivo

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

Chamada

PUT [URLAPI]/SMIntTributAPI/api/v1/integracao-tributaria/base-composicao/{indicador}

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

Parâmetros URI (URI Parameters)

NomeDescriçãoTipoInformações Adicionais
indicador
integerRequired

Parâmetros do Corpo (Body Parameters)

PUTBaseComposicaoRequestDTO

NomeDescriçãoTipoInformações Adicionais
TributosTipo de Tributação e suas respectivas fórmulas, sendo os tributos: COFINS, ICMS, ICMSANT, IPI, PISTipoTributoDTONone.
DescricaoDescrição do cenáriostringString length: inclusive between 0 and 1000
VigenciaDeData Início da Vigência da fórmula – Formatos: dd/mm/yyyy hh:mm ou ddmmyyyyhhmmstringNone.
VigenciaAteData Final da Vigência da fórmula – Formatos: dd/mm/yyyy hh:mm ou ddmmyyyyhhmmstringNone.

Formatos da Requisição (Request Formats)

application/json, text/json

Exemplo (Sample):

{
  "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"
    }
  },
  "Descricao": "sample string 1",
  "VigenciaDe": "sample string 2",
  "VigenciaAte": "sample string 3"
}

application/xml, text/xml

Exemplo (Sample):

<PUTBaseComposicaoRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Composicao">
  <Descricao xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common">sample string 1</Descricao>
  <VigenciaAte xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common">sample string 3</VigenciaAte>
  <VigenciaDe xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common">sample string 2</VigenciaDe>
  <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>
</PUTBaseComposicaoRequestDTO>

application/x-www-form-urlencoded

Exemplo (Sample):

Exemplo não disponível.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Descrição dos Dados

Status Code 200 – Ok

IntegracaoTributariaResponseDTO

NomeDescriçãoTipoInformações Adicionais
CallbackURLEndpoint para consulta do item manipuladostringNone.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "CallbackURL": "sample string 1"
}

application/xml, text/xml

Exemplo (Sample):

<IntegracaoTributariaResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common">
  <CallbackURL>sample string 1</CallbackURL>
</IntegracaoTributariaResponseDTO>