Nome | Tipo | Obrigatório | Descrição |
token | String | Sim | Token gerado atrás da API de obtenção - API Token. |
codigoProduto | Number | Sim | Código único do produto. Deve possuir até 14 caracteres. Campo utilizado como "chave-primária" do cadastro e não pode ser duplicado. Caso enviado com valor 0 e o campo "gerarCodigoProduto" enviado com valor true será gerado um código para o produto incrementando o valor +1 ao código de produto de maior valor registrado na base. |
gerarCodigoProduto | Boolean | Sim | Define se deve ser gerado um novo código de produto para o registro enviado. Caso o valor esteja true, será gerado um código para o produto incrementando o valor +1 ao código de produto de maior valor registrado na base. |
nomeProduto | String | Sim | Campo que define o nome do produto que será exibido no PDV. Deve possuir até 100 caracteres. |
quantidadeEstoque | Decimal | Não | Campo para indicar a quantidade disponível em estoque do produto. |
quantidadeMinima | Decimal | Não | Indica a quantidade mínima de estoque do produto. |
naoExibirNoCardapio | Boolean | Não | Campo que define se o campo deve ou não ser exibido no cardápio. Caso esteja preenchido com true o produto não será exibido no cardápio. |
precoVenda | Decimal | Sim | Preço padrão de venda do produto. Deve ser maior que zero. |
precoCompra | Decimal | Não | Preço pago na compra do produto. |
divididoPor | Decimal | Não | Caso a unidade de entrada seja diferente da de saída, define por qual fator a unidade de entrada deve ser dividida no momento da venda. Ex: Unidade de entrada: CX; Unidade de saída: UN; DivididoPor: 12; Cada CX será equivalerá a 12 UN. |
pesavel | Boolean | Não | Indica se o produto é ou não um produto pesável, ou seja, se é vendido por g/kg. |
pesoLiquido | Decimal | Não | Peso liquido do produto. |
descricaoProduto | String | Não | Descrição do produto para exibição no PDV. Deve possuir até 100 caracteres. |
margemLucro | Decimal | Não | Valor percentual da margem de lucro do produto. |
permitirVendaFracionada | Boolean | Não | Define se o produto pode ser vendido em unidades fracionadas, ou apenas em múltiplos da unidade utilizada. |
localImpressao | String | Não | Campo para especificar se deve ser impresso o cupom em impressora não fiscal em outro local de impressão cadastrado no TOTVS Chef. Caso não seja preenchido, por padrão receberá o valor "NENHUM". |
idNCM | Number | Condicional | Id de registro de NCM cadastrado no TOTVS Chef para definir qual o código NCM será utilizado para o produto. O ID NCM é obrigatório caso a tag <NCM> não seja informada |
NCM | Number | Condicional | Código do NCM utilizado para classificação fiscal do produto. O NCM é obrigatório caso a tag <IDNCM> não seja informada |
idCEST | Number | Não | Id de registro de CEST cadastrado no TOTVS Chef para definir qual o código CEST será utilizado para o produto. |
CEST | Number | Não | Código do CEST utilizado para classificação da substituição tributária do produto. |
idUnidade | Number | Sim | Id de registro de CEST cadastrado no TOTVS Chef para definir qual o código CEST será utilizado para o produto. |
idUnidadeCompra | Number | Sim | Id de registro de Unidade de Medida cadastrado no TOTVS Chef para definir a unidade de medida utilizada no momento da compra do produto. |
idGrupo | Number | Condicional | Id de registro de Grupo cadastrado no TOTVS Chef para definir o grupo ao qual o produto faz parte. O idGrupo é obrigatório caso a tag <Grupo> não seja informada |
Grupo | String | Condicional | Nome do Grupo ao qual o produto será vinculado. O Grupo é obrigatório caso a tag <idGrupo> não seja informada |
idSubGrupo | Number | Condicional | Id de registro de SubGrupo cadastrado no TOTVS Chef para definir o grupo ao qual o produto faz parte. O idSubGrupo é obrigatório caso a tag <SubGrupo> não seja informada |
SubGrupo | String | Condicional | Nome do SubGrupo ao qual o produto será vinculado. O SubGrupo é obrigatório caso a tag <idSubGrupo> não seja informada |
serialLoja | String | Não | Campo que determina para qual loja/gerenciador de franquia a informação será direcionada. Caso não seja preenchido, a informação será armazenada na loja "central". |
origem | Number | Sim | Origem da mercadoria ou serviço. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco, 0 – Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8; 1 – Estrangeira – Importação direta, exceto a indicada no código 6; 2 – Estrangeira – Adquirida no mercado interno, exceto a indicada no código 7; 3 – Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% (quarenta por cento) e igual ou inferior a 70% (setenta por cento) ; 4 – Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam o Decreto-Lei nº 288/1967 , e as Leis nºs 8.248/1991, 8.387/1991, 10.176/2001 e 11.484/2007; 5 – Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%; 6 – Estrangeira – Importação direta, sem similar nacional, constante em lista de Resolução Camex e gás natural; 7 – Estrangeira – Adquirida no mercado interno, sem similar nacional, constante em lista de Resolução Camex e gás natural. 8 – Nacional – Mercadoria ou bem com Conteúdo de Importação superior a 70% (setenta por cento). |
Tributo | String | Sim | Indicador da forma de tributação do ICMS nas vendas do produto T - Indica que as vendas desse produto serão tributadas pelo ICMS I - Indica que as vendas desse produto serão isentas de ICMS F - Indica que as vendas desse produto foram tributadas por substituição tributária de ICMS N - Indica que as vendas desse produto serão não tributadas pelo ICMS |
IAT | String | Sim | Indicador de Arrendamento ou truncamento nas vendas realizadas no PDV. T - Indica que as operações com esse item terão os valores truncados no PDV A - Indica que as operações com esse item terão os valores arredondados no PDV |
IPPT | String | Sim | Indicador de Produção Própria ou de terceiros do produto. T - Indica que o produto foi produzido por terceiros, ou seja, foi comprado ou recebido para venda. P - Indica que o produto foi produzido no estabelecimento onde será realizada a venda. |
CFOP | String | Sim | CFOP que será utilizado nas vendas desse produto realizadas pelo PDV |
tpItem | String | Sim | Tipo do produto que será cadastrado 00 – MERCADORIA PARA REVENDA 01 – MATÉRIA-PRIMA 02 – EMBALAGEM 03 – PRODUTO EM PROCESSO 04 – PRODUTO ACABADO 05 – SUBPRODUTO 06 – PRODUTO INTERMEDIÁRIO 07 – MATERIAL DE USO E CONSUMO 08 – ATIVO IMOBILIZADO 09 – SERVIÇOS 10 – OUTROS INSUMOS 99 – OUTROS |
cstICMS | String | Condicional | Código da Situação Tributária de ICMS, . Deverá ser informado de acordo com a tabela disponibilizada pelo fisco, quando a loja for contribuinte do regime normal. 00 – Tributada integralmente 10 – Tributada e com cobrança do ICMS por substituição tributária 20 – Com redução de base de cálculo 30 – Isenta ou não tributada e com cobrança do ICMS por substituição tributária 40 – Isenta 41 – Não tributada 50 – Suspensão 51 – Diferimento 60 – ICMS cobrado anteriormente por substituição tributária 70 – Com redução de base de cálculo e cobrança do ICMS por substituição tributária 90 – Outras O cstICMS é obrigatório caso a tag <CSOSN> não seja informada |
CSOSN | String | Condicional | Código da CSOSN do ICMS, Deverá ser informado de acordo com a tabela disponibilizada pelo fisco, quando a loja for contribuinte do regime Simples Nacional. 101 Tributada pelo Simples Nacional com permissão de crédito 102 Tributada pelo Simples Nacional sem permissão de crédito 103 Isenção do ICMS no Simples Nacional para faixa de receita bruta 201 Tributada pelo Simples Nacional com permissão de crédito e com cobrança do ICMS por substituição tributária 202 Tributada pelo Simples Nacional sem permissão de crédito e com cobrança do ICMS por substituição tributária 203 Isenção do ICMS no Simples Nacional para faixa de receita bruta e com cobrança do ICMS por substituição tributária 300 Imune 400 Não tributada pelo Simples Nacional 500 ICMS cobrado anteriormente por substituição tributária (substituído) ou por antecipação 900 Outros O CSOSN é obrigatório caso a tag <cstICMS> não seja informada |
aliqICMS | Number | Sim | Aliquota que será utilizada para cálculo de ICMS nas operações de Venda |
redICMS | Number | Não | Percentual de redução que será utilizado para cálculo da base do ICMS nas operações de Venda |
aliqFCP | Number | Sim | Aliquota que será utilizada para cálculo do FCP (FECP) nas operações de Venda |
MVA | Number | Não | Margem de Valor agregado que será utilizada para cálculo da base de ICMS ST nas operações de Venda |
redICMSST | Number | Não | Percentual de redução que será utilizado para cálculo da base do ICMS ST nas operações de Venda |
aliqICMSST | Number | Sim | Aliquota que será utilizada para cálculo de ICMS ST nas operações de Venda |
aliqFCPST | Number | Sim | Aliquota que será utilizada para cálculo do FCP (FECP) ST nas operações de Venda |
modBCICMSST | Number | Sim | Modelo da Base de Cálculo do ICMS ST nas operações de Venda 0 - Preço Tabelado ou Máximo Sugerido 1 - Lista Negativa (Valor) 2 - Lista Positiva (Valor) 3 - Lista Neutra (Valor) 4 - Margem Valor Agregado (%) 5 - Pauta (Valor) |
cBenef | String | Não | Código de Benefício Fiscal, utilizado para indicar qual incentivo fiscal utilizado na operação. Deverá ser cadastrado de acordo com a tabela disponibilizada pelo fisco estadual. |
cstPIS | String | Não | Código da Situação Tributária de PIS. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco. 01 Operação Tributável com Alíquota Básica 02 Operação Tributável com Alíquota Diferenciada 03 Operação Tributável com Alíquota por Unidade de Medida de Produto 04 Operação Tributável Monofásica – Revenda a Alíquota Zero 05 Operação Tributável por Substituição Tributária 06 Operação Tributável a Alíquota Zero 07 Operação Isenta da Contribuição 08 Operação sem Incidência da Contribuição 09 Operação com Suspensão da Contribuição 49 Outras Operações de Saída 99 Outras Operações |
tpCalculoPIS | Number | Não | Tipo de cálculo do PIS nas operações de Venda 0 - Percentual 1 - Valor |
aliqPIS | Number | Não | Aliquota, em percentual ou valor, que será utilizada para cálculo de PIS nas operações de Venda |
cstCofinscBenef | String | Não | Código da Situação Tributária de Cofins. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco. 01 Operação Tributável com Alíquota Básica 02 Operação Tributável com Alíquota Diferenciada 03 Operação Tributável com Alíquota por Unidade de Medida de Produto 04 Operação Tributável Monofásica – Revenda a Alíquota Zero 05 Operação Tributável por Substituição Tributária 06 Operação Tributável a Alíquota Zero 07 Operação Isenta da Contribuição 08 Operação sem Incidência da Contribuição 09 Operação com Suspensão da Contribuição 49 Outras Operações de Saída 99 Outras Operações |
tpCalculoCofins | Number | Não | Tipo de cálculo do Cofins nas operações de Venda 0 - Percentual 1 - Valor |
aliqCofins | Number | Não | Aliquota, em percentual ou valor, que será utilizada para cálculo de Cofins nas operações de Venda |
cstIPI | String | Não | Código da Situação Tributária de IPI de Benefício Fiscal, utilizado para indicar qual incentivo fiscal utilizado na operação. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco estadual. 50 Saída Tributada 51 Saída Tributável com Alíquota Zero 52 Saída Isenta 53 Saída Não-Tributada 54 Saída Imune 55 Saída com Suspensão 99 Outras Saídas |
aliqIPI | Number | Não | Aliquota que será utilizada para cálculo de IPI nas operações de Venda |
codEnqIPI | String | Não | Código de enquadramento de IPI. |