Resposta
Esta seção detalha o formato do JSON de retorno da API, incluindo informações de cabeçalho, grupos de tributação e produtos não retornados.
Retorno dos produtos#
{ "error": false, "mensagem": "OK", "cabecalho": { "cnpj": "81657641000115", "prod_env": 2, "prod_ret": 2, "prod_nao_ret": 0 }, "grupos": [ { "ncm": "20098990", "cest": "1701000", "pis_cofins": { "cst_ent_lp": "70", "cst_sai_lp": "1 ", "cst_ent": "50", "cst_sai": "1 ", "cst_ent_sn": "99", "cst_sai_sn": "49", "aliq_pis_ent": 1.65, "aliq_pis_sai": 1.65, "aliq_pis_ent_lp": 0.0, "aliq_pis_sai_lp": 0.65, "aliq_cofins_ent": 7.6, "aliq_cofins_sai": 7.6, "aliq_cofins_ent_lp": 0.0, "aliq_cofins_sai_lp": 3.0, "nri": "", "amp_legal": "", "red_pis_ent": 0.0, "red_pis_sai": 0.0, "red_cofins_ent": 0.0, "red_cofins_sai": 0.0 }, "ipi": { "cst_ent": "3 ", "cst_sai": "53", "aliq_ipi_ent": 0.0, "aliq_ipi_sai": 0.0, "codenq": "", "ex": "" }, "regras": [ { "ufs": [ { "uf": "SP", "cfop": { "cfop_code": "2403", "carac_trib": [ { "codigo_cenario_fiscal_id": 8, "cfop": "5405", "cst": "60", "csosn": "500", "desonerado": "S", "aliq_icms_interna": 0.0, "aliq_icms_interestadual": null, "reducao_bc_icms": 0.0, "reducao_bc_icms_st": 0.0, "red_bc_icms_interestadual": null, "aliq_icms_st": 0.0, "iva": null, "iva_ajust": null, "iva_ajust_4": 63.9, "iva_ajust_7": null, "iva_ajust_12": 50.24, "fcp": 0.0, "cod_benef": " ", "p_difer": null, "p_isencao": null, "picms_deson": 0.0, "mot_des_icms": "", "isento": "N", "inf_pdv": { "picms_pdv": 0.0, "simb_pdv": "F", "cst_icms": "60", "csosn": "500", "cst_ent": "50", "cst_sai": "1 ", "aliq_pis_ent": 1.65, "aliq_pis_sai": 1.65, "aliq_cofins_ent": 7.6, "aliq_cofins_sai": 7.6 } } ] }, "mensagem": "" } ] } ], "prod_ean": ["0763331023765"], "prod_cod_interno": [] }, { "ncm": "16041310", "cest": "1708100", "pis_cofins": { "cst_ent_lp": "70", "cst_sai_lp": "1 ", "cst_ent": "50", "cst_sai": "1 ", "cst_ent_sn": "99", "cst_sai_sn": "49", "aliq_pis_ent": 1.65, "aliq_pis_sai": 1.65, "aliq_pis_ent_lp": 0.0, "aliq_pis_sai_lp": 0.65, "aliq_cofins_ent": 7.6, "aliq_cofins_sai": 7.6, "aliq_cofins_ent_lp": 0.0, "aliq_cofins_sai_lp": 3.0, "nri": "", "amp_legal": "", "red_pis_ent": 0.0, "red_pis_sai": 0.0, "red_cofins_ent": 0.0, "red_cofins_sai": 0.0 }, "ipi": { "cst_ent": "3 ", "cst_sai": "53", "aliq_ipi_ent": 0.0, "aliq_ipi_sai": 0.0, "codenq": "", "ex": "" }, "regras": [ { "ufs": [ { "uf": "SP", "cfop": { "cfop_code": "2403", "carac_trib": [ { "codigo_cenario_fiscal_id": 8, "cfop": "5405", "cst": "60", "csosn": "500", "desonerado": "S", "aliq_icms_interna": 0.0, "aliq_icms_interestadual": null, "reducao_bc_icms": 0.0, "reducao_bc_icms_st": 0.0, "red_bc_icms_interestadual": null, "aliq_icms_st": 0.0, "iva": null, "iva_ajust": null, "iva_ajust_4": 58.05, "iva_ajust_7": null, "iva_ajust_12": 44.88, "fcp": 0.0, "cod_benef": " ", "p_difer": null, "p_isencao": null, "picms_deson": 0.0, "mot_des_icms": "", "isento": "N", "inf_pdv": { "picms_pdv": 0.0, "simb_pdv": "F", "cst_icms": "60", "csosn": "500", "cst_ent": "50", "cst_sai": "1 ", "aliq_pis_ent": 1.65, "aliq_pis_sai": 1.65, "aliq_cofins_ent": 7.6, "aliq_cofins_sai": 7.6 } } ] }, "mensagem": "" } ] } ], "prod_ean": ["7894321811277"], "prod_cod_interno": [] } ], "sem_retorno": []}Descrição dos Campos#
Cabeçalho#
| Campo | Descrição |
|---|---|
cnpj | CNPJ do cliente |
prod_env | Quantidade de produtos enviados na requisição |
prod_ret | Quantidade de produtos retornados pela API |
prod_nao_ret | Quantidade de produtos não retornados pela API |
Grupos#
| Campo | Descrição |
|---|---|
ncm | Código NCM do produto |
cest | Código da Substituição Tributária |
grupos.pis_cofins#
| Campo | Descrição |
|---|---|
cst_ent_lp | CST de entrada (Lucro Presumido) |
cst_sai_lp | CST de saída (Lucro Presumido) |
cst_ent | CST de entrada (Lucro Real) |
cst_sai | CST de saída (Lucro Real) |
cst_ent_sn | CST de entrada (Simples Nacional) |
cst_sai_sn | CST de saída (Simples Nacional) |
aliq_pis_ent | Alíquota PIS (entrada, Lucro Real) |
aliq_pis_sai | Alíquota PIS (saída, Lucro Real) |
aliq_pis_ent_lp | Alíquota PIS (entrada, Lucro Presumido) |
aliq_pis_sai_lp | Alíquota PIS (saída, Lucro Presumido) |
aliq_cofins_ent | Alíquota Cofins (entrada, Lucro Real) |
aliq_cofins_sai | Alíquota Cofins (saída, Lucro Real) |
aliq_cofins_ent_lp | Alíquota Cofins (entrada, Lucro Presumido) |
aliq_cofins_sai_lp | Alíquota Cofins (saída, Lucro Presumido) |
nri | Natureza de Receita Isenta |
amp_legal | Amparo legal relacionado ao PIS/COFINS |
red_pis_ent | % de redução da base de cálculo do PIS (entrada) |
red_pis_sai | % de redução da base de cálculo do PIS (saída) |
red_cofins_ent | % de redução da base de cálculo do Cofins (entrada) |
red_cofins_sai | % de redução da base de cálculo do Cofins (saída) |
grupos.ipi#
| Campo | Descrição |
|---|---|
cst_ent | CST de entrada do IPI |
cst_sai | CST de saída do IPI |
aliq_ipi_ent | Alíquota de IPI (entrada) |
aliq_ipi_sai | Alíquota de IPI (saída) |
codenq | Código de enquadramento do IPI |
ex | Código de exceção (TIPI) |
grupos.regras.ufs#
| Campo | Descrição |
|---|---|
uf | Unidade Federativa |
mensagem | Observação ou alerta da regra fiscal |
grupos.regras.ufs.carac_trib#
| Campo | Descrição |
|---|---|
codigo_cenario_fiscal_id | ID do cenário fiscal retornado |
cfop | CFOP aplicado para operações na mesma UF |
cst | CST padrão para NFe/NFCe |
csosn | CSOSN padrão para NFe/NFCe |
desonerado | Indica desoneração (“S”/“N”) |
aliq_icms_interna | Alíquota de ICMS interno |
aliq_icms_interestadual | Alíquota de ICMS interestadual |
reducao_bc_icms | % de redução da base de cálculo do ICMS |
reducao_bc_icms_st | % de redução da base de cálculo do ICMS-ST |
red_bc_icms_interestadual | % de redução de BC interestadual |
aliq_icms_st | Alíquota de ICMS ST |
iva | Índice de Valor Agregado (IVA) |
iva_ajust | IVA ajustado geral |
iva_ajust_4 | IVA ajustado a 4% |
iva_ajust_7 | IVA ajustado a 7% |
iva_ajust_12 | IVA ajustado a 12% |
fcp | Alíquota de FCP |
cod_benef | Código de benefício fiscal |
p_difer | % de diferimento de ICMS |
p_isencao | % de isenção de ICMS |
picms_deson | % de ICMS desonerado |
mot_des_icms | Motivo da desoneração do ICMS |
isento | Indica isenção da regra estadual (“S”/“N”) |
grupos.regras.ufs.carac_trib.protocolo#
| Campo | Descrição |
|---|---|
prot_nome | Nome do protocolo |
descricao | Descrição do protocolo |
grupos.regras.ufs.carac_trib.inf_pdv#
| Campo | Descrição |
|---|---|
picms_pdv | Alíquota efetiva de ICMS para PDV |
simb_pdv | Simbologia do ICMS para PDV |
cst_icms | CST do ICMS no PDV |
csosn | CSOSN aplicado no PDV |
cst_ent | CST de entrada no PDV |
cst_sai | CST de saída no PDV |
aliq_pis_ent | Alíquota de PIS (entrada) para PDV |
aliq_pis_sai | Alíquota de PIS (saída) para PDV |
aliq_cofins_ent | Alíquota de Cofins (entrada) para PDV |
aliq_cofins_sai | Alíquota de Cofins (saída) para PDV |
Layout da Entidade produtos#
Os produtos que não forem retornados serão contabilizados em prod_nao_ret, permanecendo na fila de revisão do analista da Nexos 360. Após a correção, poderão ser consultados novamente, ação descria no menu Consulta Revisados.