O NCM poderá ter a seguintes informações:
...
...
...
...
Alíquota estadual média para o código de NCM na tabela IBPT do estado.
Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas.
...
Alíquota municipal média para o código de NCM na tabela IBPT do estado.
Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas.
...
...
...
Alíquota nacional média para o código de NCM na tabela IBPT do estado.
Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas
...
Alíquota importada média para o código de NCM na tabela IBPT do estado.
Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas.
| label | Descrição dos campos e regras |
|---|
|
|
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. Para emissão da XML da venda, produtos com substituição tributária devem conter a informação do CEST. Essa informação possui dois locais para o cadastro, diretamente no produto e no NCM. Caso o produto não tenha essa informação, será usado o valor presente na tabela no NCM, mas caso exista o valor CEST na tabela produto, era será a presente na XML |
| Informações |
|---|
| No caso de configurado o uso do ACBr os dados do NCM e alíquotas da Lei de Olho no Imposto são coletados da tabela tributo_ncm |
Tributo NCM | Informação | Coluna | Obrigatório | Tipo | Tamanho | Descrição |
|---|
| Identificação no retaguarda | id_retaguarda | Não | Texto | 100 |
| | Código do NCM | ncm | Não | Numérico |
| Código do NCM com 8 dígitos. | | Alíquota nacional | aliqnac | Não | Numérico |
| Alíquota nacional média para o código de NCM na tabela IBPT do estado. Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas | | Alíquota importada | aliqimp | Não | Numérico |
| Alíquota importada média para o código de NCM na tabela IBPT do estado. Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas. | | Alíquota estadual | aliqest | Não | Numérico |
| Alíquota estadual média para o código de NCM na tabela IBPT do estado. Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas. | | Alíquota municipal | aliqmun | Não | Numérico |
| Alíquota municipal média para o código de NCM na tabela IBPT do estado. Para emissão da XML da venda, a partir do calculo das alíquotas nacional, importada, municipal e estadual é preenchido a TAG vTotTrib. E na TAG infCpl é descrito o valor resultante desse calculo de cada uma das alíquotas. | | Fonte de referência as alíquotas nacional, importada e estadual | fonte | Não | Texto | 100 | Fonte de onde foi retirada os valores de alíquota nacional, importada estadual e municipal. Normalmente essa fonte é informada como "IBPT", correspondente a "Instituto Brasileiro de Planejamento e Tributação" | | Chave do NCM | chave | Não | Texto | 100 | Chave contida na tabela IBPT do estado |
| inivigen | Não | Data |
|
|
| fimvigen | Não | Data |
|
|
| ativo | Sim | Inteiro |
|
|
| processado | Não | Numérico |
|
| | Código de exceção do NCM | excecaoncm | Não | Texto | 3 | Código de exceção do NCM com até 3 dígitos | | Situação | situacao | Não | Inteiro |
| Define se o NCM em questão está ativo ou inativo. | | Data de cadastro | data_cadastro | Sim | Data |
| Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente | | Data de atualização | data_atualizacao | Sim | Data |
| Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente. |
|
| Card |
|---|
| POST api/retaguarda/{Versão}/ncms
Este método é responsável pela criação de novos NCMs - Endpoints:
- /api/retaguarda/v2/ncms
- /api/retaguarda/v3/ncms
- /api/retaguarda/v3/dadosdinamicos/down/8/{Versão Dado}
- 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 | Aviso |
|---|
Para que a baixa do NCM criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 8 = NCM |
| Deck of Cards |
|---|
| | Card |
|---|
| Requisição| Section |
|---|
| Column |
|---|
| 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
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | 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 | Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
|
|
|
|
| Card |
|---|
| | Informações |
|---|
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| Section |
|---|
| Column |
|---|
| 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
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | 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| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
|
|
|
|
| Card |
|---|
| O Dado dinâmico é uma nova forma para envio de dados entre PDV e Retaguarda. - Endpoint: /api/retaguarda/v3/dadosdinamicos/down/8/{Versão Dado}
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Versão dado| Versão requisição | Versão dado |
|---|
| V3.1 | 1 | | V3.2 | 2 |
| Aviso |
|---|
A propriedade {Versão Dado}, enviado na URL da requisição, deve ser substituído pela versão do dado que será enviado. O body da requisição é o mesmo enviado no endpoint padrão. Consulte as outras abas dessa seção para ver o que deve ser enviado na requisição de acordo com a versão dado enviado na URL. |
|
|
|
|
