Criar um novo produto

POST 
/:tenantId/products

Cadastra um produto com suas informações tributárias. O id do produto é gerado pelo servidor e devolvido no corpo da resposta 201.

Unicidade: não é possível ter dois produtos com o mesmo collectionId + sku + origin na mesma conta. Uma tentativa duplicada responde 409 com o id do produto já existente.

Valores preenchidos pela API em cada cenário de customTax, antes da validação:

• recipient.taxProfile ausente vira final_consumer_non_icms_contributor;
• operationCode ausente vira 120 quando issuer.taxProfile é industry e 121 nos demais casos;
• issuer.taxRegime ausente é preenchido com o regime tributário da empresa informada em collectionId, quando ela é encontrada;
• tax.exTipi com 1 dígito é completado com zero à esquerda (somente na criação; no PUT um exTipi de 1 dígito é recusado).

Cenários de remessa acrescentados automaticamente: a API acrescenta os cenários 727 (CFOP 5949), 784 (CFOP 1949) e 802 (CFOP 5949), só com o grupo intrastate e para o destinatário closed_warehouse, quando todas as condições abaixo valem:

• nenhum cenário tem issuer.taxRegime NationalSimple (os demais regimes, inclusive NationalSimpleSublimitExceeded, não impedem);
• há ao menos um cenário de venda (operationCode 120 ou 121);
• o produto tem um único cenário ou tem ao menos um cenário de transferência (1108, 2108 ou 3108) com o grupo interstate.

Os cenários acrescentados copiam o issuer e o CST de ICMS do último cenário da lista que tem intrastate; se nenhum cenário tem intrastate, eles ficam sem issuer e a requisição falha. Eles são acrescentados mesmo que a lista enviada já traga cenários 727, 784 ou 802: se a combinação se repetir, o cadastro é recusado pela regra de unicidade. Os cenários acrescentados aparecem na consulta do produto.

Cenários de transferência (1108, 2108, 3108): a API pode sobrescrever cfop, recipient e o CST de ICMS desses cenários, conforme as condições descritas em CustomTaxScenario.operationCode. Informe esses valores explicitamente.

Customização de CST 20 (habilitada por conta): quando a conta tem a customização de CST 20 habilitada e há um cenário de venda (120 ou 121) com intrastate.icms.cst = 20, a API, no primeiro cenário desse tipo, troca interstate.icms.cst por 00 e apaga interstate.icms.pICMS, modBC, pRedBC e pFCP (quando o grupo interstate.icms existe), e copia pICMS, modBC, pRedBC e pFCP do intrastate.icms desse cenário para o intrastate.icms dos cenários 727, 784 e 802 (inclusive os acrescentados automaticamente). Nas contas sem a customização, nada disso acontece. A customização é habilitada pela NFE.io, a pedido do cliente; consulte o suporte para saber se está habilitada na sua conta.

A validação tributária completa dos cenários é assíncrona: acompanhe pelo campo status (veja a descrição geral da API).

Operação cobrada à parte

Criar ou atualizar produtos com regras tributárias registra consumo do Motor de Cálculo de Tributos, serviço cobrado separadamente da emissão da nota fiscal. O valor e a forma de cobrança são definidos no seu plano comercial. Veja Motor de Cálculo de Tributos.

Request

Responses

201

Produto criado. O corpo traz apenas o id gerado; consulte o produto para acompanhar o status.

400

Requisição inválida. Na regra de validação recusada, o corpo traz status e detail com a primeira regra violada (em inglês). Um JSON malformado ou com tipo incompatível (ex.: cfop como texto) responde no formato Problem Details (title, status, errors).

401

Credencial ausente ou inválida.

409

Já existe produto com o mesmo collectionId + sku + origin nesta conta. O id do produto existente é devolvido.

500

Erro inesperado. Tente novamente; se persistir, acione o suporte com o horário da chamada.