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:

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

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

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
        }
      ]
    }
  ]
}

Atributos da requisição:

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

Example request:

curl --location --request POST 'https://api.skyhub.com.br/taxes/b2w/rule' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Nova Regra - Teste",
  "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
        }
      ]
    }
  ]
}'

Response esperado:

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

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

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:

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

Example request:

curl --location --request GET 'https://api.skyhub.com.br/taxes/b2w/rule' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Response esperado:

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

{
    "rules": [
        {
            "date": "31/05/2023 14:32",
            "id": 1411,
            "name": "Nova Regra - Teste",
            "origin": "SP"
        },
        {
            "date": "06/06/2022 09:08",
            "id": 1410,
            "name": "Regra: Teste 02",
            "origin": "MG"
        },
        {
            "date": "03/06/2022 17:46",
            "id": 1409,
            "name": "Regra: Teste 01",
            "origin": "SP"
        }
    ]
}

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:

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

Example request:

curl --location --request POST 'https://api.skyhub.com.br/taxes/b2w/rule' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "id": "1411",
  "name": "Regra Atualizada - Teste",
  "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
        }
      ]
    }
  ]
}'

Response esperado:

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

{
    "filial": "cnpj_cd_direct",
    "id": "1411",
    "name": "Regra Atualizada - Teste",
    "operations": [
        {
            "configs": [
                "BASE_ICMS",
                "FRETE_BASE_ICMS"
            ],
            "confis_aliq": 1.1,
            "confis_cst": 1,
            "destinations": [
                {
                    "icms_aliq_fecp": 1.1,
                    "icms_aliq_interestadual": 1.1,
                    "icms_aliq_interna": 1.1,
                    "icms_aliq_red": 1.1,
                    "icms_cod_benef": "1",
                    "icms_cst": 0,
                    "icms_difal_aliq_red": 1.1,
                    "icms_efet_aliq": 1.1,
                    "icms_efet_aliq_red": 1.1,
                    "icms_mot_des_icms": 0,
                    "icms_st_aliq_mva": 1.1,
                    "icms_st_aliq_red": 1.1,
                    "uf": "SP"
                }
            ],
            "ipi_aliq": 1.1,
            "ipi_cod_enq": 999,
            "ipi_cst": 50,
            "pis_aliq": 1.1,
            "pis_cst": 1,
            "type": "C"
        }
    ],
    "origin": "SP"
}

Last updated