Manual Cockpit API (Bearer)
Manual contendo as últimas atualizações efetuadas em 13/11/2024.
- Introdução
- Acesso
- Autenticação
- API Leitura de regras
- Ponteiro de atualização e paginação
- Informações retornadas pelo systax_erp
- Grupo "systax_ret"
- Grupo "cenario"
- Grupo "produtos"
- Grupo "retorno"
- Grupo "icms_st"
- Grupo "icms_uf_dest"
- Grupo "credito_icms"
- Grupo "icms_antecipacao"
- Grupo "credito_icms_antecipacao"
- Grupo "credito ipi"
- Grupo "pis"
- Grupo "credito_pis"
- Grupo "cofins"
- Grupo "credito_cofins"
- API Leitura de regras de Serviços
- Informações retornadas pelo systax_erp nas regras de Serviços
- Informações técnicas
Introdução
A API de leitura de regras tem por objetivo retornar as regras tributárias aprovadas diretamente do Cockpit.
Acesso
Comunicação: REST/JSON
Para acessar a coleção de chamadas Clique Aqui.
Listagem dos Endpoints que contemplam o manual de leitura de regras
|
Descrição |
Versão |
Grupo Swagger |
Método |
URL Endpoint |
URL Token |
|
API de leitura de regras |
v2 |
Cockpit - API V2 - Produção |
POST |
||
|
API de Leitura de regras de Serviços |
v2 |
Cockpit - API V2 - Produção |
POST |
https://api-gateway.systax.com.br/cockpit/v2/api/regras/servicos |
Link documentação técnica e teste: https://api-portal.systax.com.br/.
Obs: Entre em contato com o time de Integração da Systax (e-mail: integracao@systax.com.br) para obter as credenciais de acesso ao Portal de API e acesse a API destacada abaixo:
Autenticação
A autenticação da API de leitura de regras do Cockpit é feita via bearer token. Para mais detahes de como obtê-la, acesse a última versão de documentação no link: https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token
API Leitura de regras
Objetivo: Retornar as regras aprovadas do Cockpit.
Método: POST
API Rest / Json: https://api-gateway.systax.com.br/cockpit/v2/api/regras
Descrição dos campos de chamada e Retorno
Chamada
|
Campo |
PAI |
Descrição |
Obrigatório |
|
id_cenario |
/ |
Informar 0 ou 1 para iniciar o processo de leitura. A partir da segunda chamada do processo, informar o último "id_cenario" retornado na resposta da chamada anterior. |
Não |
|
codigo_produto |
/ |
Informar 0 ou 1 para iniciar o processo de leitura. A partir da segunda chamada do processo, informar o "cod_prod" do último produto retornado na resposta da chamada anterior. |
Não |
|
origem_produto |
/ |
Informar 0 ou 1 para iniciar o processo de leitura. A partir da segunda chamada do processo, informar a "origem_produto" do último produto retornado na resposta da chamada anterior. |
Não |
|
paginacao |
/ |
Quantidade de registros/regras a serem entregues por página. Limite máximo 100. |
Não |
|
ponteiro_atualizacao |
/ |
Ponteiro do controle de atualização. |
Não |
|
|
|||
|
-Para carga inicial (recebimento de todas as regras), informar 0 ou 1. |
|||
|
|
|||
|
-Para atualizações, informar o ponteiro retornado na primeira chamada do dia anterior (ou o ponteiro retornado na primeira chamada do processo anterior, caso seja realizado mais de um processo de leitura por dia). |
|||
|
|
|||
|
Vide orientações detalhadas no item Ponteiro de atualização e Paginação. |
Retorno
|
Campo |
PAI |
Descrição |
|
ponteiro_atualizacao |
/ |
Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo |
|
origem |
/ |
Valor fixo "Systax". |
|
sistema |
/ |
Valor fixo "Cockpit". |
|
cod_status |
status |
Código de retorno |
|
msg_status |
status |
Mensagem de retorno |
|
cenario |
|
O detalhamento do retorno a partir deste campo está disponível no item Informações retornadas pelo systax_erp. |
|
cod_status |
msg_status |
|
0 |
Sucesso |
|
1 |
LoginSenhaInvalido |
|
8 |
UsuarioSemCliente |
|
9 |
ClienteSemConnectionString |
|
10 |
FalhaNaAplicacao |
Exemplos de chamada e retorno
Chamada
{
"id_cenario": "0",
"codigo_produto": "0",
"origem_produto": "0",
"paginacao": 100,
"ponteiro_atualizacao": "0"
}
Retorno
{
"cenario": [
{
"ent_sai": "1",
"id_cenario": "292613",
"apelido": "Compra-SP-SP-Industria-Varejo--569",
"dias_futuros": "30",
"grupo_produtos": "Industria - Varejo - SP - SP, Compra Origem 2 - SP_SP, compra origem 0 -SP-SP, SP-SP-120-1-140-569",
"uf_origem": "SP",
"uf_destino": "SP",
"origem": "1",
"destinacao": "140",
"cod_natureza_operacao": "120",
"finalidade": "569",
"retorno": [
{
"cod_prod": "892478",
"descricao": "VENTILADOR DE TETO BRAVO",
"ean": "7898140448379",
"ncm": "84145990",
"origem_produto": "0",
"grupo_produto_associado": "SP-SP-120-1-140-569",
"cfop": "5401",
"cfop_entrada": "1403",
"cest": "2108800",
"icms": {
"cst": "10",
"bc_composicao": 2,
"bc_composicao_sn_especial": 0,
"bc_composicao_fcp": 0,
"aliquota": "18.0000",
"vigencia_de": "2001-01-01T00:00:00",
"dispositivo_legal": "art. 37, I, e § 1º do RICMS/SP. art. 52, I do RICMS/SP",
"inf_adicionais": "Arts. 313-Z 19 do RICMS/SP c/c Portaria SER n º 59/2023. art. 37, I, e § 1º do RICMS/SP. art. 52, I do RICMS/SP.",
"icms_st": {
"bc_composicao": 62,
"bc_composicao_fcp": 0,
"aliquota_st": "18.0000",
"mva": "49.00",
"vigencia_de": "2023-10-01T00:00:00",
"dispositivo_legal": "Arts. 313-Z 19 do RICMS/SP c/c Portaria SER n º 59/2023. art. 52, I do RICMS/SP"
},
"estatistica": "Z01|"
},
"credito_icms": {
"indicador_credito": 0,
"cst_entrada": "60",
"vigencia_de": "2001-01-01T00:00:00",
"dispositivo_legal": "Arts. 59, 61 e 272 do RICMS-SP.",
"observacoes": "Observar as condições previstas no parágrafo único do art. 272 do RICMS-SP"
},
"ipi": {
"cst": "51",
"cenq": "999",
"bc_composicao": 0,
"generico": "ipi_cenq=999",
"vigencia_de": "2022-08-01T00:00:00",
"dispositivo_legal": "Art. 190 do RIPI/2010 c/c Decreto nº 11.158/2022",
"estatistica": "B05|B07"
},
"credito_ipi": {
"indicador_credito": 0,
"cst_entrada": "01",
"vigencia_de": "2010-06-25T00:00:00",
"dispositivo_legal": "Art. 226 do RIPI/2010"
},
"pis": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "1.6500",
"vigencia_de": "2002-12-01T00:00:00",
"dispositivo_legal": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
},
"credito_pis": {
"indicador_credito": 1,
"cst_entrada": "50",
"percentual_credito": "100.0000",
"vigencia_de": "2002-12-01T00:00:00",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.637/2002"
},
"cofins": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "7.6000",
"vigencia_de": "2004-02-01T00:00:00",
"dispositivo_legal": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003"
},
"credito_cofins": {
"indicador_credito": 1,
"cst_entrada": "50",
"percentual_credito": "100.0000",
"vigencia_de": "2004-02-01T00:00:00",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.833/2003"
}
}
]
}
],
"ponteiro_atualizacao": "20241112172839",
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}
Ponteiro de atualização e paginação
Criamos um video para exemplificar os conceitos descritos neste tópico. Sugerimos que, após a leitura, assista este vídeo para melhor compreensão.
Após a carga inicial das regras geradas pela Systax, o uso do recurso "Ponteiro de Atualização" permitirá chamar a API e receber somente as atualizações, ou seja, somente as regras novas (de novos produtos ou novas operações cadastrados) ou regras já entregues que sofreram alguma atualização.
A API entrega as regras ordenando-as por sequência númerica de cenário e, dentro de cada cenário, também ordena os produtos por sequência númerica. Assim, imagine que um cliente tem os cenários 1 e 2 e também os produtos 1, 2 e 3. Neste exemplo, a entrega das regras será ordenada da seguinte forma:
Id_cenário: 1 [
codigo_produto: 1
codigo_produto: 2
codigo_produto: 3
Id_cenário: 2 [
codigo_produto: 1
codigo_produto: 2
codigo_produto: 3
Assim, os campos da chamada deverão ser preenchidos da seguinte forma:
codigo_produto: A primeira chamada de cada processo de atualização será sempre com o menor código de produto existente ou com "1" (já que não existirá código menor que este, a API entregará o primeiro existente). A partir da segunda chamada, deverá ser informado sempre o último código de produto recuperado na resposta da chamada anterior, ou seja, na segunda chamada do dia (pressupondo um processo diário de atualização) é preciso informar o último produto retornado na resposta da primeira, já na terceira chamada é preciso informar o último produto retornado na resposta segunda e assim sucessivamente.
id_cenario: A primeira chamada de cada processo de atualização será sempre com o menor código de cenário existente ou por "1". A partir da segunda chamada, deverá ser informado sempre o último código de cenário recuperado na resposta da chamada anterior, ou seja, na segunda chamada é preciso informar o último cenário retornado na resposta da primeira, na terceira chamada é preciso informar o último cenário retornado na resposta segunda e assim sucessivamente. Vale lembrar que, dentro de uma página de dados, poderá ou não ocorrer a troca de cenários (fim dos dados de um cenário e início dos dados de outro).
paginacao: Limitada a 100 registros recuperados por “página” de resposta. Para obtenção de mais de 100 registros é necessário realizar mais requisições.
ponteiro_atualizacao: Informar o ponteiro capturado na resposta da primeira requisição do dia anterior (supondo atualizações diárias). Ressaltamos: não é o ponteiro da resposta obtida na requisição anterior e sim na “primeira” requisição do processo anterior (conjunto de requisições executados em data anterior).
Destacamos: A “paginação” de 100 em 100 registros é controlada pelo id_cenário e pelo código do produto e não pelo ponteiro_atualizacao (que serve apenas como “filtro” de seleção dos registros novos). Durante todo o processo (conjunto de requisições) o ponteiro_atualizacao deve permanecer o mesmo. Deve-se armazenar o ponteiro_atualizacao entregue na primeira página de dados do processo (início da lista de atualização), para que seja utilizado como parâmetro da atualização seguinte (no dia seguinte, quando o processo for diário por exemplo). Importante: Armazene o primeiro ponteiro do dia e não o último, pois durante o processo de leitura é possível que dados de sua base estejam sendo atualizados concomitantemente.
Exemplo de uma atualização em lote com caso de 220 registros atualizados (de um único cenário):
- 1ª Requisição: Retorna os 100 primeiros registros (registros 1 a 100). Retornará também a tag “ponteiro_atualizacao” preenchida com um novo valor de ponteiro, que deverá ser armazenado para utilização em todas as chamadas do próximo processo de atualização (no dia seguinte, p.ex.).
- 2ª Requisição: Deve ser alterado apenas os parâmetros de entrada “codigo_produto” e "id_cenario", informando os últimos retornados na 1ª requisição, com isso o sistema retornará 100 registros a partir daquele último informado (registros 100 a 199);
- 3ª Requisição: Assim como na 2ª requisição, devem ser alterados apenas os parâmetros de entrada “codigo_produto” e "id_cenario", informando os últimos códigos recebidos na resposta da 2ª requisição. Neste exemplo, o sistema retornará os últimos 22 registros do conjunto de 220 (registros 199 a 220).
No exemplo acima foram utilizadas 3 requisições para se obter 220 registros, porém esse processo deve ser repetido várias vezes, até que chegue ao final de toda atualização, que será percebido quando uma requisição retornar menos de 100 registros (isso considerando que o parâmetro “paginacao” esteja preenchido com "100", senão o processo encerrá assim que o número de regras entregues for menor que o número informado como parâmetro de "paginacao").
Informações retornadas pelo systax_erp
Grupo "systax_ret"
|
Tag |
Pai |
Descrição |
Tipo |
Obrigatório |
|
origem |
systax_ret |
Valor fixo “Systax”. |
Texto com valor fixo “Systax”. |
Sim |
|
sistema |
systax_ret |
Sistema utilizado para a obtenção das informações. Valor fixo “ERP”. |
Texto com nome do sistema. Exemplo: “ERP” |
Sim |
|
status |
systax_ret |
Situação de requisição. Retorna duas tags: cod_status e msg_status, consulte a tabela de códigos de status para mais informações. |
Numérico (1 digito). |
Sim |
|
cenário |
systax_ret |
Informações de retorno do cenário. |
Campo de agrupamento dos dados cenário (tag nó do xml). |
Sim |
|
ponteiro_atualizacao |
systax_ret |
Informação do tipo “integer”. Deverá ser preservado pelo cliente e enviado na próxima chamada caso se deseje receber somente informações novas. Ignorando essa informação, todo o conteúdo será reenviado. |
Numérico (15 digitos). |
Sim |
Grupo "cenario"
|
Tag |
Pai |
Descrição |
Tipo |
Obrigatório |
|
id_cenario |
cenario |
Id do cenário. |
Numérico (7 digitos) |
Sim |
|
id_cenario_principal |
cenario |
Id do cenário principal. |
Numérico (7 digitos) |
Não |
|
apelido |
cenario |
Identificação do cenário. |
Texto (50 caracteres) |
Não |
|
dias_futuros |
cenario |
Indicar a quantidade de dias futuros a ser analisada a legislação. |
Numérico (3 digitos) |
Não |
|
grupo_produtos |
cenario |
Nome dos grupos de produtos associados a esse cenário. |
Texto (50 caracteres), *com separador “, ” (vírgula-espaço) |
Não |
|
uf_origem |
cenario |
Sigla da UF de origem da mercadoria. |
Texto (2 caracteres) |
Sim |
|
uf_destino |
cenario |
Sigla da UF de destino da mercadoria. |
Texto (2 caracteres) |
Sim |
|
origem |
cenario |
Perfil do estabelecimento remetente da operação. Para verificar os códigos, veja a tabela “Remetente”. |
Texto (120 caracteres, podendo ter a vírgula como separador) |
Sim |
|
destinação |
cenario |
Perfil do estabelecimento remetente da operação. Para verificar os códigos, veja a tabela “Destinação”. |
Texto (120 caracteres, podendo ter a vírgula como separador) |
Sim |
|
cod_natureza_operacao |
cenario |
Código da natureza da operação. Para verificar os códigos, veja a tabela “Natureza de Operações”. |
Numérico (3 digitos) |
Sim |
|
município_origem |
cenario |
Numérico (7 digítos) |
Não |
|
|
município_destino |
cenario |
Numérico (7 digítos) |
Não |
|
|
cnae_destinatario |
cenario |
Numérico (7 dígitos) |
Não |
|
|
ent_sai |
cenario |
Indicação do tipo da operação: |
Texto (27 caracteres) |
Não |
|
finalidade |
cenario |
Código que indica a finalidade do produto, qual a destinação desse produto. Para verificar os códigos, veja a tabela “Natureza de Operações – Utilizado no campo “natureza_operacao”. |
Numérico (3 dígitos) |
Não |
|
retorno |
cenario |
Grupo de informações retomadas para cada produto. |
Campo de agrupamento dos dados de retorno (tag nó do xml) |
Sim |
Grupo "produtos"
|
Tag |
Pai |
Descrição |
Tipo |
Obrigatório |
|
cod_prod |
retorno |
Código do produto. |
Texto (50 caracteres) |
Sim |
|
descricao |
retorno |
Descrição do produto. |
Texto (120 caracteres) |
Não |
|
ncm |
retorno |
Código do produto conforme a Nomenclatura Comum do Mercosul – Tabela oficial. Código de 8 dígitos. |
Numérico (8 dígitos) |
Sim |
|
ex_tipi |
retorno |
Código do produto conforme a Nomenclatura Comum do Mercosul (Exceção) – Tabela oficial. Código de 2 ou 3 dígitos. |
Numérico (3 dígitos) |
Não |
|
origem_produto |
retorno |
Origem da Mercadoria ou Serviço – Tabela oficial. |
Numérico (1 digito) |
Não |
|
grupo_produto_associado |
retorno |
Grupo de produtos associado a esse cenário e que de fato o produto está inserido. |
Texto (50 caracteres), *com separador “;” (ponto e vírgula) |
Não |
|
cfop |
retorno |
Código CFOP (Código Fiscal de Operação e Prestação) – Tabela oficial. |
Numérico (4 dígitos) |
Sim |
|
cfop_entrada |
retorno |
Código CFOP (Código Fiscal de Operação e Prestação) – Tabela oficial. |
Numérico (4 dígitos) |
Não |
|
cest |
retorno |
Código Especificador da Substituição Tributária – Identifica mercadorias e bens passíveis de antecipação e de substituição tributária. |
Numérico (7 dígitos) |
Não |
|
icms |
retorno |
Grupo de informações de ICMS e ICMS/ST. |
Campo de agrupamento dos dados de icms (tag nó do xml) |
Sim |
|
icms_antecipacao |
retorno |
Grupo de informações de Antecipação do ICMS. |
Campo de agrupamento dos dados de icms_antecipacao (tag nó do xml) |
Não |
|
credito_icms |
retorno |
Grupo de informações do crédito do ICMS. |
Campo de agrupamento dos dados de credito_icms (tag nó do xml) |
Não |
|
credito_icms_antecipacao |
retorno |
Grupo de informações de Antecipação do Crédito do ICMS. |
Campo de agrupamento dos dados de credito_icms_antecipacao (tag nó xml) |
Não |
|
ipi |
retorno |
Grupo de informações do IPI. |
Campo de agrupamento dos dados de ipi (tag nó do xml) |
Não |
|
credito_ipi |
retorno |
Grupo de informações do Crédito do IPI. |
Campo de agrupamento dos dados de credito_ipi (tag nó do xml) |
Não |
|
pis |
retorno |
Grupo de informações do PIS. |
Campo de agrupamento dos dados de pis (tag nó do xml) |
Sim |
|
credito_pis |
retorno |
Grupo de informações do Crédito do PIS. |
Campo de agrupamento dos dados de credito_pis (tag nó do xml) |
Não |
|
cofins |
retorno |
Grupo de informações do COFINS. |
Campo de agrupamento dos dados de cofins (tag nó do xml) |
Sim |
|
credito_cofins |
retorno |
Grupo de informações do Crédito do COFINS. |
Campo de agrupamento dos dados de credito_cofins (tag nó do xml) |
Não |
Grupo "retorno"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
cst |
icms |
Código de Situação Tributária e Código de Situação da Operação – Simples Nacional – CSOSN. |
Numérico (3 dígitos) |
Sim |
|
bc_composicao |
icms |
Código do indicador da fórmula para determinação da base de cálculo e valor do ICMS. |
Numérico (3 dígitos) |
Não |
|
bc_composicao_fcp |
icms |
Código do indicador da fórmula para determinação da base de cálculo e valor do FCP. |
Numérico (3 dígitos) |
Não |
|
bc_composicao_sn_especial |
icms |
Código do indicador da fórmula para determinação da base de cálculo e valor do ICMS, caso o contribuinte não fosse enquadrado no Simples Nacional. |
Numérico (3 dígitos) |
Não |
|
p_red_bc |
icms |
Percentual de redução de base de cálculo. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
percentual_diferimento |
icms |
Percentual do imposto diferido. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota |
icms |
Alíquota (em %). Se a operação for passível de Fundo de Combate a Pobreza, o percentual de alíquota virá acrescido do percentual relativo ao FCP. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota_desonerada |
icms |
Alíquota (em %), incidente caso a operação fosse tributada. Deve ser utilizada para fins de cálculo do valor do ICMS desonerado (campo vICMSDeson da NF-e). |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota_cf |
icms |
Alíquota da mercadoria na venda para consumidor final, já incluído FCP (em %), quando houver. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota_sn_especial |
icms |
Alíquota que seria aplicável, caso o contribuinte não fosse enquadrado no Simples Nacional (em %). |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
fcp |
icms |
Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) embutido na alíquota (tag aliquota e aliquota_desonerada) correspondente ao fundo. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
valor_pauta |
icms |
Valor da pauta. Valor utilizado para determinação do valor da base de cálculo do imposto. |
Numérico (16 dígitos, sendo 2 casas decimais) |
Não |
|
unidade_pauta |
icms |
Unidade de medida utilizada pela legislação para indicar um valor de pauta específico. |
Texto (3 caracteres) |
Não |
|
dif_aliq_nao_contrib |
icms |
Percentual de diferencial de alíquotas. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
generico |
icms |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico” |
Texto (200 caracteres)Obs. Informações separadas por “;”, caso haja a combinação de mais de uma informação diferente. |
Não |
|
vigencia_de |
icms |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Sim |
|
vigência_ate |
icms |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
icms |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observações |
icms |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres)Exemplo: Observar as condições previstas na Lei nº XX.XXX/XXXX |
Não |
|
inf_adicionais |
|
Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. |
Texto (200 caracteres) |
Não |
|
estatistica |
Icms |
Código indicador do campo que sofreu alteração em relação ao último retorno de tributação. É aceita lista de códigos, separados por pipe. |
Texto (100 caracteres) |
Não |
|
severidade |
icms |
Este campo poderá ser utilizado para destacar alterações que provoquem maior impacto no resultado da tributação. O preenchimento indicará o nível de severidade, de menor (zero) até o maior (5). |
Numérico (1 dígito) |
Não |
Grupo "icms_st"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
bc_composicao |
icms_st |
Fórmula para determinação da base de cálculo do retido e valor do ICMS retido. |
Numérico (3 dígitos) |
Não |
|
bc_composicao_fcp |
icms_st |
Código do indicador da fórmula para determinação da base de cálculo e valor do FCP. |
Numérico (3 dígitos) |
Não |
|
p_red_bc_st |
icms_st |
Percentual de redução de base de cálculo do imposto retido. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota_st |
icms_st |
Alíquota (em %). Se a operação for passível de Fundo de Combate a Pobreza, o percentual de alíquota virá acrescido do percentual relativo ao FCP. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
fcp |
icms_st |
Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) embutido na alíquota (tag alíquota_st) correspondente ao fundo. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
carga_media |
icms_st |
Percentual utilizado para o cálculo (ST). Esse percentual é informado apenas nos casos de mercadoria destinada ao MT. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva |
icms_st |
Percentual de Margem de Valor Agregado (original). Será utilizado no cálculo da substituição tributária quando os demais campos mva_ajustado, mva_lista_positiva_ajustado, mva_lista_negativa_ajustado, mva_lista_neutra_ajustado estiverem vazios. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_ajustado |
icms_st |
Percentual de Margem de Valor Agregado (ajustado). Será utilizado no cálculo da substituição tributária quando estiver preenchido (nem toda operação interestadual prevê ajuste de MVA).. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_lista_positiva_ajustado |
icms_st |
Percentual de Margem de Valor Agregado de produtos da lista positiva (ajustado). Somente para produtos farmacêuticos e medicamentos. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_lista_negativa_ajustado |
icms_st |
Percentual de Margem de Valor Agregado de produtos da lista negativa (ajustado). Somente para produtos farmacêuticos e medicamentos. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_lista_neutra_ajustado |
icms_st |
Percentual de Margem de Valor Agregado de produtos da lista neutra (ajustado). Somente para produtos farmacêuticos e medicamentos. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
valor_pauta |
icms_st |
Valor da pauta (em R$). Utilizado para base de cálculo do imposto. |
Numérico (16 dígitos, sendo 2 casas decimais) |
Não |
|
unidade_pauta |
icms_st |
Unidade de medida utilizada pela legislação para indicar um valor de pauta específico. |
Texto (3 caracteres) |
Não |
|
generico |
icms_st |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico” |
Texto (200 caracteres) |
Não |
|
vigência_de |
icms_st |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Não |
|
vigência_ate |
icms_st |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
icms_st |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Não |
|
observacoes |
icms_st |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
|
estatistica |
icms_st |
Código indicador do campo que sofreu alteração em relação ao último retorno de tributação. É aceita lista de códigos, separados por pipe. |
Texto (100 caracteres) |
Não |
|
severidade |
icms_st |
Este campo poderá ser utilizado para destacar alterações que provoquem maior impacto no resultado da tributação. O preenchimento indicará o nível de severidade, de menor (zero) até o maior (5). |
Numérico (1 dígito) |
Não |
Grupo "icms_uf_dest"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
cst |
icms_uf_dest |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Não |
|
alíquota |
Icms_uf_dest |
Alíquota (em %). |
Numérico (8 dígitos, sendo 4 casas decimais) |
|
|
bc_composicao |
icms_uf_dest |
Código do indicador da fórmula para determinação da base de cálculo e valor do ICMS. |
Numérico (3 dígitos) |
Não |
|
bc_composicao_fcp |
icms_uf_dest |
Código do indicador da fórmula para determinação da base de cálculo e valor do FCP. |
Numérico (3 dígitos) |
Não |
|
p_red_bc |
icms_uf_dest |
Percentual de redução de base de cálculo. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
fcp |
icms_uf_dest |
Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF_destino. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
perc_partilha_dest |
icms_uf_dest |
Percentual provisório de partilha do ICMS interestadual. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
valor_pauta |
icms_uf_dest |
Valor da pauta. Valor utilizado para determinação do valor da base de cálculo do imposto. |
Numérico (16 dígitos, sendo 2 casas decimais). |
Não |
|
unidade_pauta |
icms_uf_dest |
Unidade de medida utilizada pela legislação para indicar um valor de pauta específico. |
Texto (3 caracteres) |
Não |
|
generico |
icms_uf_dest |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigência_de |
icms_uf_dest |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Sim |
|
vigência_ate |
icms_uf_dest |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa). |
Não |
|
dispositivo_legal |
icms_uf_dest |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
icms_uf_dest |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
Grupo "credito_icms"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
indicador_credito |
credito_icms |
Indicação se há ou não crédito e forma de sua apropriação. Vide tabela “indicador_credito” |
Numérico (3 dígitos) |
Sim |
|
cst_entrada |
credito_icms |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Não |
|
percentual_credito |
credito_icms |
Percentual de crédito a ser apropriado. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
generico |
credito_icms |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigência_de |
credito_icms |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Não |
|
vigência_ate |
credito_icms |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
credito_icms |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
credito_icms |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
Grupo "icms_antecipacao"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
tipo_antecipacao |
icms_antecipacao |
Tipo de antecipação. Vide tabela “tipo_antecipacao”. |
Numérico (3 dígitos) |
Sim |
|
encerra_trib |
icms_antecipacao |
Encerramento da tributação, sendo: |
Numérico (1 dígito) |
Não |
|
responsavel |
icms_antecipacao |
Indicação do responsável pelo recolhimento do imposto antecipado, sendo: |
Texto (1 dígito) |
Não |
|
bc_composicao_fcp |
icms_antecipacao |
Código do indicador da fórmula para determinação da base de cálculo e valor do FCP. |
Numérico (3 dígitos) |
Não |
|
p_red_bc_interna_dest |
icms_antecipacao |
Percentual de redução de base de cálculo da UF de destino da operação. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliq_interna_dest |
icms_antecipacao |
Alíquota interna da UF de destino da operação. Se houver FCP será informado acrescido da alíquota. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
fcp |
icms_antecipacao |
Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) embutido na alíquota (tag aliq_interna_dest) correspondente ao fundo. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
perc_fixo |
icms_antecipacao |
Percentual fixo. Utilizado para apuração da base de cálculo do imposto. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
carga_media |
icms_antecipacao |
Percentual utilizado para cálculo da antecipação conforme CNAE destinatário, nas operações destinada ao Mato Grosso. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva |
icms_antecipacao |
Percentual de Margem de Valor Agregado (original). Será utilizado no cálculo da antecipação quando os demais campos mva_ajustado, mva_lista_positiva_ajustado, mva_lista_negativa_ajustado, mva_lista_neutra_ajustado estiverem vazios. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_ajustado |
icms_antecipacao |
Percentual de Margem de Valor Agregado (ajustado). |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_lista_positiva_ajustado |
icms_antecipacao |
Percentual de Margem de Valor Agregado de produtos da lista positiva (ajustado). Somente para produtos farmacêuticos e medicamentos. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_lista_negativa_ajustado |
icms_antecipacao |
Percentual de Margem de Valor Agregado de produtos da lista negativa (ajustado). Somente para produtos farmacêuticos e medicamentos. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
mva_lista_neutra_ajustado |
icms_antecipacao |
Percentual de Margem de Valor Agregado de produtos da lista neutra (ajustado). Somente para produtos farmacêuticos e medicamentos. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
valor_pauta |
icms_antecipacao |
Valor da pauta (em R$). Utilizado para base de cálculo do imposto. |
Numérico (16 dígitos, sendo 4 casas decimais) |
Não |
|
unidade_pauta |
icms_antecipacao |
Unidade de medida utilizada pela legislação para indicar um valor de pauta específico. |
Texto (3 caracteres) |
Não |
|
generico |
icms_antecipacao |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigência_de |
icms_antecipacao |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Sim |
|
vigência_ate |
icms_antecipacao |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
icms_antecipacao |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
icms_antecipacao |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
|
estatistica |
icms_antecipacao |
Código indicador do campo que sofreu alteração em relação ao último retorno de tributação. É aceita lista de códigos, separados por pipe. |
Texto (100 caracteres) |
Não |
|
severidade |
icms_antecipacao |
Este campo poderá ser utilizado para destacar alterações que provoquem maior impacto no resultado da tributação. O preenchimento indicará o nível de severidade, de menor (zero) até o maior (5). |
Numérico (1 dígito) |
Não |
Grupo "credito_icms_antecipacao"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
indicador_credito |
credito_icms_antecipacao |
Indicação se há ou não crédito e a forma de sua apropriação. Vide tabela “indicador_credito”. |
Numérico (3 dígitos) |
Não |
|
cst_entrada |
credito_icms_antecipacao |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Não |
|
percentual_credito |
credito_icms_antecipacao |
Percentual de crédito a ser apropriado. |
Numérico (8 dígitos, sendo 4 casa decimais) |
Não |
|
generico |
credito_icms_antecipacao |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para quais não haja campo específico no leiaute. Vide Tabela “Campo generico”. |
Texto (200 caracteres) |
Não |
|
vigência_de |
credito_icms_antecipacao |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Sim |
|
vigência_ate |
credito_icms_antecipacao |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
credito_icms_antecipacao |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
icms_antecipacao |
Indicação de mensagem e/ou de dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
Grupo "credito ipi"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
indicador_credito |
credito_ipi |
Indicação se há ou não crédito e a forma de sua apropriação. Vide tabela “indicador_credito”. |
Numérico (3 dígitos) |
Sim |
|
cst_entrada |
credito_ipi |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Não |
|
percentual_credito |
credito_ipi |
Percentual de crédito a ser apropriado. |
Numérico (8 dígitos, sendo 4 casa decimais) |
Não |
|
generico |
credito_ipi |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigencia_de |
credito_ipi |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Não |
|
vigencia_ate |
credito_ipi |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
credito_ipi |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
credito_ipi |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
Grupo "pis"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
cst |
pis |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Sim |
|
bc_composicao |
pis |
Base de cálculo composição. Vide tabela “bc_composicao”. |
Numérico (3 dígitos) |
Não |
|
p_red_bc |
pis |
Percentual de redução de base de cálculo. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota |
pis |
Alíquota (em %). |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota_especifica |
pis |
Alíquota específica (em R$). Utilizado para cálculo da contribuição. |
Numérico (16 dígitos, sendo 2 casas decimais) |
Não |
|
generico |
pis |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigencia_de |
pis |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Sim |
|
vigencia_ate |
pis |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
pis |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
pis |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
|
inf_adicionais |
pis |
Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. |
Texto (200 caracteres) |
Não |
|
codigo_natureza_receita |
pis |
Numérico (3 dígitos) |
Não |
|
|
estatistica |
pis |
Código indicador do campo que sofreu alteração em relação ao último retorno de tributação. É aceita a lista de códigos, separados por pipe. |
Texto (100 caracteres) |
Não |
|
severidade |
pis |
Este campo poderá ser utilizado para destacar alterações que provoquem maior impacto no resultado da tributação. O preenchimento indicará o nível de severidade, de menos (zero) até o maior (5). |
Numérico (1 dígito) |
Não |
Grupo "credito_pis"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
indicador_credito |
credito_pis |
Indicação se há ou não crédito e a forma de sua apropriação. Vide tabela “indicador_credito. |
Numérico (3 dígitos) |
Sim |
|
cst_entrada |
credito_pis |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Não |
|
percentual_credito |
credito_pis |
Percentual de crédito a ser apropriado. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
generico |
credito_pis |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigencia_de |
credito_pis |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Não |
|
vigencia_ate |
credito_pis |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
credito_pis |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
credito_pis |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
Grupo "cofins"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
cst |
cofins |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Sim |
|
bc_composicao |
confins |
Base de cálculo composição. Vide tabela “bc_composicao”. |
Numérico (3 dígitos) |
Não |
|
p_red_bc |
cofins |
Percentual de redução de base de cálculo. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota |
cofins |
Alíquota (em %). |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
aliquota_especifica |
cofins |
Alíquota específica (em R$). Utilizado para cálculo da contribuição. |
Numérico (16 dígitos, sendo 2 casas decimais) |
Não |
|
generico |
cofins |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigencia_de |
cofins |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Sim |
|
vigencia_ate |
cofins |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
cofins |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
cofins |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
|
inf_adicionais |
cofins |
Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. |
Texto (200 caracteres) |
Não |
|
codigo_natureza_receita |
cofins |
Numérico (3 dígitos) |
Não |
|
|
estatistica |
cofins |
Código indicador do campo que sofreu alteração em relação ao último retorno de tributação. É aceita lista de códigos, separados por pipe. |
Texto (100 caracteres) |
Não |
|
severidade |
cofins |
Este campo poderá ser utilizado para destacar alterações que provoquem maior impacto no resultado de tributação. O preenchimento indicará o nível de severidade, de menor (zero) até o maior (5). |
Numérico (1 dígito) |
Não |
Grupo "credito_cofins"
|
Tag - Retorno |
Pai |
Descrição |
Tipo |
Obrigatório |
|
indicador_credito |
credito_cofins |
Indicação se há ou não crédito e a forma de sua apropriação. Vide tabela “indicador_credito”. |
Numérico (3 dígitos) |
Sim |
|
cst_entrada |
credito_cofins |
Código de Situação Tributária. |
Numérico (3 dígitos) |
Não |
|
percentual_credito |
credito_cofins |
Percentual de crédito a ser apropriado. |
Numérico (8 dígitos, sendo 4 casas decimais) |
Não |
|
generico |
credito_cofins |
Campo texto destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Vide Tabela “Campo genérico”. |
Texto (200 caracteres) |
Não |
|
vigencia_de |
credito_cofins |
Data de início da vigência da tributação. |
Data (dd/mm/aaaa) |
Não |
|
vigencia_ate |
credito_cofins |
Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. |
Data (dd/mm/aaaa) |
Não |
|
dispositivo_legal |
credito_cofins |
Norma legal que ampara a tributação indicada. |
Texto (200 caracteres) |
Sim |
|
observacoes |
credito_cofins |
Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. |
Texto (200 caracteres) |
Não |
API Leitura de regras de Serviços
Objetivo: Retornar as regras de Serviços aprovadas do Cockpit
Método: POST
API Rest / Json: https://api-gateway.systax.com.br/cockpit/v2/api/regras/servicos
Descrição dos campos de chamada e retorno
Chamada
|
Campo |
PAI |
Descrição |
Obrigatório |
|
municipio_prestador |
/ |
Informar o código IBGE do município do Prestador ou vazio. |
Não |
|
cod_trib_municipio |
/ |
Informar o Código do serviço no município ou vazio. |
Não |
|
cod_servico_interno |
/ |
Informar o Código do serviço interno no cadastro cliente ou vazio. |
Não |
|
cod_subitem_lei |
/ |
Informar o Código do serviço na Lei 116/2003 ou vazio. |
Não |
|
paginacao |
/ |
Quantidade de registros/regras a serem entregues por página. Limite máximo 100. |
Não |
|
ponteiro_atualizacao |
/ |
Ponteiro do controle de atualização. |
Não |
Retorno
|
Campo |
PAI |
Descrição |
|
ponteiro_atualizacao |
/ |
Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo |
|
origem |
/ |
Valor fixo "Systax". |
|
sistema |
/ |
Valor fixo "Cockpit". |
|
cod_status |
status |
Código de retorno |
|
msg_status |
status |
Mensagem de retorno |
|
cenario |
|
O detalhamento do retorno a partir deste campo está disponível no item Informações retornadas pelo systax_erp. |
Tabela de referência para os campos "cod_status" e "msg_status":
|
cod_status |
msg_status |
|
0 |
Sucesso |
|
1 |
LoginSenhaInvalido |
|
8 |
UsuarioSemCliente |
|
9 |
ClienteSemConnectionString |
|
10 |
FalhaNaAplicacao |
Exemplos de chamada e retorno
Chamada
{
"municipio_prestador": "4314902",
"cod_trib_municipio": "",
"cod_servico_interno": "",
"cod_subitem_lei": "",
"paginacao": 100,
"ponteiro_atualizacao": "0"
}
Retorno
{
"cenario": [
{
"id_cenario": "RS4314902RS4314902RJ4314902",
"ent_sai": "1",
"cod_natop": "172",
"dt_criacao": "26-12-2022",
"uf_prestador": "RS",
"municipio_prestador": "4314902",
"uf_tomador": "RS",
"municipio_tomador": "4314902",
"uf_servico_prestado": "RJ",
"id_municipio_servico": "3304557",
"servico": [
{
"ser_codi": 240,
"cod_servico_interno": "SERV-SECU",
"desc_servico_interno": "SERV-SECU",
"cod_subitem_lei": "11.02",
"desc_servico": "Vigilância, segurança ou monitoramento de bens, pessoas e semoventes.",
"desc_servico_municipio": "Vigilância, segurança ou monitoramento de bens, pessoas e semoventes.",
"dt_criacao": "26-12-2022",
"iss": {
"iss_responsavel": "TOMADOR",
"iss_mun_incidencia": "EXECUÇÃO",
"iss_exigibilidade": 1,
"iss_aliq": "5",
"iss_bc_comp": "110",
"iss_gene": "ISSRet=S",
"iss_displeg": "Lei 691 de 24/12/1984, art. 14/art. 33,inc I.",
"iss_obs": "CEPOM/SP - Lei nº 13.701/2003, arts. 9º-A, caput e 9º-B, caput - Lei nº 14.042/2005, art. 2º - Decreto nº 53.151/2012, art. 69 - Portaria SF nº 101/2005",
"iss_pis_cst": "1",
"iss_pis_aliq": "1.6500",
"iss_pis_bc_comp": 110,
"iss_pis_vig_de": "02-01-2023",
"iss_pis_displeg": "Art. 30 da Lei 10.833/2003 e Instrução Normativa SRF 459/2004.",
"iss_cofins_cst": "1",
"iss_cofins_aliq": "7.6000",
"iss_cofins_bc_comp": 110,
"iss_cofins_vig_de": "02-01-2023",
"iss_cofins_displeg": "Art. 30 da Lei 10.833/2003 e Instrução Normativa SRF 459/2004."
},
"retencao": {
"ret_pis_aliq": "0.65",
"ret_pis_bc_comp": 40,
"ret_pis_vig_de": "01-01-2019",
"ret_pis_vig_ate": "02-01-2023",
"ret_pis_displeg": "Art. 30 da Lei 10.833/2003 e Instrução Normativa SRF 459/2004.",
"ret_cofins_aliq": "3",
"ret_cofins_bc_comp": 40,
"ret_cofins_vig_de": "01-01-2019",
"ret_cofins_vig_ate": "02-01-2023",
"ret_cofins_displeg": "Art. 30 da Lei 10.833/2003 e Instrução Normativa SRF 459/2004.",
"ret_csll_aliq": "1",
"ret_csll_bc_comp": 40,
"ret_csll_vig_de": "01-01-2019",
"ret_csll_vig_ate": "02-01-2023",
"ret_csll_displeg": "Art. 30 da Lei 10.833/2003 e Instrução Normativa SRF 459/2004.",
"ret_inss_aliq": "11.0000",
"ret_inss_bc_comp": 40,
"ret_inss_vig_de": "01-01-2019",
"ret_inss_vig_ate": "02-01-2023",
"ret_inss_displeg": "Artigo 119 da IN RFB nº 971/2009",
"ret_inss_obs": "Não há retenção",
"ret_irrf_aliq": "1.5",
"ret_irrf_bc_comp": 40,
"ret_irrf_vig_de": "01-01-2019",
"ret_irrf_vig_ate": "02-01-2023",
"ret_irrf_displeg": "IN SRF nº 23/86 e Artigo 714 do RIR/2018.",
"ret_cprb_aliq": "11.0000",
"ret_cprb_bc_comp": 40,
"ret_cprb_vig_de": "01-01-2019",
"ret_cprb_vig_ate": "02-01-2023",
"ret_cprb_displeg": "Lei 12.546/2011",
"ret_cprb_obs": "Não há retenção."
}
}
Informações retornadas pelo systax_erp nas regras de Serviços
|
Campo |
Pai |
Descrição |
Obrigatório na Chamada |
Campo NFS-e |
Tipo |
Tamanho |
|
id_cenario |
Cenário |
Número atribuido ao cenário |
Não |
Não |
string |
30 |
|
cod_natop |
Cenário |
Código da natureza da operação. Para verificar os códigos, veja a tabela "Natureza de Operações“. |
Não |
Não |
string |
3 |
|
remetente |
Cenário |
Prestador |
Não |
Não |
string |
4 |
|
destinatário |
Cenário |
Tomador |
Não |
Não |
string |
4 |
|
uf_prestador |
Cenário |
UF do Prestador do serviço |
Não |
Sim - Obrigatório |
string |
2 |
|
municipio_prestador |
Cenário |
Município do Prestador |
Não |
Sim - Obrigatório |
string |
10 |
|
uf_tomador |
Cenário |
UF do Tomador do serviço |
Não |
Sim - Obrigatório |
string |
2 |
|
municipio_tomador |
Cenário |
Municipio do Tomador |
Não |
Sim - Obrigatório |
string |
10 |
|
uf_servico_prestado |
Cenário |
UF onde o serviço foi prestado |
Não |
Sim - Obrigatório |
string |
2 |
|
id_municipio_servico |
Cenário |
Municipio onde o serviço foi prestado |
Não |
Sim |
string |
10 |
|
cod_nbs |
Serviço |
Nomenclatura Brasileira de Serviços (NBS) é um código classificador utilizado para identificar com precisão os tipos de serviços. |
Não |
Sim |
string |
10 |
|
cod_servico_interno |
Serviço |
Código do cliente para o serviço |
Não |
Sim |
string |
20 |
|
desc_servico_interno |
Serviço |
Descrição do cliente para o serviço |
Não |
Não |
string |
500 |
|
cod_subitem_lei |
Serviço |
Código da Lei 116/2003 |
Não |
Sim - Obrigatório |
string |
5 |
|
desc_servico |
Serviço |
Descrição da Lei 116/2003 |
Não |
Não |
string |
500 |
|
cod_trib_municipio |
Serviço |
Código do serviço dentro do municipio do Prestador |
Não |
Sim |
string |
10 |
|
desc_servico_municipio |
Serviço |
Descrição do serviço dentro do município do Prestador |
Não |
Não |
string |
500 |
|
dt_criacao |
serviço |
Data da criação da regra no Cockpit |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
iss_responsavel |
ISS |
Responsável pelo recolhimento do ISS |
Não |
Não |
string |
15 |
|
iss_mun_incidencia |
ISS |
Município que incide o recolhimento do ISS |
Não |
Sim |
string |
10 |
|
iss_exigibilidade |
ISS |
Código definido pela Abrasf indica forma de tributação |
Não |
Sim |
string |
2 |
|
iss_aliq |
ISS |
Alíquota ISS |
Não |
Sim |
Numérico (8 dígitos, sendo 4 casas decimais) |
8.4 |
|
iss_bc_comp |
ISS |
Código que informa a fórmula para formar a base de cálculo do ISS |
Não |
Não |
string |
3 |
|
iss_deducoes |
ISS |
Percentual de dedução |
Não |
Não |
string |
8.4 |
|
iss_gene |
ISS |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
iss_vig_de |
ISS |
Início da vigência da tributação de ISS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
iss_vig_ate |
ISS |
Final da vigência da tributação de ISS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
iss_displeg |
ISS |
Dispositivo legal do ISS |
Não |
Não |
string |
250 |
|
iss_obs |
ISS |
Observações diversas da legislaçao de ISS |
Não |
Não |
string |
250 |
|
iss_inf_adic |
ISS |
Informações adicionais do ISS (Outras Informações) |
Não |
Sim |
string |
250 |
|
iss_pis_cst |
ISS |
N/A |
Não |
|
string |
2 |
|
iss_pis_aliq |
ISS |
Alíquota PIS Prestador |
Não |
Não |
Numérico (8 dígitos, sendo 4 casas decimais) |
8.4 |
|
iss_pis_bc_comp |
ISS |
Código que informa a fórmula para formar a base de cálculo do PIS |
Não |
Não |
string |
3 |
|
iss_pis_vig_de |
ISS |
Início da vigência da tributação de PIS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
iss_pis_vig_ate |
ISS |
Final da vigência da tributação de PIS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
iss_pis_displeg |
ISS |
Dispositivo Legal do PIS |
Não |
Não |
string |
250 |
|
iss_pis_obs |
ISS |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
iss_pis_gene |
ISS |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
iss_cofins_cst |
ISS |
N/A |
Não |
Não |
string |
2 |
|
iss_cofins_aliq |
ISS |
Alíquota COFINS Prestador |
Não |
Não |
Numérico (8 dígitos, sendo 4 casas decimais) |
8.4 |
|
iss_cofins_bc_comp |
ISS |
Código que informa a fórmula para formar a base de cálculo do COFINS |
Não |
Não |
string |
3 |
|
iss_cofins_vig_de |
ISS |
Início da vigência da tributação de COFINS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
iss_cofins_vig_ate |
ISS |
Final da vigência da tributação de COFINS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
iss_cofins_displeg |
ISS |
Dispositivo Legal do COFINS |
Não |
Não |
string |
250 |
|
iss_cofins_obs |
ISS |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
iss_cofins_gene |
ISS |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
pis_cst |
Retenções |
N/A |
Não |
|
string |
2 |
|
pis_aliq |
Retenções |
Alíquota da Retenção de PIS |
Não |
|
Numérico (8 dígitos, sendo 4 casas decimais) |
8.4 |
|
pis_bc_comp |
Retenções |
Código que informa a fórmula para formar a base de cálculo do PIS |
Não |
Sim |
string |
3 |
|
pis_vig_de |
Retenções |
Início da vigência da Retenção de PIS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
pis_vig_ate |
Retenções |
Final da vigência da Retenção de PIS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
pis_displeg |
Retenções |
Dispositivo Legal do PIS |
Não |
Não |
string |
250 |
|
pis_obs |
Retenções |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
pis_gene |
Retenções |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
cofins_cst |
Retenções |
N/A |
Não |
Não |
string |
2 |
|
cofins_aliq |
Retenções |
Alíquota da Retenção de COFINS |
Não |
Não |
Numérico (8 dígitos, sendo 4 casas decimais) |
8.4 |
|
cofins_bc_comp |
Retenções |
Código que informa a fórmula para formar a base de cálculo do COFINS |
Não |
Não |
string |
3 |
|
cofins_vig_de |
Retenções |
Início da vigência da Retenção de COFINS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
cofins_vig_ate |
Retenções |
Final da vigência da Retenção de COFINS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
cofins_displeg |
Retenções |
Dispositivo Legal do COFINS |
Não |
Não |
string |
250 |
|
cofins_obs |
Retenções |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
cofins_gene |
Retenções |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
csll_aliq |
Retenções |
Alíquota da Retenção de CSLL |
Não |
Não |
Numérico (8 dígitos, sendo 4 casas decimais) |
2 |
|
csll_bc_comp |
Retenções |
Código que informa a fórmula para formar a base de cálculo da Retenção da CSLL |
Não |
Não |
string |
8.4 |
|
csll_vig_de |
Retenções |
Início da vigência da Retenção da CSLL |
Não |
Não |
Data (dd/mm/aaaa) |
3 |
|
csll_vig_ate |
Retenções |
Final da vigência da Retenção da CSLL |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
csll_displeg |
Retenções |
Dispositivo Legal da CSLL |
Não |
Não |
string |
10 |
|
csll_obs |
Retenções |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
csll_gene |
Retenções |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
inss_aliq |
Retenções |
Alíquota da Retenção de INSS |
Não |
Não |
Numérico (8 dígitos, sendo 4 casas decimais) |
250 |
|
inss_bc_comp |
Retenções |
Código que informa a fórmula para formar a base de cálculo da Retenção do INSS |
Não |
Não |
string |
8.4 |
|
inss_vig_de |
Retenções |
Início da vigência da Retenção do INSS |
Não |
Não |
Data (dd/mm/aaaa) |
3 |
|
inss_vig_ate |
Retenções |
Final da vigência da Retenção do INSS |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
inss_displeg |
Retenções |
Dispositivo Legal do INSS |
Não |
Não |
string |
10 |
|
inss_obs |
Retenções |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
inss_gene |
Retenções |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
irrf_aliq |
Retenções |
Alíquota da Retenção do IRRF |
Não |
Não |
Numérico (8 dígitos, sendo 4 casas decimais) |
250 |
|
irrf_bc_comp |
Retenções |
Código que informa a fórmula para formar a base de cálculo da Retenção do IRRF |
Não |
Não |
string |
8.4 |
|
irrf_vig_de |
Retenções |
Início da vigência da Retenção do IRRF |
Não |
Não |
Data (dd/mm/aaaa) |
3 |
|
irrf_vig_ate |
Retenções |
Final da vigência da Retenção do IRRF |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
irrf_displeg |
Retenções |
Dispositivo Legal do IRRF |
Não |
Não |
string |
10 |
|
irrf_obs |
Retenções |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
irrf_gene |
Retenções |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
|
cprb_aliq |
Retenções |
Alíquota da Retenção do CPRB |
Não |
Não |
Numérico (8 dígitos, sendo 4 casas decimais) |
250 |
|
cprb_bc_comp |
Retenções |
Código que informa a fórmula para formar a base de cálculo da Retenção do CPRB |
Não |
Não |
string |
8.4 |
|
cprb_vig_de |
Retenções |
Início da vigência da Retenção do CPRB |
Não |
Não |
Data (dd/mm/aaaa) |
3 |
|
cprb_vig_ate |
Retenções |
Final da vigência da Retenção do CPRB |
Não |
Não |
Data (dd/mm/aaaa) |
10 |
|
cprb_displeg |
Retenções |
Dispositivo Legal do CPRB |
Não |
Não |
string |
10 |
|
cprb_obs |
Retenções |
Observações diversas da legislaçao |
Não |
Não |
string |
250 |
|
cprb_gene |
Retenções |
Campo destinado a marcações que indicam algumas definições para a tributação |
Não |
Não |
string |
250 |
Informações técnicas
- Web Forms e Windows Services
- Conexão com Internet (Importação de Regras)
- Microsoft .Net Framework 4.0
- IIS 7.0 ou superior
- Sistema Operacional
- Windows Server 2008 ou Windows Server 2008 R2 - 64bits
- Windows 7 – Não recomendado para ambientes produtivos.
- Microsoft SQL Server 2008 ou superior
- Versão SAAS utiliza MultiAz da AWS e a aplicação em EC2 com LoadBalance, para as versões on premise esses recursos não são necessários.