Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleDefinição dos campos de requisição
{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Campo

Tipo

Descrição

Observações

codigoNcmstringCódigo NCM

Obrigatório

Tamanho: 8 caracteres

codigoExcecaostringCódigo de exceção

Opcional

Tamanho máximo: 3 caracteres

aliquotaNacionalstring

Aliquota nacional

Opcional

aliquotaImportada

stringAliquota importadaOpcional

aliquotaEstadual

stringAliquota EstadualOpcional

aliquotaMunicipal

stringAliquota MunicipalOpcional

chave

stringChave NCM

Opcional

Tamanho máximo: 128 caracteres

fonte

stringFonte NCM

Opcional

Tamanho máximo: 128 caracteres

situacao

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

codigoCest

stringCódigo cest

Opcional

Tamanho: 7 caracteres

idInquilino

stringIdentificador do inquilinoObrigatório

idRetaguarda

stringIdentificador do NCM na retaguardaObrigatório

idProprietario

string

Identificador do proprietário

Obrigatório

loteOrigem

stringIdentificação do lote em que os dados serão enviados
Expandir
titleRetorno da requisição
Obrigatório para a integração
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
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
Dica

Para saber mais sobre compartilhamento clique aqui