# Retorno

Aqui veremos todos pontos do retorno, como definições, estruturas e exemplos para serem utilizados como base.

# Definições do retorno

O retorno é apresentado ordenado pelo melhor custo de aquisição entre os fornecedores e destinatários consultados, e para cada operação é informada toda tributação envolvida. Este retorno é apresentado no bloco "comparativo" ordenado do menor para o maior custo de aquisição"

Como mencionado no tópico anterior, a chamada pode ser feita solicitando uma consulta pelo valor de compra ou pelo custo, e o retorno dessas indicações são destacadas no bloco "comparativo" do retorno.

{

"comparativo" \[

 {

 "ufOrigem": "",

 "ufDestino": "",

 "perfilRem": "",

 "perfilDest": "",

 "custoAquisicao": "",

 "precoNet": "",

 "precoTributos": "",

 }

Dependendo da consulta feita é indicado o “precoNet” que informa o valor líquido da operação, ou seja, sem os tributos. Ou retorna o “precoTributos” que informa o valor da operação, embutindo os tributos no caso da indicação na chamada por um valor de custo.

Portanto:

\- Se na chamada for solicitado "precoOuCusto": "P" no retorno o resultado será apresentado "precoTributos";

\- Se na chamada for solicitado "precoOuCusto": "C" no retorno o resultado será apresentado no "precoNet".

\- Se na chamada o campo "precoOuCusto" for vazio, no retorno nenhum dos campos supra citados serão preenchidos.

# Estrutura dos dados do retorno

<table cellspacing="0" class="Table" id="bkmrk-tag-pai-descri%C3%87%C3%83o-re"><tbody><tr><td>**TAG**

</td><td>**PAI**

</td><td>**DESCRIÇÃO**

</td></tr><tr><td>retorno

</td><td>/

</td><td>Grupo raiz

</td></tr><tr><td>comparativo

</td><td>Retorno

</td><td>Grupo de itens

</td></tr><tr><td>itens

</td><td>Itens

</td><td>Diversas ocorrências por retorno conforme a quantidade de itens enviados.

</td></tr><tr><td>id</td><td>Itens</td><td>Identifica o item indicado na chamada.</td></tr><tr><td>ufOrigem

</td><td>Itens

</td><td>Corresponde a UF do fornecedor.

</td></tr><tr><td>ufDestino</td><td>Itens</td><td>Correspode a UF do destinatário </td></tr><tr><td>perfilRem

</td><td>Itens

</td><td>Perfil do fornecedor.

</td></tr><tr><td>perfilDest</td><td>Itens</td><td>Perfil do destinatário/comprador.</td></tr><tr><td>custoAquisicao

</td><td>Itens

</td><td>Valor do custo de aquisição.

</td></tr><tr><td>precoNet

</td><td>Itens

</td><td>Valor unitário sem os tributos.

</td></tr><tr><td>precoTributos

</td><td>Itens

</td><td>Novo valor unitário a ser empregado para o cálculo.

</td></tr><tr><td>item

</td><td>Itens

</td><td>Retorno de todos os detalhes do cálculo dos tributos, assim como status da consulta.

Conteúdo disponível conforme indicação do link abaixo.

</td></tr></tbody></table>

Como o retorno da tributação do Comparativo de Compras possuí a mesma estrutura do retorno do motor de cálculo, acesse o link abaixo para obter o detalhamento dos campos:

[http://documentacao.systax.com.br/Element78/VisualizationDetail/25693](http://documentacao.systax.com.br/Element78/VisualizationDetail/25693)

# Exemplo de retorno

{"comparativo": \[{  
 "itens": \[  
 {  
 "id": "1",  
 "ufOrigem": "ac",  
 "ufDestino": "sc",  
 "perfilRem": "2",  
 "perfilDest": "138",  
 "custoAquisicao": "7.87",  
 "precoNet": "",  
 "precoTributos": null  
 },  
 {  
 "id": "2",  
 "ufOrigem": "to",  
 "ufDestino": "sc",  
 "perfilRem": "1",  
 "perfilDest": "138",  
 "custoAquisicao": "7.87",  
 "precoNet": "",  
 "precoTributos": null  
 },  
 {  
 "id": "1",  
 "ufOrigem": "ac",  
 "ufDestino": "sp",  
 "perfilRem": "2",  
 "perfilDest": "138",  
 "custoAquisicao": "10.94",  
 "precoNet": "",  
 "precoTributos": null  
 },  
 {  
 "id": "2",  
 "ufOrigem": "to",  
 "ufDestino": "sp",  
 "perfilRem": "1",  
 "perfilDest": "138",  
 "custoAquisicao": "10.94",  
 "precoNet": "",  
 "precoTributos": null  
 }  
 \],  
 "calculoDetalhadoItens": \[  
 {  
 "id": "1",  
 "cProd": "",  
 "CEST": "1703800",  
 "CFOP": "6102",  
 "NCM": "21033021",  
 "pCredSN\_resp": "0",  
 "custo\_aquisicao": "7.87",  
 "generico": "busca=NCMD|codProd=NCM\_21033021-0|orig=|CFOP\_ENTRADA=2102|UFO=ac|UFD=sc|natOp=121|perfilorig=2|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",  
 "status": {  
 "cod": "0",  
 "msg": "Retornado com sucesso."  
 },  
 "NFe": {  
 "imposto": {  
 "ICMS": {"ICMS00": {  
 "orig": "",  
 "CST": "00",  
 "modBC": "3",  
 "vBC": "10.00",  
 "pICMS": "12.0000",  
 "vICMS": "1.20"  
 }},  
 "IPI": {  
 "cEnq": "999",  
 "IPINT": {"CST": "51"}  
 },  
 "PIS": {"PISAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pPIS": "1.6500",  
 "vPIS": "0.17"  
 }},  
 "COFINS": {"COFINSAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pCOFINS": "7.6000",  
 "vCOFINS": "0.76"  
 }}  
 },  
 "infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "  
 },  
 "conteudoAuxiliar": {  
 "ICMSCred": {  
 "cst\_entrada": "00",  
 "indicador\_credito": "1",  
 "percentual\_credito": "100.00",  
 "valor\_base\_calculo": "10.00",  
 "valor\_credito": "1.20",  
 "dispositivo\_legal": "Art.28 e 29, do RICMS/SC",  
 "pICMS": "12.0000"  
 },  
 "IPICred": {  
 "cst\_entrada": "01",  
 "indicador\_credito": "0",  
 "valor\_base\_calculo": "0.00",  
 "percentual\_credito": "0.00",  
 "valor\_credito": "0.00",  
 "dispositivo\_legal": "Art. 226 do RIPI/2010"  
 },  
 "PISCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.17",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.637/2002",  
 "pPIS": "1.6500"  
 },  
 "COFINSCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.76",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.833/2003",  
 "pCOFINS": "7.6000"  
 },  
 "DispositivoLegal": {  
 "DispositivoLegalICMS": "Art. 5º, I do RICMS/AC. Art. 17, II do RICMS/AC ",  
 "DispositivoLegalICMSST": null,  
 "DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",  
 "DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",  
 "DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"  
 }  
 }  
 },  
 {  
 "id": "2",  
 "cProd": "",  
 "CEST": "1703800",  
 "CFOP": "6102",  
 "NCM": "21033021",  
 "pCredSN\_resp": "0",  
 "custo\_aquisicao": "7.87",  
 "generico": "busca=NCMD|codProd=NCM\_21033021-0|orig=|CFOP\_ENTRADA=2102|UFO=to|UFD=sc|natOp=120|perfilorig=1|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",  
 "status": {  
 "cod": "0",  
 "msg": "Retornado com sucesso."  
 },  
 "NFe": {  
 "imposto": {  
 "ICMS": {"ICMS00": {  
 "orig": "",  
 "CST": "00",  
 "modBC": "3",  
 "vBC": "10.00",  
 "pICMS": "12.0000",  
 "vICMS": "1.20"  
 }},  
 "IPI": {  
 "cEnq": "999",  
 "IPINT": {"CST": "51"}  
 },  
 "PIS": {"PISAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pPIS": "1.6500",  
 "vPIS": "0.17"  
 }},  
 "COFINS": {"COFINSAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pCOFINS": "7.6000",  
 "vCOFINS": "0.76"  
 }}  
 },  
 "infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "  
 },  
 "conteudoAuxiliar": {  
 "ICMSCred": {  
 "cst\_entrada": "00",  
 "indicador\_credito": "1",  
 "percentual\_credito": "100.00",  
 "valor\_base\_calculo": "10.00",  
 "valor\_credito": "1.20",  
 "dispositivo\_legal": "Art.28 e 29, do RICMS/SC",  
 "pICMS": "12.0000"  
 },  
 "IPICred": {  
 "cst\_entrada": "01",  
 "indicador\_credito": "0",  
 "valor\_base\_calculo": "0.00",  
 "percentual\_credito": "0.00",  
 "valor\_credito": "0.00",  
 "dispositivo\_legal": "Art. 226 do RIPI/2010"  
 },  
 "PISCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.17",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.637/2002",  
 "pPIS": "1.6500"  
 },  
 "COFINSCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.76",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.833/2003",  
 "pCOFINS": "7.6000"  
 },  
 "DispositivoLegal": {  
 "DispositivoLegalICMS": "Art. 22, I da Lei nº 1.287/2001. Art. 27, § 2º,II da Lei nº 1.287/2001",  
 "DispositivoLegalICMSST": null,  
 "DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",  
 "DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",  
 "DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"  
 }  
 }  
 },  
 {  
 "id": "1",  
 "cProd": "",  
 "CEST": "1703800",  
 "CFOP": "6102",  
 "NCM": "21033021",  
 "pCredSN\_resp": "0",  
 "custo\_aquisicao": "10.94",  
 "generico": "busca=NCMD|codProd=NCM\_21033021-0|orig=|CFOP\_ENTRADA=2403|UFO=ac|UFD=sp|natOp=121|perfilorig=2|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",  
 "status": {  
 "cod": "0",  
 "msg": "Retornado com sucesso."  
 },  
 "NFe": {  
 "imposto": {  
 "ICMS": {"ICMS00": {  
 "orig": "",  
 "CST": "00",  
 "modBC": "3",  
 "vBC": "10.00",  
 "pICMS": "12.0000",  
 "vICMS": "1.20"  
 }},  
 "IPI": {  
 "cEnq": "999",  
 "IPINT": {"CST": "51"}  
 },  
 "PIS": {"PISAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pPIS": "1.6500",  
 "vPIS": "0.17"  
 }},  
 "COFINS": {"COFINSAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pCOFINS": "7.6000",  
 "vCOFINS": "0.76"  
 }}  
 },  
 "infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "  
 },  
 "conteudoAuxiliar": {  
 "ICMSCred": {  
 "cst\_entrada": "60",  
 "indicador\_credito": "0",  
 "percentual\_credito": "0.00",  
 "valor\_base\_calculo": "0.00",  
 "valor\_credito": "0.00"  
 },  
 "ICMS\_Antecipacao": {  
 "tipo\_antecipacao": "2",  
 "encerra\_trib": "1",  
 "responsavel": "D",  
 "p\_red\_bc\_interna\_dest": "0.00",  
 "aliq\_interna\_dest": "18.0000",  
 "bc\_icms\_antecipacao": "17.0720",  
 "vigencia\_de": "2020-03-01",  
 "valor\_icms\_antecipacao": "1.87",  
 "mva": "70.72",  
 "mva\_ajustado": "0.00",  
 "mva\_lista\_positiva\_ajustado": "0.00",  
 "mva\_lista\_negativa\_ajustado": "0.00",  
 "mva\_lista\_neutra\_ajustado": "0.00"  
 },  
 "ICMS\_ANTECIPACAOCred": {  
 "indicador\_credito": "0",  
 "valor\_base\_calculo": "0.00",  
 "percentual\_credito": "0.00",  
 "valor\_credito": "0.00",  
 "dispositivo\_legal": "Art. 277 cc §5º do artigo 426-A do RICMS/SP",  
 "observacoes": "Observar as condições do §3º do artigo 277 do RICMS/SP: \\"O valor do imposto recolhido antecipadamente por meio de guia de recolhimentos especiais, nos termos do art. 426-A, deverá ser escriturada no LRAICMS\\"."  
 },  
 "IPICred": {  
 "cst\_entrada": "01",  
 "indicador\_credito": "0",  
 "valor\_base\_calculo": "0.00",  
 "percentual\_credito": "0.00",  
 "valor\_credito": "0.00",  
 "dispositivo\_legal": "Art. 226 do RIPI/2010"  
 },  
 "PISCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.17",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.637/2002",  
 "pPIS": "1.6500"  
 },  
 "COFINSCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.76",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.833/2003",  
 "pCOFINS": "7.6000"  
 },  
 "DispositivoLegal": {  
 "DispositivoLegalICMS": "Art. 5º, I do RICMS/AC. Art. 17, II do RICMS/AC ",  
 "DispositivoLegalICMSST": null,  
 "DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",  
 "DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",  
 "DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"  
 }  
 }  
 },  
 {  
 "id": "2",  
 "cProd": "",  
 "CEST": "1703800",  
 "CFOP": "6102",  
 "NCM": "21033021",  
 "pCredSN\_resp": "0",  
 "custo\_aquisicao": "10.94",  
 "generico": "busca=NCMD|codProd=NCM\_21033021-0|orig=|CFOP\_ENTRADA=2403|UFO=to|UFD=sp|natOp=120|perfilorig=1|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",  
 "status": {  
 "cod": "0",  
 "msg": "Retornado com sucesso."  
 },  
 "NFe": {  
 "imposto": {  
 "ICMS": {"ICMS00": {  
 "orig": "",  
 "CST": "00",  
 "modBC": "3",  
 "vBC": "10.00",  
 "pICMS": "12.0000",  
 "vICMS": "1.20"  
 }},  
 "IPI": {  
 "cEnq": "999",  
 "IPINT": {"CST": "51"}  
 },  
 "PIS": {"PISAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pPIS": "1.6500",  
 "vPIS": "0.17"  
 }},  
 "COFINS": {"COFINSAliq": {  
 "CST": "01",  
 "vBC": "10.00",  
 "pCOFINS": "7.6000",  
 "vCOFINS": "0.76"  
 }}  
 },  
 "infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "  
 },  
 "conteudoAuxiliar": {  
 "ICMSCred": {  
 "cst\_entrada": "60",  
 "indicador\_credito": "0",  
 "percentual\_credito": "0.00",  
 "valor\_base\_calculo": "0.00",  
 "valor\_credito": "0.00"  
 },  
 "ICMS\_Antecipacao": {  
 "tipo\_antecipacao": "2",  
 "encerra\_trib": "1",  
 "responsavel": "D",  
 "p\_red\_bc\_interna\_dest": "0.00",  
 "aliq\_interna\_dest": "18.0000",  
 "bc\_icms\_antecipacao": "17.0720",  
 "vigencia\_de": "2020-03-01",  
 "valor\_icms\_antecipacao": "1.87",  
 "mva": "70.72",  
 "mva\_ajustado": "0.00",  
 "mva\_lista\_positiva\_ajustado": "0.00",  
 "mva\_lista\_negativa\_ajustado": "0.00",  
 "mva\_lista\_neutra\_ajustado": "0.00"  
 },  
 "ICMS\_ANTECIPACAOCred": {  
 "indicador\_credito": "0",  
 "valor\_base\_calculo": "0.00",  
 "percentual\_credito": "0.00",  
 "valor\_credito": "0.00",  
 "dispositivo\_legal": "Art. 277 cc §5º do artigo 426-A do RICMS/SP",  
 "observacoes": "Observar as condições do §3º do artigo 277 do RICMS/SP: \\"O valor do imposto recolhido antecipadamente por meio de guia de recolhimentos especiais, nos termos do art. 426-A, deverá ser escriturada no LRAICMS\\"."  
 },  
 "IPICred": {  
 "cst\_entrada": "01",  
 "indicador\_credito": "0",  
 "valor\_base\_calculo": "0.00",  
 "percentual\_credito": "0.00",  
 "valor\_credito": "0.00",  
 "dispositivo\_legal": "Art. 226 do RIPI/2010"  
 },  
 "PISCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.17",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.637/2002",  
 "pPIS": "1.6500"  
 },  
 "COFINSCred": {  
 "cst\_entrada": "50",  
 "indicador\_credito": "1",  
 "valor\_base\_calculo": "10.00",  
 "percentual\_credito": "100.00",  
 "valor\_credito": "0.76",  
 "dispositivo\_legal": "Art. 3°, inciso I, da Lei 10.833/2003",  
 "pCOFINS": "7.6000"  
 },  
 "DispositivoLegal": {  
 "DispositivoLegalICMS": "Art. 22, I da Lei nº 1.287/2001. Art. 27, § 2º,II da Lei nº 1.287/2001",  
 "DispositivoLegalICMSST": null,  
 "DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",  
 "DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",  
 "DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"  
 }  
 }  
 }  
 \]  
}\]}

# Códigos do retorno

No retorno, para cada consulta feita, ou seja dentro de cada "item", existe o "status" que indica qual o resultado da chamada, se foi retornada com sucesso, se não foi localizada regra, entre outros.

Essas informações estão dispostas nas tags "cod" e "msg", que correspondem aos valores abaixo:

<table cellspacing="0" class="MsoTableGrid" id="bkmrk-%E2%80%9Ccod%E2%80%9D-%E2%80%9Cmsg%E2%80%9D-0-retorn"><tbody><tr><td>**“cod”**

</td><td>**“msg”**

</td></tr><tr><td>0

</td><td>Retornado com sucesso.

</td></tr><tr><td>2

</td><td>Código do produto não localizado na tabela.

</td></tr><tr><td>3

</td><td>Código do produto não informado.

</td></tr><tr><td>7

</td><td>Parâmetros insuficiente para essa requisição.

</td></tr><tr><td>8

</td><td>Regra não encontrada para o item.

</td></tr><tr><td>9

</td><td>Regra parcialmente aprovada.

</td></tr><tr><td>10</td><td>Regra sem CFOP de Entrada, Ausencia de Tributos Obrigatórios - PIS, Ausencia de Tributos Obrigatórios - COFINS, Regra com ST e Antecipação, Regra com CST diferente de 60</td></tr><tr><td>11</td><td>Falha de conexão com API do Regra online</td></tr><tr><td>998</td><td>Usuário ou senha invalidos</td></tr><tr><td>999

</td><td>Erro fatal.

</td></tr></tbody></table>