| **Campo** | **PAI** | **Descrição** |
| success | / | Status do retorno |
| message | / | Mensagem do retorno |
| record\_count | / | Número de registros retornados |
| id | data | ID do grupo |
| descricao | data | Descrição do grupo |
| **Código de retorno** | **success** | **message** |
| 200 | true | OK |
| 400 | false | token\_invalid |
| false | token\_expired | |
| 500 | false | internal error |
| **Parâmetro** | **Detalhamento do preenchimento** | **Obrigatório** |
| Paginação | Quantidade de registros/regras a serem entregues por página. Limite máximo 100. | Sim |
| Ponteiro | Ponteiro do controle de atualização. | Sim |
| -Para carga inicial (recebimento de todas as regras), informar 0. | ||
| -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). | ||
| \*paramProxPag | É o dado recebido no response que identificará quais regras devem retornar na próxima página. Na primeira chamada do processo, informar 0. Sempre que a quantidade de regras retornadas for igual ao valor informado no critério "paginacao", deverá ser feita mais uma chamda para obter a próxima página. A partir da 2ª chamada, informar no parâmetro "paramProxPagina" o valor retornado no campo "paramProxPagina" do response da página anterior. | Sim |
| **Campo** | **Pai** | **Descrição** |
| Ponteiro | - | Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo. Essa informação é retornada na primeira página do processo de carga e deverá ser armazenada para servir de parâmetro para utilização na próxima carga, que identificará quais regras já foram recebidas no processo anterior e, portanto, não deverão ser entregues novamente. |
| codStatus | status | Código de retorno |
| msgStatus | status | Mensagem de retorno |
| paramProxPag | - | Retorna o resultado da concatenação de "IdCenario | codigoProduto | origemProduto" do último produto e cenário retornado nesta página. O objetivo é usar este valor como parâmetro na request da próxima página para definir quais regras devem retornar nesta, assim a primeira regra a ser entregue deverá ser a regra do produto e cenário identificados nesta concatenação e as próximas regras deverão ser as que são subsequentes à primeira. |
| retorno tributário | - | O detalhamento do retorno a partir deste campo consta no item "Informações da RT retornadas no Cockpit" deste manual. |
| **cod\_status** | **msg\_status** |
| 200 | Sucesso |
| 401 | Token ou Login/ Senha inválidos |
| 500 | Falha na aplicação |
| 901 | Usuario sem cliente |
| 902 | Cliente sem connection string |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| idCenario | cenario | ID do cenário | Numérico (10 dígitos) | Sim |
| Entrada/Saida | cenario | Indicação do tipo da operação: 1- Entrada 2- Devolução de Entradas 3- Saídas 4- Devolução de Saídas Obs.: Os itens 2 e 4 existem apenas para situações específicas para integrações com sistema SAP. | Numérico (1 dígitos) | Não |
| NaturezaOperacao | cenario | Código de natureza da operação | Numérico (4 dígitos) | 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 (1 dígitos) | Não |
| ufOrigem | cenario | Sigla da UF de origem da mercadoria. | String (2 caracteres) | Sim |
| municípioOrigem | cenario | Código de Município de origem 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 | Numérico (7 dígitos) | Não |
| ufDestino | cenario | Sigla da UF de destino da mercadoria. | String (2 caracteres) | Sim |
| municípioDestino | cenario | Código de Município de destino 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 | Numérico (7 dígitos) | Não |
| ufEntrega | cenario | Sigla da UF de entrega da mercadoria | String (2 caracteres) | Não |
| municípioEntrega | cenario | 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 | Numérico (7 dígitos) | Não |
| municípioExecucao | cenario | 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 | Numérico (7 dígitos) | Não |
| perfilOrigem | cenario | Perfil do estabelecimento remetente da operação. Para verificar os códigos, veja a tabela “Remetente”. | Numérico (5 dígitos) | Sim |
| cnaeOrigem | cenario | Código de Classificação Nacional de Atividades Econômicas (CNAE) do estabelecimento remetente. Deve ser utilizada a tabela mantida pelo IBGE disponível em: Tabela de CNAE do IBGE | Numérico (7 dígitos) | Não |
| perfilDestino | cenario | Perfil do estabelecimento remetente da operação. Para verificar os códigos, veja a tabela “Destinação”. | Numérico (5 dígitos) | Sim |
| cnaeDestino | cenario | Código de Classificação Nacional de Atividades Econômicas (CNAE) do estabelecimento destinatário. Deve ser utilizada a tabela mantida pelo IBGE disponível em: Tabela de CNAE do IBGE | String (10 caracteres) | Não |
| perfilPrestador | cenario | Perfil do prestador de um serviço | Numérico (5 dígitos) | Não |
| perfilTomador | cenario | Perfil do prestador de um serviço | Numérico (5 dígitos) | Não |
| perfilExecutor | cenario | Perfil do executor de um serviço | Numérico (5 dígitos) | Não |
| baseCalculo | cenario | Base de cálculo para apuração do Imposto sobre Bens e Serviços (IBS) e Contribuição sobre Bens e Serviços (CBS) | Numérico (4 dígitos) | Sim |
| apelido | cenario | Identificação do cenário. | String (50 caracteres) | Não |
| diasFuturos | cenario | Indicar a quantidade de dias futuros a ser analisada a legislação. Por exemplo se o campo estiver preenchido com “30”, o sistema localizará regras vigentes 30 dias após a data da consulta. | Numérico (3 dígitos) | Não |
| grupoProdutos | cenario | Nome dos grupos de produtos associados a esse cenário. | String (25 caracteres) | Não |
| porporcao | cenario | Retorno de informação da regra tributária composto pelo valor da pauta dividido pela unidade de medida | Numérico (11,4) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| codigoProduto | Cenario | Código do produto | String (60 caracteres) | Sim |
| descricao | Cenario | Descrição do produto | String (120 caracteres) | Não |
| ncm | Cenario | Código do produto conforme a Nomenclatura Comum do Mercosul – Tabela oficial. Código de 8 dígitos. | Numérico (8 dígitos) | Sim |
| exTipi | Cenario | 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 |
| ean | Cenario | Código universal de identificação de um produto, composto por dígitos correspondentes a código do país, código dda empresa, número do artigo e dígito de verificaçao. | String (14 caracteres) | Não |
| origemProduto | Cenario | Origem da Mercadoria ou Serviço – Tabela oficial. | Numérico (1 dígitos) | Não |
| codigoServMunicipal | Cenario | Código de serviço específico de cda Prefeitura | Numérico (10 dígitos) | Sim |
| NBS | Cenario | Código identificador da Nomenclatura Brasileira de Serviços | Numérico (10 dígitos) | Não |
| tipoRegra | Cenário | Campo para determinação do tipo de regra Systax, contendo as Tags RGO (Regra Geral por Operação), ESP (Regra Específica por Produto) e REG (Regra Geral coom parâmetros de cenários) | String (3 caracteres | Sim |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| cst | Regra | 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 |
| cClassTrib | Regra | Código de Classificação Tributária | Numérico (10 dígitos) | Sim |
| pIBSUF | Regra | Alíquota (em %) | Percentual (3,4 dígitos) | Não |
| pAliq | Regra | Alíquota (em R$) | Percentual (3,4 dígitos) | Não |
| pRedAliq | Regra | Percentual de redução de base de cálculo. | Percentual (3,4 dígitos) | Não |
| pAliqEfet | Regra | Alíquota efetiva que do IBS de competência das UF que será aplicada a base de cálculo | Percentual (3,4 dígitos) | Não |
| aliquotaAdRem | Regra | Alíquota por unidade de medida | Valor (3,4 dígitos) | Não |
| aliquotaAdRemReten | Regra | Alíquota por unidade de medida com retenção | Valor (3,4 dígitos) | Não |
| pDif | Regra | Percentual do imposto diferido. | Percentual (3,4 dígitos) | Não |
| pDevTrib | Regra | Percentual de devolução na forma de Cashback | Percentual (3,4 dígitos) | não |
| valorPauta | Regra | Valor da pauta. Valor utilizado para determinação do valor da base de cálculo do imposto. | Valor (11,4 dígitos) | Não |
| uTrib | Regra | Unidade de medida tributável | String (1,6 caracteres) | Não |
| vigenciaDe | Regra | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | Regra | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | Regra | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | Regra | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | Regra | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | Regra | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| CSTREG | IBS | Código da Situação Tributária do IBSUF | Numérico (3 dígitos) | Sim |
| cClassTribReg | IBS | Código da Classificação Tributária do IBSUF | Numérico (10 dígitos) | Sim |
| pAliqEfetRegIBSUF | IBS | Valor da alíquota efetiva da tributação regular Do IBSUF | Numérico (3,4 dígitos) | Não |
| baseCalculoReg | IBS | Base de cálculo da tributação regular do IBSUF | Numérico (4 dígitos) | Sim |
| pIBSUF | IBS | Alíquota (em %) | Percentual (3,4 dígitos) | Não |
| pRedAliq | IBS | Percentual de redução de base de cálculo. | Percentual (3,4 dígitos) | Não |
| vigenciaDe | IBS | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | IBS | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | IBS | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | IBS | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | IBS | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | IBS | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| indicadorCreditoPres | IBS | Indicador se hã ou não crédito presumido | Numérico (3 dígitos) | Sim |
| cCredPres | IBS | Código de Classificiação do Crédito Presumido | Numérico (10 dígitos) | Sim |
| pCredPres | IBS | Percentual do Crédito Presumido | Numérico (3,4 dígitos) | Não |
| vigenciaDe | IBS | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | IBS | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | IBS | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | IBS | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | IBS | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | IBS | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| indicadorCredito | IBS | 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 |
| cstEntrada | IBS | Código de Situação Tributária. | Numérico (3 dígitos) | Não |
| cfopEntrada | IBS | Código CFOP (Código Fiscal de Operação e Prestação) – Tabela oficial relacionado a entradas | Numérico (4 dígitos) | Sim |
| percentualCredito | IBS | Percentual de crédito a ser apropriado. | Percentual (3,4 dígitos) | Não |
| vigenciaDe | IBS | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | IBS | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | IBS | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Sim |
| observacoes | IBS | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| estatistica | IBS | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| pIBSMun | Regra | Alíquota (em %) | Percentual (3,4 dígitos) | Não |
| pAliq | Regra | Alíquota (em R$) | Percentual (3,4 dígitos) | Não |
| pRedAliq | Regra | Percentual de redução de base de cálculo. | Percentual (3,4 dígitos) | Não |
| pAliqEfet | Regra | Alíquota efetiva que do IBS de competência das UF que será aplicada a base de cálculo | Percentual (3,4 dígitos) | Não |
| aliquotaAdRem | Regra | Alíquota por unidade de medida | Valor (3,4 dígitos) | Não |
| aliquotaAdRemReten | Regra | Alíquota por unidade de medida com retenção | Valor (3,4 dígitos) | Não |
| pDif | Regra | Percentual do imposto diferido. | Percentual (3,4 dígitos) | Não |
| pDevTrib | Regra | Percentual de devolução na forma de Cashback | Percentual (3,4 dígitos) | não |
| valorPauta | Regra | Valor da pauta. Valor utilizado para determinação do valor da base de cálculo do imposto. | Valor (11,4 dígitos) | Não |
| uTrib | Regra | Unidade de medida tributável | String (6 caracteres) | Não |
| vigenciaDe | Regra | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | Regra | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | Regra | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | Regra | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | Regra | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | Regra | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| CSTREG | IBSMun | Código da Situação Tributária do IBSMun | Numérico (3 dígitos) | Sim |
| cClassTribReg | IBSMun | Código da Classificação Tributária do IBSMun | Numérico (10 dígitos) | Sim |
| pAliqEfetRegIBSMun | IBSMun | Valor da alíquota efetiva da tributação regular Do IBSMun | Numérico (3,4 dígitos) | Não |
| baseCalculoReg | IBSMun | Base de cálculo da tributação regular do IBSMun | Numérico (4 dígitos) | Sim |
| pIBSUF | IBSMun | Alíquota (em %) | Percentual (3,4 dígitos) | Não |
| pRedAliq | IBSMun | Percentual de redução de base de cálculo. | Percentual (3,4 dígitos) | Não |
| vigenciaDe | IBSMun | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | IBSMun | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | IBSMun | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | IBSMun | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | IBSMun | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | IBSMun | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| indicadorCreditoPres | IBSMun | Indicador se hã ou não crédito presumido | Numérico (3 dígitos) | Sim |
| cCredPres | IBSMun | Código de Classificiação do Crédito Presumido | Numérico (10 dígitos) | Sim |
| pCredPres | IBSMun | Percentual do Crédito Presumido | Numérico (3,4 dígitos) | Não |
| vigenciaDe | IBSMun | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | IBSMun | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | IBSMun | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | IBSMun | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | IBSMun | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | IBSMun | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| indicadorCredito | IBSMun | 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 |
| cstEntrada | IBSMun | Código de Situação Tributária. | Numérico (3 dígitos) | Não |
| cClassCredPres | IBSMun | Código de Classificação Tributária do Crédito Presumido | Numérico (10 dígitos) | Não |
| cfopEntrada | IBSMun | Código CFOP (Código Fiscal de Operação e Prestação) – Tabela oficial relacionado a entradas | Numérico (4 dígitos) | Sim |
| percentualCredito | IBSMun | Percentual de crédito a ser apropriado. | Percentual (3,4 dígitos) | Não |
| vigenciaDe | IBSMun | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | IBSMun | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | IBSMun | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Sim |
| observacoes | IBSMun | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| estatistica | IBSMun | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| cst | Regra | 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 |
| cClassTrib | Regra | Código de Classificação Tributária | Numérico (6 dígitos) | Sim |
| pCBS | Regra | Alíquota (em %) | Percentual (3,4 dígitos) | Não |
| pAliq | Regra | Alíquota (em R$) | Percentual (3,4 dígitos) | Não |
| pRedAliq | Regra | Percentual de redução de base de cálculo. | Percentual (3,4 dígitos) | Não |
| pAliqEfet | Regra | Alíquota efetiva que do IBS de competência das UF que será aplicada a base de cálculo | Percentual (3,4 dígitos) | Não |
| aliquotaAdRem | Regra | Alíquota por unidade de medida | Percentual (3,4 dígitos) | Não |
| aliquotaAdRemReten | Regra | Alíquota por unidade de medida com retenção | Percentual (3,4 dígitos) | Não |
| pDif | Regra | Percentual do imposto diferido. | Percentual (3,4 dígitos) | Não |
| pDevTrib | Regra | Percentual de devolução na forma de Cashback | Percentual (3,4 dígitos) | Não |
| valorPauta | Regra | Valor da pauta. Valor utilizado para determinação do valor da base de cálculo do imposto. | Valor (11,4 dígitos) | Não |
| uTrib | Regra | Unidade de medida tributável | String (1,6 caracteres) | Não |
| vigenciaDe | Regra | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | Regra | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | Regra | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | Regra | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | Regra | Informações adicionais relevantes a operação | String (300 caracteres) | Não |
| estatistica | Regra | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| CSTREG | CBS | Código da Situação Tributária do CBS | Numérico (3 dígitos) | Sim |
| cClassTribReg | CBS | Código da Classificação Tributária do CBS | Numérico (10 dígitos) | Sim |
| pAliqEfetRegCBS | CBS | Valor da alíquota efetiva da tributação regular Do CBS | Numérico (3,4 dígitos) | Não |
| baseCalculoReg | CBS | Base de cálculo da tributação regular do IBSUF | Numérico (4 dígitos) | Sim |
| pCBSUF | CBS | Alíquota (em %) | Percentual (3,4 dígitos) | Não |
| pRedAliq | CBS | Percentual de redução de base de cálculo. | Percentual (3,4 dígitos) | Não |
| vigenciaDe | CBS | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | CBS | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | CBS | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | CBS | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | CBS | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | CBS | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| indicadorCreditoPres | CBS | Indicador se hã ou não crédito presumido | Numérico (3 dígitos) | Sim |
| cCredPres | CBS | Código de Classficiação do Crédito Presumido | Numérico (10 dígitos) | Sim |
| pCredPres | CBS | Percentual do Crédito Presumido | Numérico (3,4 dígitos) | Não |
| vigenciaDe | CBS | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | CBS | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | CBS | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Não |
| observacoes | CBS | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | CBS | Expressão obrigatória a constar no documento fiscal em decorrência do dispositivo legal da tributação apresentada. | String (500 caracteres) | Não |
| estatistica | CBS | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| indicadorCredito | CBS | 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 |
| cstEntrada | CBS | Código de Situação Tributária. | Numérico (3 dígitos) | Não |
| percentualCredito | CBS | Percentual de crédito a ser apropriado. | String (3,4 dígitos) | Não |
| vigenciaDe | CBS | Data de início da vigência da tributação. | Data (20 dígitos) | Não |
| vigenciaAte | CBS | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | Data (20 dígitos) | Não |
| dispositivoLegal | CBS | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Sim |
| observacoes | CBS | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| estatistica | CBS | 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. | String (50 caracteres) | Não |
| **Tag** | **Pai** | **Descrição** | **Tipo** | **Obrigatório** |
| CSTIS | Regra | 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 |
| cClassTribIS | Regra | Código de Classificação Tributária | Numérico (10 dígitos) | Sim |
| baseCalculo | Regra | Base de cálculo para apuração do Imposto Seletivo | Numérico (4 dígitos) | Sim |
| pIS | Regra | Alíquota do Imposto seletivo | Percentual (3,4 dígitos) | Sim |
| pISEspec | Regra | Alíquota específica por unidade de medida apropriada | Percentual (3,4 dígitos) | Não |
| valorPauta | Regra | Valor da pauta. Valor utilizado para determinação do valor da base de cálculo do imposto. | Valor (11,4 dígitos) | Não |
| uTrib | Regra | Unidade de medida tributável | String (1,6 caracteres) | Não |
| vigenciaDe | Regra | Data de início da vigência da tributação. | data (20 dígitos) | Não |
| vigenciaAte | Regra | Data de término da vigência da tributação. Quando estiver vazio indica que está vigente por tempo indeterminado. | data (20 dígitos) | Não |
| dispositivoLegal | Regra | Norma legal que ampara a tributação indicada. | String (300 caracteres) | Sim |
| observacoes | Regra | Indicação de um dispositivo legal que traz condições para a aplicação da tributação apresentada. | String (300 caracteres) | Não |
| informacoesAdicionais | Regra | Informações adicionais relevantes a operação | String (300 caracteres) | Não |
| estatistica | Regra | 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. | String (50 caracteres) | Não |
| **Parâmetro** | **Detalhamento do preenchimento** | **Obrigatório** |
| Paginação | Quantidade de registros/regras a serem entregues por página. Limite máximo 1.000. | Sim |
| Ponteiro | Ponteiro do controle de atualização. | Sim |
| -Para carga inicial (recebimento de todos os registros), informar 0. | ||
| -Para atualizações, informar o ponteiro retornado na primeira chamada da carga anterior. | ||
| \*paramProxPag | É o dado recebido no response que identificará quais registros devem retornar na próxima página. Na primeira chamada do processo, informar 0. Sempre que retornado o campo "paramProxPag", deverá ser feita mais uma chamada para obter a próxima página. A partir da 2ª chamada, informar no parâmetro "paramProxPagina" o valor retornado no campo "paramProxPagina" do response da página anterior. O conteúdo retornado neste campo é sempre equivalente ao ID do último cenário atual retornado na página, que também será o primeiro a retornar na próxima página. | Sim |
| **Campo** | **Pai** | **Descrição** |
| Ponteiro | - | Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo. Essa informação é retornada na primeira página do processo de carga e deverá ser armazenada para servir de parâmetro para utilização na próxima carga, que identificará quais regras já foram recebidas no processo anterior e, portanto, não deverão ser entregues novamente. |
| codStatus | status | Código de retorno |
| msgStatus | status | Mensagem de retorno |
| paramProxPag | - | Retorna o resultado da concatenação de "IdCenario | codigoProduto | origemProduto" do último produto e cenário retornado nesta página. O objetivo é usar este valor como parâmetro na request da próxima página para definir quais regras devem retornar nesta, assim a primeira regra a ser entregue deverá ser a regra do produto e cenário identificados nesta concatenação e as próximas regras deverão ser as que são subsequentes à primeira. |
| retorno tributário | - | O detalhamento do retorno a partir deste campo consta no item "Informações da RT retornadas no Cockpit" deste manual. |
| **cod\_status** | **msg\_status** |
| 200 | Sucesso |
| 401 | Token ou Login/ Senha inválidos |
| 500 | Falha na aplicação |
| 901 | Usuario sem cliente |
| 902 | Cliente sem connection string |
| **Parâmetro** | **Detalhamento do preenchimento** | **Obrigatório** |
| Paginação | Quantidade de registros/regras a serem entregues por página. Limite máximo 1.000. | Sim |
| Ponteiro | Ponteiro do controle de atualização. | Sim |
| -Para carga inicial (recebimento de todos os registros), informar 0. | ||
| -Para atualizações, informar o ponteiro retornado na primeira chamada da carga anterior. | ||
| paramProxPag | É o dado recebido no response que identificará quais registros devem retornar na próxima página. Na primeira chamada do processo, informar 0. Sempre que retornado o campo "paramProxPag" no response, deverá ser feita mais uma chamada para obter a próxima página. A partir da 2ª chamada, informar no parâmetro "paramProxPagina" o valor retornado no campo "paramProxPagina" do response da página anterior. O conteúdo retornado neste campo é sempre equivalente a concatenação dos dados do último registro retornado na página (IdCenario + codigoProduto + origemProduto), que também será o primeiro a retornar na próxima página. \**Os dados apresentados nesta Tag estão parametrizados em base64.* | Sim |
| **Campo** | **Pai** | **Descrição** |
| Ponteiro | - | Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo. Essa informação é retornada na primeira página do processo de carga e deverá ser armazenada para servir de parâmetro para utilização na próxima carga, que identificará quais registros já foram recebidas no processo anterior e, portanto, não deverão ser entregues novamente. |
| codStatus | status | Código de retorno |
| msgStatus | status | Mensagem de retorno |
| paramProxPag | - | Retorna o resultado da concatenação de "IdCenario + codigoProduto + origemProduto" do último registro retornado nesta página. O objetivo é usar este valor como parâmetro na request da próxima página para definir quais regras devem retornar nesta, assim a primeira regra a ser entregue deverá ser a regra do produto e cenário identificados nesta concatenação e as próximas regras deverão ser as que são subsequentes à primeira. |
| cenario | - | Os campos retornados neste bloco são os mesmos campos de cenário e produto existentes em nossas APIs de cadastros. Para consultar mais detalhes, [clique aqui](https://documentacao.systax.com.br/books/manual-de-cadastro-de-produtos-e-cenarios-cfm "Manual de cadastro de Produtos e Cenários"). |
| **cod\_status** | **msg\_status** |
| 200 | Sucesso |
| 401 | Token ou Login/ Senha inválidos |
| 500 | Falha na aplicação |
| 901 | Usuario sem cliente |
| 902 | Cliente sem connection string |