Regra Fiscal

Nesta seção são apresentadas as orientações para a criação, atualização e consulta da regra fiscal

A estrutura da Regra Fiscal seguirá campos pré-definidos de acordo com a necessidade do seller.

Para a criação, atualização e consulta da Regra Fiscal 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

Ainda, todas as ações descritas neste guia utilizarão a URL base:

https://api.skyhub.com.br/taxes/{platform}/data

O {platform} deve ser preenchido como b2w.

POST - Cadastrando/Atualizando uma Regra Fiscal

A criação/atualização de uma Regra Fiscal 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/data

Uma vez que a Regra Fiscal é aplicada para toda a loja, qualquer POST realizado após a sua criação substitui os dados previamente preenchidos, isto é, após criada a regra, as requisições seguintes contendo o método POST serão consideradas como atualizações e irão sobrescrever as informações anteriormente aplicadas.

Request body:

{
  "id_crt": 2,
  "tp_calc_sub_cs": "2",
  "tp_calc_icms_destin": "1",
  "difal_states": [
    "SP"
  ],
  "configs": [
    "DESC_COND_BASE_ICMS",
    "DESC_COND_BASE_IPI",
    "DESC_COND_BASE_PIS",
    "DESC_INC_BASE_ICMS",
    "DESC_INC_BASE_IPI",
    "DESC_INC_BASE_PIS",
    "DESC_INC_BASE_SUB",
    "DESPESA_BASE_ICMS",
    "DESPESA_BASE_IPI",
    "DESPESA_BASE_SUB",
    "FRETE_BASE_ICMS",
    "FRETE_BASE_IPI",
    "FRETE_BASE_PIS",
    "FRETE_BASE_SUB",
    "ICMS_BASE_PIS",
    "ICMS_SUB_BASE_PIS",
    "IPI_BASE_ICMS",
    "IPI_BASE_PIS",
    "IPI_BASE_SUB",
    "SEGURO_BASE_ICMS",
    "SEGURO_BASE_IPI",
    "SEGURO_BASE_PIS",
    "SEGURO_BASE_SUB",
    "CALC_DIFAL"
  ]
}

Atributos da requisição:

Caso alguma config não seja inclusa na requisição, o atributo automaticamente será acatado pelo marketplace como não utilizado/indisponível para a loja.

Atributo	Descrição
id_crt	Código CRT do vendedor
calc_sub_cs	Modelo de cálculo da “EC87 / 2015” e Difal - ST - contribuinte
calc_icms_destin	Modelo de cálculo da “EC87 / 2015” e Difal - ST - não contribuinte
difal_states	Lista de estados para aplicação: Tipo de destinatário do cálculo do ICMS
configs	Regras Fiscais (constantes) que quando informadas constarão como SIM no Marketplace
DESC_COND_BASE_ICMS	ICMS - Deduz descontos condicionais
DESC_INC_BASE_ICMS	ICMS - Deduz descontos incondicionais
DESPESA_BASE_ICMS	ICMS - Despesas
FRETE_BASE_ICMS	ICMS - Frete
IPI_BASE_ICMS	ICMS - IPI
SEGURO_BASE_ICMS	ICMS - Seguro
DESC_COND_BASE_SUB	ICMS - ST - Deduz descontos condicionais
DESC_INC_BASE_SUB	ICMS - ST - Deduz descontos incondicionais
DESPESA_BASE_SUB	ICMS - ST - Despesas
FRETE_BASE_SUB	ICMS - ST - Frete
IPI_BASE_SUB	ICMS - ST - IPI
SEGURO_BASE_SUB	ICMS - ST - Seguro
DESC_COND_BASE_IPI	IPI - Deduz descontos condicionais
DESC_INC_BASE_IPI	IPI - Deduz descontos incondicionais
DESPESA_BASE_IPI	IPI - Despesas
FRETE_BASE_IPI	IPI - Frete
SEGURO_BASE_IPI	IPI - Seguro
DESC_COND_BASE_PIS	Pis e Cofins - Deduz descontos condicionais
DESC_INC_BASE_PIS	Pis e Cofins - Deduz descontos incondicionais
DESPESA_BASE_PIS	Pis e Cofins - Despesas
FRETE_BASE_PIS	Pis e Cofins - Frete
ICMS_BASE_PIS	Pis e Cofins - ICMS
ICMS_SUB_BASE_PIS	Pis e Cofins - ICMS - ST
IPI_BASE_PIS	Pis e Cofins - IPI
SEGURO_BASE_PIS	Pis e Cofins - Seguro
CALC_DIFAL	ICMS tipo de cálculo - Destino

Example request:

curl --location --request POST 'https://api.skyhub.com.br/taxes/b2w/data' \
--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_crt": 2,
  "tp_calc_sub_cs": "2",
  "tp_calc_icms_destin": "1",
  "difal_states": [
    "BA",
    "SP",
    "RJ"
  ],
  "configs": [
    "DESC_COND_BASE_ICMS",
    "DESC_COND_BASE_IPI",
    "DESC_COND_BASE_PIS",
    "DESC_INC_BASE_ICMS",
    "DESC_INC_BASE_IPI",
    "DESC_INC_BASE_PIS",
    "DESC_INC_BASE_SUB",
    "DESPESA_BASE_ICMS",
    "DESPESA_BASE_IPI",
    "DESPESA_BASE_SUB",
    "FRETE_BASE_ICMS",
    "FRETE_BASE_IPI",
    "FRETE_BASE_PIS",
    "FRETE_BASE_SUB",
    "ICMS_BASE_PIS",
    "ICMS_SUB_BASE_PIS",
    "IPI_BASE_ICMS",
    "IPI_BASE_PIS",
    "IPI_BASE_SUB",
    "SEGURO_BASE_ICMS",
    "SEGURO_BASE_IPI",
    "SEGURO_BASE_PIS",
    "SEGURO_BASE_SUB",
    "CALC_DIFAL"
  ]
}'

Response esperado:

204 [Success] - No content

GET - Consultando a Regra Fiscal

A consulta da Regra Fiscal cadastrada na conta poderá ser realizada através de um GET, utilizando os headers padronizados na API, para o endpoint:

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

Example request:

curl --location --request GET 'https://api.skyhub.com.br/taxes/b2w/data' \
--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 trará informações sobre a regra cadastrada, conforme exemplo abaixo:

{
    "cnpj_filial": "cnpj_cd_direct",
    "configs": [
        "CALC_DIFAL",
        "DESC_COND_BASE_ICMS",
        "DESC_COND_BASE_PIS",
        "DESC_INC_BASE_ICMS",
        "DESC_INC_BASE_PIS",
        "DESC_INC_BASE_SUB",
        "DESPESA_BASE_ICMS",
        "DESPESA_BASE_IPI",
        "DESPESA_BASE_SUB",
        "FRETE_BASE_ICMS",
        "FRETE_BASE_IPI",
        "FRETE_BASE_PIS",
        "FRETE_BASE_SUB",
        "ICMS_BASE_PIS",
        "ICMS_SUB_BASE_PIS",
        "IPI_BASE_ICMS",
        "IPI_BASE_PIS",
        "IPI_BASE_SUB",
        "SEGURO_BASE_ICMS",
        "SEGURO_BASE_IPI",
        "SEGURO_BASE_PIS",
        "SEGURO_BASE_SUB"
    ],
    "difal_states": [
        "BA",
        "SP",
        "RJ"
    ],
    "id_crt": 2,
    "id_terceiro": CNPJ_da_Loja,
    "tp_calc_icms_destin": "1",
    "tp_calc_sub_cs": "2"
}