search
SkyHub PortalApi Explorer

Regras Tributárias

Nesta seção são apresentadas as orientações para a criação, atualização e consulta de regras tributárias

As Regras Tributárias implicam o conjunto de dados fiscais que definirão como o imposto do produto será calculado e seu cadastro é realizado com o intuito de auxiliar no processo de geração da nota fiscal.

A estrutura da Regra Tributária seguirá campos pré-definidos de acordo com a necessidade do seller e para a criação, atualização e consulta destas regras serão utilizados os headers padronizados na API da Americanas e visualizados a seguir:

hashtag
Request headers:

Key
Value

X-User-Email

email_de_usuario

X-Api-Key

token_de_integracao de sua conta SkyHub

X-Accountmanager-Key

token_account único de cada Plataforma/ERP

Accept

application/json

Content-Type

application/json

Todas as ações descritas neste guia utilizarão a URL base:

https://api.skyhub.com.br/taxes/{platform}/rule
circle-info

O {platform} deve ser preenchido como b2w.

hashtag
POST - Cadastrando uma Regra Tributária

A criação de uma Regra Tributária via API deverá ser realizada através de um POST, contendo os headers padronizados e descritos acima, para o endpoint:

https://api.skyhub.com.br/taxes/b2w/rule

hashtag
Request body:

{
  "name": "Nome da Regra",
  "origin": "SP",
  "operations": [
    {
      "type": "C",
      "ipi_cst": 50,
      "ipi_aliq": 1.1,
      "ipi_cod_enq": 999,
      "pis_cst": 1,
      "pis_aliq": 1.1,
      "confis_cst": 1,
      "confis_aliq": 1.1,
      "configs": [
        "BASE_ICMS",
        "FRETE_BASE_ICMS"
      ],
      "destinations": [
        {
          "uf": "SP",
          "icms_cst": 0,
          "icms_aliq_interna": 1.1,
          "icms_aliq_interestadual": 1.1,
          "icms_aliq_red": 1.1,
          "icms_aliq_fecp": 1.1,
          "icms_st_aliq_red": 1.1,
          "icms_efet_aliq": 1.1,
          "icms_efet_aliq_red": 1.1,
          "icms_difal_aliq_red": 1.1,
          "icms_st_aliq_mva": 1.1,
          "icms_cod_benef": "1",
          "icms_mot_des_icms": 0
        },
        {
          "uf": "RJ",
          "icms_cst": 0,
          "icms_aliq_interna": 2,
          "icms_aliq_interestadual": 2,
          "icms_aliq_red": 2,
          "icms_aliq_fecp": 2,
          "icms_st_aliq_red": 2,
          "icms_efet_aliq": 2,
          "icms_efet_aliq_red": 2,
          "icms_difal_aliq_red": 2,
          "icms_st_aliq_mva": 2,
          "icms_cod_benef": "2",
          "icms_mot_des_icms": 0
        }
      ]
    }
  ]
}

hashtag
Atributos da requisição:

circle-info

A seguir temos algumas informações fornecidas pelo marketplace sobre os campos presentes na requisição para criação da Regra Tributária.

Atributo
Descrição
Exemplo

name

Nome da Regra Tributária

"regra teste"

origin

UF de Origem

"SP"

type

Tipo de Destinatário

"C" - Contribuente /

"N" - Não contribuente /

"T" - Envio de estoque (Transferência ou Remessa)

ipi_cst

Situação Tributária do IPI

50 - Saída Tributada/

51 - Saída Tributável com Alíquota Zero/

52 - Saída Isenta/

53 - Saída Não-Tributada/

54 - Saída Imune/

55 - Saída com Suspensão/

99 - Outras Saídas

ipi_aliq

Alíquota de IPI

1.1

ipi_cod_enq

Cód. Enquadramento Legal IPI

999

pis_cst

Situação Tributária do PIS

1 - Op. Trib. com Alíquota Básica/

2 - Op. Trib. com Alíquota Diferenciada/

4 - Op. Trib. Monofásica - Revenda a Alíquota Zero/

6 - Op. Trib. a Alíquota Zero/

7 - Op. Isenta da Contribuição/

8 - Op. sem Incidência da Contribuição/

9 - Op. com Suspensão da Contribuição/

49 - Outras Op. de Saída/

99 - Outras Operações

pis_aliq

Alíquota de PIS

1.1

confis_cst

Situação Tributária do CONFINS

1 - Operação Tributável com Alíquota Básica/

2 - Operação Tributável com Alíquota Diferenciada/

4 - Operação Tributável Monofásica - Revenda a Alíquota Zero/

6 - Operação Tributável a Alíquota Zero/

7 - Operação Isenta da Contribuição/

8 - Operação sem Incidência da Contribuição/

9 - Operação com Suspensão da Contribuição/

49 - Outras Operações de Saída/

99 - Outras Operações

confis_aliq

Alíquota de COFINS

1.1

configs

Regras Fiscais (constantes) que quando informadas constarão como SIM no Marketplace.

"BASE_ICMS"

destinations

Lista de Destinos

uf

UF Destino

SP

icms_cst

SitTrib. CST Regime Normal

0 - Tributada integralmente/

10 - Tributada e com cobrança do ICMS por substituição tributária/

20 - Com redução de base de cálculo/

30 - Isenta ou não tributada e com cobrança do ICMS por substituição tributária/

40 - Isenta/

41 - Não tributada/

50 - Suspensão/

51 - Diferimento/

60 - ICMS cobrado anteriormente por substituição tributária/

70 - Com redução de base de cálculo e cobrança do ICMS por substituição tributária/

90 - Outras

icms_aliq_interna

Aliquota de ICMS interna

1.1

icms_aliq_interestadual

Aliquota de ICMS Interestadual

1.1

icms_aliq_red

Reducao da Base de Calculo

1.1

icms_aliq_fecp

Aliquota ICMS FCP

1.1

icms_st_aliq_red

Redução da Base de Calculo ST

1.1

icms_efet_aliq

Aliquota do ICMS Efetivo

1.1

icms_efet_aliq_red

Redução da Base de Calculo do ICMS Efetivo

1.1

icms_difal_aliq_red

Redução da Base de Calculo do DIFAL

1.1

icms_st_aliq_mva

MVA (Ajustado)

1.1

icms_cod_benef

Código de benefício fiscal na UF

1

icms_mot_des_icms

Motivo de Desoneração

0

hashtag
Example request:

hashtag
Response esperado:

circle-check

200 [Success] - OK: O retorno trará os dados inclusos para a regra criada, conforme exemplo a seguir:

hashtag
GET - Consultando as Regras Tributárias

É possível consultar via API as regras cadastradas na conta. Para esta ação, basta realizar um GET, utilizando os headers padronizados, para o endpoint base:

hashtag
Example request:

hashtag
Response esperado:

circle-check

200 [Success] - OK: O retorno seguirá o modelo visualizado a seguir, contendo uma listagem das regras criadas:

hashtag
POST - Atualizando uma Regra Tributária

Ao realizar a consulta das regras cadastradas é possível observar que há um campo chamado id; este não deve ser adicionado na criação da Regra Tributária, pois é atribuído automaticamente à regra criada.

O campo id visualizado na consulta será utilizado para a atualização da regra. A atualização de uma Regra Tributária se dá através da execução de um POST, utilizando os headers padronizados na API, para o endpoint base:

hashtag
Example request:

hashtag
Response esperado:

circle-check

200 [Success] - OK: Assim como na requisição de criação, o retorno trará os dados inclusos para a regra atualizada:

PreviousRegra FiscalNextRelacionamento entre Produto e Regra

Last updated