API de retorno
Retorno e exemplos da API de retorno.
Descrição dos campos de retorno
Os campos de retorno de tributação das regras calculadas são os mesmos da ferramenta de parametrização fiscal.
Acesse a última versão de documentação no manual de "Conteúdo", no capítulo "Entrega de regras fiscais", página "Detalhamento do retorno da tributação".
Campos exclusivos da API:
| Campo | Descrição | Tipo |
| data | Dados de retorno do cálculo das regras | String |
| success | true | Boolean |
| message | Mensagem de retorno da API | String |
| record_count | Quantidade de regras calculadas | Numeric |
Tabela de referência para os campos “success e message”:
|
Código de retorno |
success |
message |
|
200 |
true |
Regras processadas |
| true | Regras ainda sendo processadas | |
| 400 | false | Erro inesperado, tente novamente mais tarde |
|
401 |
false |
Não autorizado |
Exemplos de chamada
Para a paginação é necessário combinar os dois parâmetros: "offset" e "quantity" conforme abaixo:
Requisição 1:
offset = 0
Quantity = 10
A API irá exibir os primeiros 10 registros da sequência.
Requisição 2:
offset = 10
Quantity = 20
Como a API já exibiu os primeiros 10 registros na requisição 1, então atribuímos o valor 10 ao parâmetro "offset" (a API irá desconsiderar os 10 registros listados na requisição anterior), e para o "quantity", a próxima quantidade escolhida para ser exibida, que no exemplo, é de 20.
Requisição 3:
offset = 30
Quantity = 10
Como a API já tinha exibido 30 registros nas requisições 1 e 2, então atribuímos o valor 30 ao parâmetro "offset" e foi escolhido mais 10 novos registros para serem exibidos.
Observação: Há um limite de 100 regras por requisição.
Exemplos de retorno
Regras sendo calculadas:
{
"data": null,
"success": true,
"message": "Pendente: regras ainda sendo calculadas",
"record_count": 0
}
Regras calculadas:
{
"data": {
"regras": [
{
"status": "Finalizado",
"message": "",
"produto": {
"codigo_produto": "Código do produto",
"origem_material": "1",
"ncm": "",
"ex_tipi": "",
"ean": "",
"descricao": "",
"data_emissao": "2020-01-01"
},
"cenario": {
"ufOrigem": "EX",
"ufDestino": "PI",
"natureza_operacao": "43",
"perfil_origem": "682",
"perfil_destino": "1",
"finalidade": "43",
"ent_sai": "0",
"municipio_origem": "",
"municipio_destino": ""
},
"regra": {
"lote": 5728238,
"icms": {
"cfop": "1556",
"cfop_entrada": "1556",
"cest": null,
"cst": "00",
"bc_composicao": null,
"p_red_bc": null,
"aliquota": null,
"generico": null,
"vigencia_de": null,
"dispositivo_legal": null,
"inf_adicionais": null,
"bc_composicao_sn_especial": null,
"bc_composicao_fcp": null,
"percentual_diferimento": null,
"aliquota_cf": null,
"aliquota_sn_especial": null,
"aliquota_desonerada": null,
"fcp": null,
"valor_pauta": null,
"unidade_pauta": null,
"dif_aliq_nao_contrib": null,
"vigencia_ate": null,
"observacoes": null,
"icms_st": null,
"icms_uf_dest": null,
"estatistica": null,
"severidade": null,
"ncm": null,
"extipi": null,
"orig": null,
"cprod": null
},
"credito_icms": {
"indicador_credito": "0",
"cst_entrada": "90",
"percentual_credito": null,
"vigencia_de": null,
"vigencia_ate": null,
"dispositivo_legal": null,
"generico": null,
"observacoes": null
},
"icms_uf_dest": null,
"ipi": {
"cst": "00",
"cenq": null,
"bc_composicao": null,
"aliquota": null,
"generico": null,
"vigencia_de": null,
"vigencia_ate": null,
"dispositivo_legal": null,
"p_red_bc": null,
"p_red_aliq": null,
"valor_por_unid_trib": null,
"p_red_val_imp": null,
"observacoes": null,
"inf_adicionais": null,
"estatistica": null,
"severidade": null
},
"credito_ipi": {
"indicador_credito": "0",
"cst_entrada": "49",
"percentual_credito": null,
"generico": null,
"vigencia_de": null,
"vigencia_ate": null,
"dispositivo_legal": null,
"observacoes": null
},
"pis": {
"cst": "00",
"bc_composicao": null,
"aliquota": null,
"vigencia_de": null,
"vigencia_ate": null,
"dispositivo_legal": null,
"p_red_bc": null,
"aliquota_especifica": null,
"generico": null,
"observacoes": null,
"inf_adicionais": null,
"codigo_natureza_receita": null,
"estatistica": null,
"severidade": null
},
"credito_pis": {
"indicador_credito": "0",
"cst_entrada": "70",
"vigencia_de": null,
"vigencia_ate": null,
"dispositivo_legal": null,
"percentual_credito": null,
"generico": null,
"observacoes": null
},
"cofins": {
"cst": "00",
"bc_composicao": null,
"aliquota": null,
"vigencia_de": null,
"vigencia_ate": null,
"dispositivo_legal": null,
"p_red_bc": null,
"aliquota_especifica": null,
"generico": null,
"observacoes": null,
"inf_adicionais": null,
"codigo_natureza_receita": null,
"estatistica": null,
"severidade": null
},
"credito_cofins": {
"indicador_credito": "0",
"cst_entrada": "70",
"vigencia_de": null,
"vigencia_ate": null,
"dispositivo_legal": null,
"percentual_credito": null,
"generico": null,
"observacoes": null
},
"antecipacao": null,
"icms_st": null
}
}
]
},
"success": true,
"message": "Regras processadas",
"record_count": 1
}