Requisição
URL: https://api.erpeasy.compels.net/itemNotaICMS
Method: GET
Os argumentos são:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| notaICMSId | N | Não | Identificador interno da nota fiscal de ICMS |
| tipo | A | Não | Identificador do tipo da Nota 0 - Entrada 1 - Saída |
| emissaoPropria | L | Não | Valor para identificar se a nota é de emissão própria. |
| numero | N | Não | Número da nota |
| dataInicial | D | Não | Data inicio para a consulta no formato AAAA-MM-DD |
| dataFinal | D | Não | Data final para a consulta no formato AAAA-MM-DD |
| selecionarPor | A | Não | Determina a seleção da data. Por : emissao entradaSaida Caso não informado o valor padrão será "emissao" |
| status | A | Não | Status da Nota: Aberta Fechada Em processamento Processada Denegada Inutilizada Autorizada Cancelada |
| codigoNegociante | A | Não | Código do negociante |
| nomeNegociante | A | Não | Nome do negociante |
| cpfCnpjNegociante | A | Não | CPF/CNPJ do negociante |
| offset | N | Não | Número que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0. |
| limit | N | Não | Número que identifica a quantidade de registros a consulta retornará, caso não informado o padrão será 50 (valor máximo). |
Exemplo de endpoint com argumentos:
https://api.erpeasy.compels.net/notaICMS?offset=0&limit=50
Resposta
A resposta será dada através de um texto no formato JSON cujos atributos são:
RESPONSE
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| results | O | 0-N | NotaICMS |
| metadata | O | 1-1 | Metadata |
ItemNotaICMS
| id | N | 1-1 | Identificador único interno |
| notaICMS | O | 1-1 | NotaICMS |
| codigoItem | A | 1-1 | Código do item |
| descricaoItem | A | 1-1 | Descrição do item |
| codigoBarra | A | 1-1 | Código de barras |
| codigoBarraTributavel | A | 1-1 | Código de barras tributável |
| ncmItem | A | 1-1 | NCM |
| excecaoICMSItem | A | 1-1 | Exceção ICMS |
| excecaoICMSSTItem | A | 1-1 | Exceção ICMS ST |
| excecaoPPBItem | L | 1-1 | Exceção PPB |
| excecaoIBPTItem | A | 1-1 | Exceção IPI |
| excecaoTIPIItem | L | 1-1 | Exceção TIPI |
| excecaoPISCOFINSItem | A | 1-1 | Exceção PIS/COFINS |
| coc | O | 1-1 | COC de impressão |
| cfop | A | 1-1 | CFOP |
| quantidadeInterna | N | 1-1 | Quantidade interna (Comercial) |
| unidadeInterna | A | 1-1 | Unidade interna (Comercial) |
| valorUnitario | N | 1-1 | Valor unitário (Comercial) |
| quantidadeTributavel | N | 1-1 | Quantidade Tributável |
| unidadeTributavel | A | 1-1 | Unidade Tributável |
| valorUnitarioTributavel | N | 1-1 | Valor Unitário Tributável |
METADATA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| count | N | 1-1 | Total de registros |
| offset | N | 1-1 | Número que identifica em qual registro a consulta iniciada |
| limit | N | 1-1 | Número que identifica o limite de registros na consulta |
Exemplo de resposta
{
"results": [
{
}
],
"metadata": {
"resultset": {
"count": 200,
"offset": 0,
"limit": 50
}
}
}