Cadastro de locações de estoque
O objetivo deste serviço é realizar a inclusão de um produto no estoque. Abaixo, segue exemplo do json de envio:
{
"inventory_insert":
{
"code": 1,
"description": "Monitor LED",
"model_id": 10,
"serial_controlled": true,
"unit_id": 5,
"sale_price": 500.25,
"text": "",
"allow_discount": true,
"accounting_number": "",
"minimum_quantity": 10.50,
"quantity_per_lot": 100.25,
"operation_type_workforce": "consumption",
"ncm": 2658745,
"ean": "",
"ean_trib": "",
"ex_tipi": "",
"efd_icms_ipi_item": "",
"allows_movement": true,
"status": "A",
"tax_group_id": null,
"invoice":
{
"nfe_oper_venda":
{
"id_nat_oper": 1,
"cod_benef_fiscal": "PR000001",
"cest": 1234567,
"cfop": 5159,
"tipo_valor_item": "B",
"informacoes_adicionais": "",
"icms":
{
"csosn": "100",
"origem": "0",
"mod_base_calc": "0",
"perc_red_base_calc": 0,
"valor_base_calc": 100,
"aliquota": 10,
"valor": 10,
"aliquota_calculo_credito": 1.25,
"valor_credito": 100.25,
"st":
{
"mod_base_calc": "0",
"perc_margem_valor_adic": 0,
"perc_reducao_base_calc": 0,
"valor_base_calc": 100,
"aliquota": 10.15,
"valor": 10.15
}
},
"ipi":
{
"sit_trib": "00",
"cod_enq": "aaa",
"cod_selo": "",
"qtde_selo": 1,
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor_unitario": null
},
"pis":
{
"sit_trib": "01",
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null,
"st":
{
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null
}
},
"cofins":
{
"sit_trib": "01",
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null,
"st":
{
"tipo_calculo": "V",
"valor_base_calc": null,
"aliquota": 10,
"quantidade": 15,
"valor": 150
}
}
}
},
"nfe_oper_comodato":
{
"id_nat_oper": 1,
"cod_benef_fiscal": "PR000001",
"cest": 1234567,
"cfop": 5159,
"tipo_valor_item": "B",
"informacoes_adicionais": "",
"icms":
{
"csosn": "100",
"origem": "0",
"mod_base_calc": "0",
"perc_red_base_calc": 0,
"valor_base_calc": 100,
"aliquota": 10.15,
"valor": 10,
"aliquota_calculo_credito": 1.25,
"valor_credito": 100.25,
"st":
{
"mod_base_calc": "0",
"perc_margem_valor_adic": 15.15,
"perc_reducao_base_calc": 10.21,
"valor_base_calc": 100,
"aliquota": 10.15,
"valor": 10.15
}
},
"ipi":
{
"sit_trib": "00",
"cod_enq": "aaa",
"cod_selo": "",
"qtde_selo": 1,
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor_unitario": null
},
"pis":
{
"sit_trib": "01",
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null,
"st":
{
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null
}
},
"cofins":
{
"sit_trib": "01",
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null,
"st":
{
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null
}
}
},
"nfe_oper_simples_remessa":
{
"id_nat_oper": 1,
"cod_benef_fiscal": "PR000001",
"cest": 1234567,
"cfop": 5159,
"tipo_valor_item": "B",
"informacoes_adicionais": "",
"icms":
{
"csosn": "100",
"origem": "0",
"mod_base_calc": "0",
"perc_red_base_calc": 0,
"valor_base_calc": 100,
"aliquota": 10.15,
"valor": 10,
"aliquota_calculo_credito": 1.25,
"valor_credito": 100.25,
"st":
{
"mod_base_calc": "0",
"perc_margem_valor_adic": 15.15,
"perc_reducao_base_calc": 10.21,
"valor_base_calc": 100,
"aliquota": 10.15,
"valor": 10.15
}
},
"ipi":
{
"sit_trib": "00",
"cod_enq": "aaa",
"cod_selo": "",
"qtde_selo": 1,
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor_unitario": null
},
"pis":
{
"sit_trib": "01",
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor_unitario": null,
"st":
{
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor_unitario": null
}
},
"cofins":
{
"sit_trib": "01",
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null,
"st":
{
"tipo_calculo": "P",
"valor_base_calc": 100,
"aliquota": 10.15,
"quantidade": null,
"valor": null
}
}
}
}
}Detalhamento dos campos
| ID | Campo | Obrigatório | Pai | Tipo | Observações |
| A01 | inventory_insert | Sim | Raiz | - | |
| A02 | code | Sim | A01 | Texto (15) |
Código do produto. Este código não pode se repetir em mais de um produto. |
| A03 | description | Sim | A01 | Texto (50) |
Descrição do produto |
| A04 | model_id | Sim | A01 | Inteiro |
Código do modelo de produto |
| A05 | serial_controlled | Sim | A01 | Booleano |
Indica se o produto é controlado por serial.
|
| A06 | unit_id | Sim | A01 | Inteiro |
Código da unidade do produto |
| A07 | sale_price | Sim | A01 | Decimal (15.2) |
Preço de venda |
| A08 | text | Não | A01 | Texto (100) |
Campo livre para cadastro de observações |
| A09 | allow_discount | Não | A01 | Booleano |
Indica se o produto permite desconto.
|
| A10 | accounting_number | Não | A01 | Texto |
Conta contábil |
| A11 | minimum_quantity | Não | A01 | Decimal (15.2) |
Quantidade mínima do produto |
| A12 | quantity_per_lot | Não | A01 | Decimal (15.2) |
Quantidade por lote de compra |
| A13 | operation_type_workforce | Sim | A01 | Texto |
Tipo de operação para inclusão do item em atendimentos via Workforce. Valores permitidos:
|
| A14 | ncm | Não* | A01 | Inteiro (8) |
Código NCM do produto com 8 dígitos. Este campo é obrigatório se for informado o campo A22. |
| A15 | ean | Não | A01 | Texto (14) |
Código EAN do produto |
| A16 | ean_trib | Não | A01 | Texto (14) |
Código EAN da quantidade tributável do produto |
| A17 | ex_tipi | Não | A01 | Texto (3) |
Código EX da TIPI do produto |
| A18 | efd_icms_ipi_item | Sim | A01 | Texto |
Código do tipo do item para geração do arquivo sped fiscal edf icms ipi. Valores permitidos:
|
| A19 | allows_movement | Não | A01 | Booleano |
Indica se o produto pode ser movimentado, no caso do campo A18 conter um dos valores: 07 ou 08.
Para qualquer outro valor no campo A18, este campo não deve ser informado ou deve ser informado com o valor true. |
| A20 | status | Sim | A01 | Texto |
Situação do produto. Valores permitidos:
|
| A21 | tax_group_id | Não | A01 | Inteiro |
Código do grupo de cobrança. Este campo só pode ser utilizado nos países que utilizam este grupo (no momento, apenas Argentina). |
| A22 | invoice | Não | A01 | - |
Grupo de informações para NF-e. São permitidos 3 campos neste grupo:
Os 3 grupos possuem a mesma estrutura e os mesmos campos. Dessa forma, a seguir, será exibido apenas o primeiro. Todas as regras dos demais são as mesmas. |
| B01 | nfe_oper_venda | Não | A01 | - |
Grupo de informações para emissão de NF-e na operação Venda |
| C01 | id_nat_oper | Sim | B01 | Inteiro |
Código da natureza de operação. Deve ser uma natureza de operação Ativa, de NF-e e de tipo 1-Saída. |
| C02 | cod_benef_fiscal | Não | B01 | Texto (10) |
Código de Benefício Fiscal na UF. Este campo deve conter 8 ou 10 dígitos. |
| C03 | cest | Não | B01 | Texto (7) |
Código Especificador da Substituição Tributária |
| C04 | cfop | Sim | B01 | Inteiro (4) |
Código Fiscal de Operações e Prestações. Deve ser informado um dos códigos permitidos para a natureza de informação informada. |
| C05 | tipo_valor_item | Sim | B01 | Texto |
Indica como o valor do item será composto. Valores permitidos:
|
| C06 | informacoes_adicionais | Não | B01 | Texto (500) |
Campo livre |
| C07 | icms | Sim | B01 | - |
Grupo de informações do ICMS |
| D01 | cst | Sim* | C01 | Texto |
Código de Situação Tributária. Deve ser informado apenas para contribuintes no Regime Tributário Normal. Valores permitidos:
|
| D02 | csosn | Sim* | C01 | Texto |
Código de Situação da Operação no Simples Nacional. Deve ser informado apenas para contribuintes no Regime Tributário Simples Nacional. Valores permitidos:
|
| D03 | origem | Não* | C01 | Texto |
Origem da mercadoria. Valores permitidos:
|
| D04 | mod_base_calc | Não* | C01 | Texto |
Modalidade de determinação da Base de Cálculo do ICMS. Valores permitidos:
|
| D05 | perc_red_base_calc | Não* | C01 | Decimal (5.2) |
Percentual da Redução da Base de Cálculo do ICMS |
| D06 | valor_base_calc | Não* | C01 | Decimal (15.2) |
Valor da Base de Cálculo do ICMS |
| D07 | aliquota | Não* | C01 | Decimal (5.2) |
Alíquota do ICMS |
| D08 | valor | Não* | C01 | Decimal (15.2) |
Valor do ICMS O valor do ICMS sempre será calculado pelo sistema - quando aplicável - através da multiplicação dos campos D06 e D07. |
| D09 | aliquota_calculo_credito | Não* | C01 | Decimal (5.2) |
Alíquota aplicável de cálculo do crédito. Este campo deve ser informado apenas para os códigos de CSOSN (campo D02): 101, 201, 900 |
| D10 | valor_credito | Não* | C01 | Decimal (15.2) |
Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123. Este campo deve ser informado apenas para os códigos de CSOSN (campo D02): 101, 201, 900 |
| D11 | st | Não* | C01 | - |
Grupo de informações de Substituição Tributária |
| E01 | mod_base_calc | Não* | D11 | Texto |
Modalidade de determinação da Base de Cálculo do ICMS ST. Valores permitidos:
|
| E02 | perc_margem_valor_adic | Não* | D11 | Decimal (5.2) |
Percentual da margem de valor Adicionado do ICMS ST |
| E03 | perc_reducao_base_calc | Não* | D11 | Decimal (5.2) |
Percentual da Redução de Base de Cálculo do ICMS ST |
| E04 | valor_base_calc | Não* | D11 | Decimal (15.2) |
Valor da Base de Cálculo do ICMS ST |
| E05 | aliquota | Não* | D11 | Decimal (5.2) |
Alíquota do ICMS ST |
| E06 | valor | Não* | D11 | Decimal (15.2) |
Valor do ICMS ST O valor do ICMS ST sempre será calculado pelo sistema - quando aplicável - através da multiplicação dos campos E04 e E05. Exceções: CST = 60 ou CSOSN = 500. Para estes, o valor deverá ser informado neste campo. |
| C08 | ipi | Não | B01 | - |
Grupo de informações do IPI |
| F01 | sit_trib | Sim | C08 | Texto |
Código da situação tributária do IPI. Valores permitidos:
|
| F02 | cod_enq | Não* | C08 | Texto (3) |
Código de Enquadramento Legal do IPI |
| F03 | cod_selo | Não* | C08 | Texto (60) |
Código do selo de controle IPI |
| F04 | qtde_selo | Não* | C08 | Decimal (16.4) |
Quantidade de selo de controle |
| F05 | tipo_calculo | Não* | C08 | Texto |
Tipo de cálculo. Valores permitidos:
|
| F06 | valor_base_calc | Não* | C08 | Decimal (15.2) |
Valor da base de cálculo do IPI Informar apenas se for informado o valor P no campo F05. |
| F07 | aliquota | Não* | C08 | Decimal (5.2) |
Alíquota do IPI Informar apenas se for informado o valor P no campo F05. |
| F08 | quantidade | Não* | C08 | Decimal (16.4) |
Quantidade total na unidade padrão para tributação Informar apenas se for informado o valor V no campo F05. |
| F09 | valor_unitario | Não* | C08 | Decimal (15.4) |
Valor por unidade Informar apenas se for informado o valor V no campo F05. |
| C09 | pis | Sim | B01 | - |
Grupo de informações do PIS |
| G01 | sit_trib | Sim | C09 | Texto |
Código de Situação Tributária do PIS. Valores permitidos:
|
| G02 | tipo_calculo | Não* | C09 | Texto |
Tipo de cálculo. Valores permitidos:
Este campo não pode ser informado para os códigos de situação tributária (campo G01): 01, 02, 03, 04, 06, 07, 08, 09 |
| G03 | valor_base_calc | Não* | C09 | Decimal (15.2) |
Valor da base de cálculo do PIS Informar apenas se for informado o valor P no campo G02. |
| G04 | aliquota | Não* | C09 | Decimal (15.4) |
Alíquota do PIS. Informar em reais quando for informado o valor V no campo G02. |
| G05 | quantidade | Não* | C09 | Decimal (16.4) |
Quantidade vendida Informar apenas se for informado o valor V no campo G02. |
| G06 | valor | Não* | C09 | Decimal (15.2) |
Valor do PIS Informar apenas se for informado o valor V no campo G02. O valor do PIS será calculado pelo sistema - quando aplicável - através da multiplicação dos campos G03 e G04 para:
|
| G07 | st | Não* | C09 | - |
Grupo de informações do PIS Substituição Tributária |
| H01 | tipo_calculo | Não* | G07 | Texto |
Tipo de cálculo. Valores permitidos:
|
| H02 | valor_base_calc | Não* | G07 | Decimal (15.2) |
Valor da base de cálculo do PIS ST Informar apenas se for informado o valor P no campo H01. |
| H03 | aliquota | Não* | G07 | Decimal (15.4) |
Alíquota do PIS ST Informar apenas se foi informado um valor no campo H01. Informar em reais quando for informado o valor V no campo H01. |
| H04 | quantidade | Não* | G07 | Decimal (16.4) |
Quantidade vendida Informar apenas se for informado o valor V no campo H01. |
| H06 | valor | Não* | G07 | Decimal (15.2) |
Valor do PIS ST Informar apenas se for informado o valor V no campo H01. O valor do PIS ST será calculado pelo sistema através da multiplicação dos campos H02 e H03 quando for informado o valor P no campo H01. |
| C10 | cofins | Sim | B01 | - |
Grupo de informações da COFINS |
| I01 | sit_trib | Sim | C10 | Texto |
Código de Situação Tributária da COFINS. Valores permitidos:
|
| I02 | tipo_calculo | Não* | C10 | Texto |
Tipo de cálculo. Valores permitidos:
Este campo não pode ser informado para os códigos de situação tributária (campo I01): 01, 02, 03, 04, 06, 07, 08, 09 |
| I03 | valor_base_calc | Não* | C10 | Decimal (15.2) |
Valor da base de cálculo da COFINS Informar apenas se for informado o valor P no campo I02. |
| I04 | aliquota | Não* | C10 | Decimal (15.4) |
Alíquota da COFINS. Informar em reais quando for informado o valor V no campo I02. |
| I05 | quantidade | Não* | C10 | Decimal (16.4) |
Quantidade vendida Informar apenas se for informado o valor V no campo I02. |
| I06 | valor | Não* | C10 | Decimal (15.2) |
Valor da COFINS Informar apenas se for informado o valor V no campo I02. O valor da COFINS será calculado pelo sistema - quando aplicável - através da multiplicação dos campos I03 e I04 para:
|
| I07 | st | Não* | C10 | - |
Grupo de informações da COFINS Substituição Tributária |
| J01 | tipo_calculo | Não* | I14 | Texto |
Tipo de cálculo. Valores permitidos:
|
| J02 | valor_base_calc | Não* | I14 | Decimal (15.2) |
Valor da base de cálculo do COFINS ST Informar apenas se for informado o valor P no campo J01. |
| J03 | aliquota | Não* | I14 | Decimal (15.4) |
Alíquota do COFINS ST Informar apenas se foi informado um valor no campo J01. Informar em reais quando for informado o valor V no campo J01. |
| J04 | quantidade | Não* | I14 | Decimal (16.4) |
Quantidade vendida Informar apenas se for informado o valor V no campo J01. |
| J05 | valor | Não* | I14 | Decimal (15.2) |
Valor da COFINS ST Informar apenas se for informado o valor V no campo J01. O valor da COFINS ST será calculado pelo sistema através da multiplicação dos campos J02 e J03 quando for informado o valor P no campo J01. |
Clique aqui para baixar exemplos de json para cada grupo de imposto (icms/cst, icms/csosn, ipi, pis e cofins).
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result":
{
"id": 297
}
}Em caso de falha, será retornado um json conforme o exemplo abaixo:
</syntaxhighlight>
{
"status": 0,
"error_code": 19,
"error_description": "Unknown error!",
"result": ""
}