Skip to main content

Descrição dos campos de entrada e retorno

 

CampoCAMPO

PAI

DescriçãoDESCRIÇÃO

ididTributo

cenarios

Preenchimento padrão enviar esta tag. Este código será gerado e preenchido automaticamente pelo sistema Systax.

id_cliente

cenarios

ID do cliente

grupo_cache

cenarios

Preencher sempre comsendo "A"100" - IBS Master

apelido

cenarios

Descrição do cenário

dias_futuros

cenarios

Prenchimento padrão: "30". Refere-se à vigência da regra entregue.

ent_sai

cenarios

Tipo entrada/saída sendo "1"para Entradas e "3" para Saídas

cod_nat_op

cenarios

Código de natureza de operação

finalidade

cenarios

Código de finalidade

destinacao

cenarios

Perfil do destinatário

alternativo_ex_origem

cenarios

Perfil do remetente

uf_origem

cenarios

UF do remetente

uf_destino

cenarios

UF do destinatário

id_mun_origem

cenarios

Código IBGE do município do remetente - Preencher somente para municípios com tributação diferenciada (ex.: municípios localizados na ZFM e ALC).

uf_destino

cenarios

UF do destinatário

id_mun_destino

cenarios

Código IBGE do município do destinatário - Preencher somente para municípios com tributação diferenciada (ex.: municípios localizados na ZFM e ALC).

cnpj_ex_origemufEntrega

cenarios

Sigla da UF de entrega da

mercadoria

municipioEntrega

cenarios

Código de Município de entrega da operação. Deve ser utilizada a Tabela de código de Município mantida pelo IBGE disponível em: Tabela Códigos dos Municípios - IBGE

municipioExecucao

cenarios

Código de Município de execução da operação. Deve ser utilizada a Tabela de código de Município mantida pelo IBGE disponível em: Tabela Códigos dos Municípios - IBGE

perfilOrigem

cenarios

Perfil do remetente

cnae_origem

cenarios

CNPJ do remetente - Preencher somente se houver orientação específica do time Systax.

perfilDestino

cenarios

Perfil do destinatário

cnae_destinatario

cenarios

CNAE do destinatário - Preencher somente para casos de tributação por CNAE (ex.: operações com destino a MT ou CE).

prestador

cenarios

Perfil do prestador de um serviço

tomador

cenarios

Perfil do tomador de um serviço

executor

cenarios

Perfil do executor de um serviço

origem_produto_alternativo

cenarios

Preencher somente se houver orientação específica do time Systax.

cenario_ind_prod

cenarios

Uso interno Systax. Não preencher.

st_cest

cenarios

Uso interno Systax. Não preencher.

frequencia

cenarios

Preenchimento padrão:
"1" - Para cenários de Saída
"2" - Para cenários de Entrada

dias_futuros

cenarios

Prenchimento padrão: "30". Refere-se à vigência da regra entregue.

dt_criacao

cenarios

Não enviar esta tag. A data será preenchida automaticamente pelo sistema Systax.

grupos

cenarios

Preencher a tag, somente quando houver precisra incluir o cenário em um grupo de produtos.
Para mais de um grupo, separar por virgula, conforme exemplo abaixo.
“grupos”: ”Teste1,Teste2,Teste3”

IMPORTANTE: para os campos em que não for necessário o preenchimento, não enviar a tag ou enviar sem preenchimento.

 

Tabela de referência para o campo "ent_sai":

ent_sai

Descrição

1

Entrada

3

Saída

Tabela de referência para os campos "cod_nat_op", "finalidade", "destinacao" e "alternativo_ex_origem":

Para obter a tabela com os principais códigos dos campos acima, acesse a última versão de documentação no link: https://documentacao.systax.com.br/PublicView2/Index/c14f5c52f0b52073cdf05eb75/26445. Caso tenha alguma situação específica e não localize nas tabelas um código compatível com a necessidade, acione nosso time para que possamos lhe dar orientações assertivas.assertivas

Descrição dos campos de retorno

Campo

PAI

Descrição

success

/

Status do retorno

message

/

Mensagem do retorno

total_itens

/

Quantidade de cenários na chamada

total_ok

/

Quantidade de cenários cadastrados

position

itens_ok

Posição do cenário na chamada

id

itens_ok

ID do cenário cadastrado

total_error

/

Quantidade de cenários não cadastrados

position

itens_error

Posição do cenário na chamada

message

itens_error

Mensagem do retorno

Tabela de referência para os campos "success" e "message"

Código de retorno

success

message

200

true

OK

400

false
false

token_invalid
token_expired

500

false

internal_error