Documentação
Informações fiscais do produto
Referência de cada atributo de product.fiscal, formatos e limites de exposição.
Onde o objeto aparece
| Rota | Local |
|---|---|
GET /v1/products | categories[].products[].fiscal, sendo a resposta um array de categorias. |
GET /v1/products/{productId} | product.fiscal no objeto retornado. |
POST /v1/products, PUT /v1/products/{productId}, PATCH /v1/products/{productId}/availability | fiscal no produto retornado. |
PUT /v1/products/bulk | fiscal em cada produto retornado. |
GET /v1/menu?include_fiscal_info=true | categories[].products[].fiscal. O menu não inclui dados fiscais por padrão. |
As permissões e o isolamento por restaurante não mudam. As leituras de produtos
exigem products:read para OAuth; o menu exige menu:read. Sessões verificadas
continuam restritas ao próprio restaurante.
As respostas de detalhe/escrita mantêm fiscal_info como alias de
compatibilidade, com os mesmos atributos públicos. O menu retorna apenas
fiscal quando a opção é habilitada, sem alias.
fiscal é o nome da nova projeção de leitura; o corpo de edição continua usando
fiscal_info. Não copie o produto inteiro para um PUT.
Formato e interpretação
Todos os 32 atributos abaixo são string | null. O objeto fiscal tem
estrutura estável mesmo sem cadastro fiscal: nesse caso, os atributos são
null. Um valor nulo significa ausência de informação, não alíquota zero,
isenção ou confirmação de que o campo não se aplica.
Códigos preservam zeros à esquerda. Campos textuais preservam o conteúdo cadastrado, inclusive casas decimais, strings vazias e valores legados com vírgula. O FCP, armazenado como decimal, é serializado como string numérica, sem garantia de zeros decimais à direita. Não converta códigos em números.
A resposta é uma fotografia do cadastro do produto, não uma nota fiscal, um cálculo de tributos ou uma validação tributária. Não resolve valores por herança do grupo fiscal nem presume que um cadastro incompleto está correto. Confirme códigos, enquadramentos e valores com o responsável fiscal antes de emitir.
Referência dos atributos
Atributo de fiscal | Significado |
|---|---|
ncm | Código da Nomenclatura Comum do Mercosul, classificação da mercadoria. |
cfop | Código Fiscal de Operações e Prestações cadastrado para o produto. |
csosn | Código de Situação da Operação no Simples Nacional (ICMS). |
cst | Código de Situação Tributária do ICMS no regime normal. |
cest | Código Especificador da Substituição Tributária. |
icms_origem | Código de origem da mercadoria usado no ICMS; não é endereço ou país em texto livre. |
aliquota | Alíquota genérica legada, preservada como cadastrada; não é alias de icms_aliquota nem define um tributo por si só. |
base_calculo | Base de cálculo genérica legada; não inferimos tributo, unidade ou valor calculado a partir deste campo. |
pis | Código de situação tributária do PIS, não sua alíquota. |
cofins | Código de situação tributária da COFINS, não sua alíquota. |
pis_aliquota | Alíquota percentual de PIS cadastrada. |
cofins_aliquota | Alíquota percentual de COFINS cadastrada. |
icms_modalidade_base_calculo | Código da modalidade de determinação da base de cálculo do ICMS. |
icms_aliquota | Alíquota de ICMS cadastrada; o FCP tem campo próprio. |
icms_valor | Valor de ICMS cadastrado; não é o imposto calculado para um pedido. |
cbenef | Código de benefício fiscal estadual (cBenef). |
fcp_percentual | Percentual do Fundo de Combate à Pobreza (FCP). |
icms_base_calculo_retido_st | Base de cálculo do ICMS-ST retido anteriormente. |
icms_aliquota_final | Alíquota de ICMS-ST suportada pelo consumidor final. |
icms_valor_retido_st | Valor de ICMS-ST retido anteriormente. |
icms_valor_substituto | Valor do ICMS próprio do substituto tributário na operação anterior. |
icms_reducao_base_calculo | Percentual de redução da base de cálculo do ICMS. |
icms_motivo_desoneracao | Código do motivo de desoneração do ICMS. |
icms_valor_desonerado | Valor de ICMS desonerado cadastrado. |
icms_aliquota_credito_simples | Alíquota percentual de crédito de ICMS do Simples Nacional. |
icms_valor_credito_simples | Valor de crédito de ICMS do Simples Nacional cadastrado. |
ibs_cbs_situacao_tributaria | Código de situação tributária de IBS/CBS cadastrado. |
ibs_cbs_classificacao_tributaria | Código de classificação tributária de IBS/CBS (cClassTrib) cadastrado. |
icms_modalidade_base_calculo_st | Código da modalidade de determinação da base de cálculo do ICMS-ST. |
icms_margem_valor_adicionado_st | Percentual da margem de valor adicionado (MVA) do ICMS-ST. |
icms_reducao_base_calculo_st | Percentual de redução da base de cálculo do ICMS-ST. |
icms_aliquota_st | Alíquota de ICMS-ST cadastrada. |
As descrições seguem o cadastro legado e a terminologia da Receita Federal para NCM e da referência técnica de campos fiscais. São descrições dos dados, não recomendações de classificação ou alíquota.
Dados deliberadamente omitidos
O identificador interno fiscal_group_id não aparece em fiscal nem no alias
fiscal_info. Custos/CMV, margens comerciais, identificadores de infraestrutura,
histórico de alterações, credenciais de emissores, certificados e dados de
clientes não fazem parte da projeção. A margem tributária icms_margem_valor_adicionado_st
é a MVA fiscal, não a margem comercial do restaurante.
A inclusão deste objeto não acrescenta rotas, permissões de escrita ou alterações de schema. Consulte Gerenciar produtos para as operações já disponíveis.