Descrição dos campos de retorno - API de resultado
| Campo | PAI | Descrição | Tipo |
|
continuationToken |
/ | Ponteiro utilizado para paginação | String |
|
data |
/ | Resultado em formato JSON | / |
|
success |
/ | Status do retorno | Boolean |
|
message |
/ | Mensagem do retorno | String |
|
record_count |
/ | Quantidade de registros retornados | Int32 |
Tabela de referência para os campos "success" e "message":
| Código de retorno | Sucesso | Mensagem | Descrição |
| 200 | true | null | Resultado gerado com sucesso |
| 401 | false | Unauthorized | Token informado inválido, em branco ou expirado |
Detalhamento do resultado:
Dos campos "id" até "extipi" constam os dados do cliente e a definição de perfil nas primeiras colunas:
Dos campos "nat_op" até "finalidade" constam os dados do cenário gerado á partir da definição dos perfis:
Dos campos "xProd" até "vOutro" também são relativos aos documentos do cliente, dados e valores dos produtos:
A partir do campos "nfE_CFOP" as informações são intercaladas sendo sempre “Cliente” – “Systax”. Todas as colunas com nome que se inicia com "nFe" são do cliente, e todas as colunas com nome que se inicia com "tax", são informações da regra Systax:
No início de cada bloco de tributo, existe um campo que indica quais campos tiveram divergências (diferenças_ICMS, diferenças_PIS, diferenças_COFINS e diferenças_IPI). No exemplo abaixo os campos "CST" e "cEnq" possuem diferenças no bloco do IPI, e por isso, foram informados no campo "Diferenças_IPI":
No final de cada bloco de tributo, existe um campo que informa o valor da diferença encontrada. Essa diferença é gerada comparando o valor do tributo do documento do cliente e o valor do tributo gerado pela Systax. No exemplo abaixo, caso houvesse diferenças no bloco do IPI, seria exibida no campo "valor_diferença_IPI":
