Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • Endpoint: /api/retaguarda/v2/compartilhamentosncms
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

...

Aviso

Para que a baixa do NCM criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 8 = NCM

titleexpandtitleDefinição de requisição
Deck of Cards
idversções
Card
labelV3.1 (V2)

Requisição

Section
Column
width50%
Expandir

Exemplo de body da requisição

[
    {
        "

codigoNcm

aliquotaEstadual": "string",
        "

codigoExcecao

aliquotaImportada": "string",
        "

aliquotaNacional

aliquotaMunicipal": "string",
        "

aliquotaImportada

aliquotaNacional": "string",
        "

aliquotaEstadual

chave": "string",
        "

aliquotaMunicipal

codigoCest": "string",
        "

chave

codigoExcecao": "string",
        "

fonte

codigoNcm": "string",
        "

situacao

fonte":

0

"string",
        "

codigoCest

idInquilino": "string",
        "

idInquilino

idProprietario": "string",
        "idRetaguarda": "string",
        "

idProprietario

loteOrigem": "string",
        "

loteOrigem

situacao":

"string"

0
    }
]

Column
width
50%

Definições dos campos

do body

Campo

Tipo

Descrição

Obrigatório

Observações

codigoNcm

string

Código NCM

Obrigatório

Sim

Tamanho: 8 caracteres

codigoExcecaostringCódigo de exceção
Opcional

Não

Tamanho máximo: 3 caracteres

aliquotaNacionalstring

Aliquota nacional

Opcional
Não

aliquotaImportada

stringAliquota importada
Opcional
Não

aliquotaEstadual

stringAliquota Estadual
Opcional
Não

aliquotaMunicipal

stringAliquota Municipal
Opcional
Não

chave

stringChave NCM
Opcional

Não

Tamanho máximo: 128 caracteres

fonte

stringFonte NCM
Opcional

Não

Tamanho máximo: 128 caracteres

situacao

intSítuação do NCM
(
Sim0 - inativo, 1 - ativo
)Obrigatório

codigoCest

stringCódigo cest
Opcional

Não

Tamanho: 7 caracteres

idInquilino

stringIdentificador do inquilino
Obrigatório
Sim

idRetaguarda

stringIdentificador do NCM na retaguarda
Obrigatório
SimTamanho máximo: 100 caracteres

idProprietario

string

Identificador do proprietário

Obrigatório
Sim

loteOrigem

stringIdentificação do lote em que os dados serão enviados
Obrigatório para a integração
Expandir
titleDefinição dos campos de retorno
Sim

Retorno

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro
200 - Okexpandtitle
Card
labelV3.2
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
width50%

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
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

codigoNcmstringCódigo do NCM com 8 dígitos.

Sim

Tamanho: 8 caracteres

codigoExcecaostringCódigo de exceção do NCM com até 3 dígitos

Não

Tamanho máximo: 3 caracteres

aliquotaNacionalnumérico

Alíquota nacional média para o código de NCM na tabela IBPT do estado.

Não

aliquotaImportada

numéricoAlíquota importada média para o código de NCM na tabela IBPT do estado. Não

aliquotaEstadual

numéricoAlíquota estadual média para o código de NCM na tabela IBPT do estado. Não

aliquotaMunicipal

numéricoAlíquota municipal média para o código de NCM na tabela IBPT do estado. Não

chave

stringChave contida na tabela IBPT do estado

Não

Tamanho máximo: 128 caracteres

fonte

stringFonte de onde foi retirada os valores de alíquota nacional, importada estadual e municipal.

Não

Tamanho máximo: 128 caracteres

situacao

intSítuação do NCM Sim0 - inativo, 1 - ativo

codigoCest

stringA 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

stringIdentificador do inquilinoSim

idRetaguarda

stringIdentificador do NCM na retaguardaSimTamanho máximo: 100 caracteres

idProprietario

string

Identificador do proprietário

Sim

loteOrigem

stringIdentificação do lote em que os dados serão enviadosSim

Retornos

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Definições dos campos do retorno

Expandir
title

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro