Este serviço exibe as informações sobre os documentos de entrada.
Parâmetros
inidate | Data inicial para pesquisa. Se não informado uma data final, será considerado tudo a partir da data inicial. |
enddate | Data final para definir intervalo de datas. |
status | Código do Status do documento de entrada. |
product | Busca por parte da descrição do produto. |
productid | Busca pelo ID do produto. |
customer | Busca por parte do nome do cliente. |
customerid | Busca pelo ID do cliente. |
page | Determina a página que deve ser retornada. Pode ser utilizada com o parâmetro max. |
max | Número de registros máximos a ser apresentados. |
order | Campo para ordenação dos registros. Aceita campos e ordem decrescente (DESC) |
Campos do retorno
total | Quantidade de registros do retorno |
hasNext | Indica se há mais registros na próxima página |
syncing | Indica se no momento da requisição o sistema estava recebendo alguma nova informação |
lines | Contém as informações dos registros |
date | Data de emissão do documento de entrada |
number | Número do documento de entrada |
serial | Série do documento |
customerId | ID do cliente |
customer | Nome do cliente |
status | Status do documento. Cancelada ou Ativa. |
type | Tipo da nota. Podendo ser: NF.Normal, NF.Devolucao, NF.Complemento de Preco, NF.Complemento de ICMS, NF. Complemento de IPI, NF. Beneficiamento |
tpform | Indica se é formulário próprio ou de fornecedor. (Retorna true ou false) |
total | Valor total da nota |
Formato para obtenção de documentos de entrada específicos
localhost/Purchase/CódigoPessoa/Série/NúmeroDocumento |
---|
Exemplos:
Obtendo documentos de entrada de determinada pessoa
localhost/Purchase/000164 |
---|
{ "total": 23, "hasNext": false, "lines": [ { "date": "20120911", "number": "000003895", "serial": "001", "customerId": "000164", "customer": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 1217.19 }, { "date": "20120926", "number": "000003946", "serial": "001", "customerId": "000164", "customer": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 2606.71 }, { "date": "20121026", "number": "000004084", "serial": "001", "customerId": "000164", "customer": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 2130 } ] } |
Realizando o filtro por série:
localhost/Purchase/000164/1 |
---|
{ "total": 14, "hasNext": false, "lines": [ { "date": "20140320", "number": "000005969", "serial": "1", "customerId": "000164", "customer": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 4844.83 }, { "date": "20140521", "number": "000006111", "serial": "1", "customerId": "000164", "customer": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 1777.56 }, { "date": "20140623", "number": "000006197", "serial": "1", "customerId": "000164", "customer": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 3598.2 } ] } |
Realizando o filtro por número de documento
localhost/Purchase/000164/1/000005969 |
---|
{ "date": "20140320", "number": "000005969", "serial": "1", "customerId": "000164", "customer": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 4844.83 } |
Obtenção de itens de documentos de entrada específicos
localhost/Purchase/CódigoPessoa/Série/NúmeroDocumento/ITEMS |
---|
Exemplo:
localhost/Purchase/000164/1/000005969/ITEMS |
---|
{ "total": 2, "hasNext": false, "lines": [ { "id": "01", "productid": "04436", "product": "SC PL PP 13X21X6 GUARD VIP 14X14 1X1", "quantity": 105000, "price": 0.02378, "total": 2496.9, "lot": "", "storage": "03" }, { "id": "02", "productid": "04442", "product": "REEM 47X40X3 P GUARD 14X14 1X1", "quantity": 36200, "price": 0.06486, "total": 2347.93, "lot": "", "storage": "03" } ] } |
Exemplos de consultas e retornos com parâmetros
Exemplo 1: Retornando documentos de entrada em um intervalo de datas
localhost/Purchase?inidate=2013-01-01&enddate=2013-01-08 |
---|
{ "total": 9, "hasNext": false, "lines": [ { "date": "20130107", "number": "000004511", "serial": "A", "customerId": "000041", "customer": "ANTONIO JOSE DA SILVA COMERCIO", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 349.99 }, { "date": "20130103", "number": "000048697", "serial": "A", "customerId": "000026", "customer": "C V NEIVA DE OLIVEIRA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 17 }, { "date": "20130108", "number": "000048751", "serial": "A", "customerId": "000026", "customer": "C V NEIVA DE OLIVEIRA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 7.8 } ] } |
Exemplo 2: Retornando documentos de entrada por parte do nome do cliente
localhost/Purchase?customer=ANTONIO JOSE DA SILVA |
---|
{ "total": 15, "hasNext": false, "lines": [ { "date": "20130107", "number": "000004511", "serial": "A", "customerId": "000041", "customer": "ANTONIO JOSE DA SILVA COMERCIO", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 349.99 }, { "date": "20140220", "number": "000004567", "serial": "A", "customerId": "000041", "customer": "ANTONIO JOSE DA SILVA COMERCIO", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 36 }, { "date": "20140227", "number": "000004747", "serial": "A", "customerId": "000041", "customer": "ANTONIO JOSE DA SILVA COMERCIO", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 159.5 } ] } |
Exemplo 3: Retornando documentos de entrada filtrando por parte da descrição do produto
localhost/Purchase?product=AGUA SANITARIA |
---|
{ "total": 34, "hasNext": false, "lines": [ { "date": "20121031", "number": "000048321", "serial": "U", "customerId": "000026", "customer": "C V NEIVA DE OLIVEIRA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 118.8 }, { "date": "20150109", "number": "000007793", "serial": "A", "customerId": "000026", "customer": "C V NEIVA DE OLIVEIRA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 53.91 }, { "date": "20121219", "number": "000048636", "serial": "A", "customerId": "000026", "customer": "C V NEIVA DE OLIVEIRA", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 96.2 } ] } |
Exemplo 4: Retornando documentos de entrada ordenados por id do cliente em ordem decrescente
localhost/Purchase?order=customerid desc |
---|
{ "total": 1017, "hasNext": false, "lines": [ { "date": "20141224", "number": "000148467", "serial": "U", "customerId": "000453", "customer": "AUTO PECAS PADRE CICERO", "status": "NF. Ativa", "type": "NF.Complemento de Preco", "tpform": 1, "total": 120 }, { "date": "20141203", "number": "000010025", "serial": "A", "customerId": "000452", "customer": "ADEMIR BOSSACO", "status": "NF. Ativa", "type": "NF.Complemento de Preco", "tpform": 1, "total": 5580 }, { "date": "20141215", "number": "000017841", "serial": "U", "customerId": "000452", "customer": "ADEMIR BOSSACO", "status": "NF. Ativa", "type": "NF.Complemento de Preco", "tpform": 1, "total": 7840 } ] } |
Exemplo 5: Retornando a página 20 com 3 registros por página
localhost/Purchase?max=3&page=20 |
---|
{ "total": 1017, "hasNext": true, "lines": [ { "date": "20140730", "number": "000021287", "serial": "U", "customerId": "000161", "customer": "RAPIDO LONDON", "status": "NF. Ativa", "type": "NF.Complemento de Preco", "tpform": 1, "total": 575.64 }, { "date": "20141014", "number": "000030942", "serial": "1", "customerId": "000202", "customer": "INDUSTRIA BRASILEIRA DA EMBALAGEM", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 5800.49 }, { "date": "20141011", "number": "000016975", "serial": "1", "customerId": "000313", "customer": "KAPERSUL INDUSTRIA E COMERCIO DE PAPEIS S/A.", "status": "NF. Ativa", "type": "NF.Normal", "tpform": 1, "total": 31386.88 } ] } |