Requisição
URL: https://api.erpeasy.compels.net/item
Method: GET
Os argumentos são:
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| buscaEspecifica | L | 1-1 | Valor lógico que define se a busca será exata ou contendo os filtros informados. | |
| codigo | A | 0-1 | Código | |
| codigoBarras | A | 0-1 | Código de Barras | |
| descricao | A | 0-1 | Descrição | |
| linha | A | 0-1 | Linha | |
| unidade | A | 0-1 | Unidade | |
| ncm | A | 0-1 | NCM | |
| tipoSped | A | 0-1 | Tipo Sped | |
| partNumber | A | 0-1 | Part Number | |
| observacao | A | 0-1 | Observação | |
| naoMostraItemInativo | L | 1-1 | Valor lógico informado para buscar apenas itens ativos | |
| lastInsertedID | D | 0-1 | Ultimo Identificador (ID). Se informado a busca irá retornar apenas os registro com o ID maior que o valor informado. | |
| offset | N | 0-1 | Número que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0. | |
| limit | N | 0-1 | 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/item?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 | Item | |
| metadata | O | 1-1 | Metadata | |
ITEM
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Identificador único externo | |
| descricao | A | 1-1 | Descrição | |
| dataCadastro | D | 1-1 | Data do cadastro | |
| linha | O | 1-1 | Linha | |
| unidade | O | 1-1 | Unidade | |
| tipoSped | A | 1-1 | Tipo Sped "00" - Mercadoria para Revenda "01" - Matéria-prima "02" - Embalagem "03" - Produto em Processo "04" - Produto Acabado "05" - Subproduto "06" - Produto Intermediário "07" - Material de Uso e Consumo "08" - Ativo Imobilizado "09" - Serviços "10" - Outros Insumos "99" - Outras | |
| genero | O | 0-1 | Genero | |
| codigoBarra | A | 0-1 | Código de Barras GTIN | |
| codigoBarraTributavel | A | 0-1 | Código de Barras Tributável GTIN | |
| partNumber | A | 0-1 | Part Number | |
| codigoAnp | A | 0-1 | Código ANP | |
| descricaoANP | A | 0-1 | Descrição ANP | |
| cest | O | 0-1 | CEST | |
| origem | A | 0-1 | Origem | |
| observacao | A | 0-1 | Observação Interna | |
| observacaoFiscal | A | 0-1 | Observação fiscal | |
| ncm | O | 1-1 | NCM | |
| inativo | L | 1-1 | Valor lógico para identificar se o item está inativo | |
LINHA
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Identificador único externo | |
| descricao | A | 1-1 | Descrição | |
UNIDADE
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Identificador único externo | |
| descricao | A | 1-1 | Descrição interna | |
| descricaoFCI | A | 1-1 | Descrição FCI | |
GENERO
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Identificador único externo | |
| descricao | A | 1-1 | Descrição | |
CEST
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Código | |
| descricao | A | 1-1 | Descrição | |
NCM
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Código | |
| descricao | A | 1-1 | Descrição | |
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": [
{
"id": 1,
"codigo": "IT0001",
"descricao": "ITEM 1",
"inativo": false,
"observacao": "Item 1",
"tipoSped": "99",
"linha": {
"id": 1,
"codigo": "MP",
"descricao": "MATÉRIA PRIMA"
},
"unidade": {
"id": 1,
"codigo": "PC",
"descricao": "PEÇA",
"descricaoFCI": "pç - peça"
},
"ncm": {
"id": 1,
"codigo": "85444900",
"descricao": "Cabos , fios"
},
"dataCadastro": "2018-10-01"
},
{
"id": 2,
"codigo": "IT0002",
"descricao": "ITEM 2",
"inativo": false,
"observacao": "Item 2",
"tipoSped": "99",
"linha": {
"id": 1,
"codigo": "MP",
"descricao": "MATÉRIA PRIMA"
},
"unidade": {
"id": 1,
"codigo": "PC",
"descricao": "PEÇA",
"descricaoFCI": "pç - peça"
},
"ncm": {
"id": 1,
"codigo": "85444900",
"descricao": "Cabos , fios"
},
"dataCadastro": "2018-10-01"
}
],
"metadata": {
"resultset": {
"count": 2,
"offset": 0,
"limit": 50
}
}
}