POST api/retaguarda/v2/ncms

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

Exemplo de body da requisição

[
{
"codigoNcm": "string",
"codigoExcecao": "string",
"aliquotaNacional": "string",
"aliquotaImportada": "string",
"aliquotaEstadual": "string",
"aliquotaMunicipal": "string",
"chave": "string",
"fonte": "string",
"situacao": 0,
"codigoCest": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
]

Definição dos campos de requisição

Campo	Tipo	Descrição	Observações
codigoNcm	string	Código NCM	Obrigatório Tamanho: 8 caracteres
codigoExcecao	string	Código de exceção	Opcional Tamanho máximo: 3 caracteres
aliquotaNacional	string	Aliquota nacional	Opcional
aliquotaImportada	string	Aliquota importada	Opcional
aliquotaEstadual	string	Aliquota Estadual	Opcional
aliquotaMunicipal	string	Aliquota Municipal	Opcional
chave	string	Chave NCM	Opcional Tamanho máximo: 128 caracteres
fonte	string	Fonte NCM	Opcional Tamanho máximo: 128 caracteres
situacao	int	Sítuação do NCM (0 - inativo, 1 - ativo)	Obrigatório
codigoCest	string	Código cest	Opcional Tamanho: 7 caracteres
idInquilino	string	Identificador do inquilino	Obrigatório
idRetaguarda	string	Identificador do NCM na retaguarda	Obrigatório
idProprietario	string	Identificador do proprietário	Obrigatório
loteOrigem	string	Identificação do lote em que os dados serão enviados	Obrigatório para a integração

Definição dos campos de retorno

200 - Ok

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

Body de retorno

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

400 - Bad Request

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

Atalhos

Árvore de páginas