Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleExemplo de body da requisição

[
    {
        "codigoNcmaliquotaEstadual": "string"0.0,
        "codigoExcecaoaliquotaImportada": "string"0.0,
        "aliquotaNacionalaliquotaMunicipal": "string"0.0,
        "aliquotaImportadaaliquotaNacional": "string"0.0,
        "aliquotaEstadualchave": "string",
        "aliquotaMunicipalcodigoCest": "string",
        "chavecodigoExcecao": "string",
        "fontecodigoNcm": "string",
        "situacaofonte": 0"string",
        "codigoCestidInquilino": "string",
        "idInquilinoidProprietario": "string",
        "idRetaguarda": "string",
        "idProprietarioloteOrigem": "string",
        "loteOrigemsituacao": "string"0
    }
]

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

Obrigatório

codigoNcmstringCódigo
NCMObrigatório
do NCM com 8 dígitos.

Tamanho: 8 caracteres

Sim

codigoExcecaostringCódigo de exceção

Opcional

do NCM com até 3 dígitos

Tamanho máximo: 3 caracteres

Não

aliquotaNacional
string
numérico

Aliquota nacional

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


Não
Opcional

aliquotaImportada

string
numérico
Aliquota importada
Alíquota importada média para o código de NCM na tabela IBPT do estado.
Não
Opcional

aliquotaEstadual

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

aliquotaMunicipal

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

chave

stringChave
NCMOpcional
contida na tabela IBPT do estado

Tamanho máximo: 128 caracteres

Não

fonte

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

Tamanho máximo: 128 caracteres

Não

situacao

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

codigoCest

string
Código cest

Opcional

Tamanho: 7 caracteres
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.

Tamanho máximo: 20 caracteres

Não

idInquilino

stringIdentificador do inquilino
Obrigatório

Sim

idRetaguarda

stringIdentificador do NCM na retaguarda
Obrigatório
Tamanho máximo: 100 caracteresSim

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

Sim
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

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
Expandir
titleBody de retorno

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

Expandir
title400 - Bad Request

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