Este método é responsável pela criação de novos NCMs
- Endpoint: /api/retaguarda/v2/ncms
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de NCMs para que possam ser enviados vários na mesma requisição
Para que a baixa do NCM criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 8 = NCM
Requisição
Exemplo de body da requisição
[
{
"aliquotaEstadual": "string",
"aliquotaImportada": "string",
"aliquotaMunicipal": "string",
"aliquotaNacional": "string",
"chave": "string",
"codigoCest": "string",
"codigoExcecao": "string",
"codigoNcm": "string",
"fonte": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"situacao": 0
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
|---|---|---|---|---|
codigoNcm |
string |
Código NCM |
Sim |
Tamanho: 8 caracteres |
| codigoExcecao | string | Código de exceção | Não |
Tamanho máximo: 3 caracteres |
| aliquotaNacional | string | Aliquota nacional |
Não | |
aliquotaImportada |
string | Aliquota importada | Não | |
aliquotaEstadual |
string | Aliquota Estadual | Não | |
aliquotaMunicipal |
string | Aliquota Municipal | Não | |
chave |
string | Chave NCM | Não |
Tamanho máximo: 128 caracteres |
fonte |
string | Fonte NCM | Não |
Tamanho máximo: 128 caracteres |
situacao |
int | Sítuação do NCM | Sim | 0 - inativo, 1 - ativo |
codigoCest |
string | Código cest | Não |
Tamanho: 7 caracteres |
idInquilino |
string | Identificador do inquilino | Sim | |
idRetaguarda |
string | Identificador do NCM na retaguarda | Sim | Tamanho máximo: 100 caracteres |
idProprietario |
string | Identificador do proprietário |
Sim | |
loteOrigem |
string | Identificação do lote em que os dados serão enviados | Sim |
Retorno
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
| Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
| Data | objeto | Objeto compartilhamento criado |
| Errors | Lista | Listas com os erros encontrados no processo |
| TotalTime | int | tempo da requisição |
| NumberOfRecords | int | número de dados inseridos |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| code | string | Código de erro |
| message | string | Mensagem do erro |
| detailedMessage | string | Detalhamento do erro |
| helpUrl | string | url de ajuda |
| TotalTime | string | Tempo total de busca |
| details | lista de objeto | Lista de objeto de erros |
| details.guid | string | Identificador do erro |
| details.code | string | Código do erro |
| details.message | string | Mensagem do erro |
| details.detailedMessage | string | Detalhamento do erro |
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição.
Requisição
Exemplo de body da requisição
[
{
"aliquotaEstadual": 0.0,
"aliquotaImportada": 0.0,
"aliquotaMunicipal": 0.0,
"aliquotaNacional": 0.0,
"chave": "string",
"codigoCest": "string",
"codigoExcecao": "string",
"codigoNcm": "string",
"fonte": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"situacao": 0
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
|---|---|---|---|---|
| codigoNcm | string | Código do NCM com 8 dígitos. | Sim |
Tamanho: 8 caracteres |
| codigoExcecao | string | Código de exceção do NCM com até 3 dígitos | Não |
Tamanho máximo: 3 caracteres |
| aliquotaNacional | numérico | Alíquota nacional média para o código de NCM na tabela IBPT do estado. |
Não | |
aliquotaImportada |
numérico | Alíquota importada média para o código de NCM na tabela IBPT do estado. | Não | |
aliquotaEstadual |
numérico | Alíquota estadual média para o código de NCM na tabela IBPT do estado. | Não | |
aliquotaMunicipal |
numérico | Alíquota municipal média para o código de NCM na tabela IBPT do estado. | Não | |
chave |
string | Chave contida na tabela IBPT do estado | Não |
Tamanho máximo: 128 caracteres |
fonte |
string | Fonte de onde foi retirada os valores de alíquota nacional, importada estadual e municipal. | Não |
Tamanho máximo: 128 caracteres |
situacao |
int | Sítuação do NCM | Sim | 0 - inativo, 1 - ativo |
codigoCest |
string | A relação entre o NCM e o CEST ocorre pois o CEST utiliza o NCM como base para a sua classificação. Para o PDV o CEST pode estar vinculado ao produto e ao NCM. O CEST identificado no produto terá prioridade sobre ao identificado no NCM. | Não |
Tamanho máximo: 20 caracteres |
idInquilino |
string | Identificador do inquilino | Sim | |
idRetaguarda |
string | Identificador do NCM na retaguarda | Sim | Tamanho máximo: 100 caracteres |
idProprietario |
string | Identificador do proprietário |
Sim | |
loteOrigem |
string | Identificação do lote em que os dados serão enviados | Sim |
Retornos
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
| Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
| Data | objeto | Objeto compartilhamento criado |
| Errors | Lista | Listas com os erros encontrados no processo |
| TotalTime | int | tempo da requisição |
| NumberOfRecords | int | número de dados inseridos |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| code | string | Código de erro |
| message | string | Mensagem do erro |
| detailedMessage | string | Detalhamento do erro |
| helpUrl | string | url de ajuda |
| TotalTime | string | Tempo total de busca |
| details | lista de objeto | Lista de objeto de erros |
| details.guid | string | Identificador do erro |
| details.code | string | Código do erro |
| details.message | string | Mensagem do erro |
| details.detailedMessage | string | Detalhamento do erro |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas