...
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) |
...
total | Quantidade de registros do retorno |
hasNext | Indica se há mais registros na próxima página |
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 |
clientId | ID do cliente |
client | Nome do cliente |
total | Valor total da nota |
status | Status do documento |
Formato específico 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": "2012-09-11T00:00:00", "number": "000003895", "serial": "001", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 1217.19, "status": "" }, { "date": "2012-09-26T00:00:00", "number": "000003946", "serial": "001", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 2606.71, "status": "" }, { "date": "2012-10-26T00:00:00", "number": "000004084", "serial": "001", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 2130, "status": "" } ] } |
Realizando o filtro por série:
localhost/Purchase/000164/1 |
---|
{ "total": 14, "hasNext": false, "lines": [ { "date": "2014-03-20T00:00:00", "number": "000005969", "serial": "1", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 4844.83, "status": "" }, { "date": "2014-05-21T00:00:00", "number": "000006111", "serial": "1", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 1777.56, "status": "" }, { "date": "2014-06-23T00:00:00", "number": "000006197", "serial": "1", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 3598.2, "status": "" } ] } |
Realizando o filtro por número de documento
localhost/Purchase/000164/1/000005969 |
---|
{ "date": "2014-03-20T00:00:00", "number": "000005969", "serial": "1", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 4844.83, "status": "" } |
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": "2013-01-07T00:00:00", "number": "000004511", "serial": "A", "clientId": "000041", "client": "ANTONIO JOSE DA SILVA COMERCIO", "total": 349.99, "status": "" }, { "date": "2013-01-03T00:00:00", "number": "000048697", "serial": "A", "clientId": "000026", "client": "C V NEIVA DE OLIVEIRA", "total": 17, "status": "" }, { "date": "2013-01-08T00:00:00", "number": "000048751", "serial": "A", "clientId": "000026", "client": "C V NEIVA DE OLIVEIRA", "total": 7.8, "status": "" } ] } |
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": "2013-01-07T00:00:00", "number": "000004511", "serial": "A", "clientId": "000041", "client": "ANTONIO JOSE DA SILVA COMERCIO", "total": 349.99, "status": "" }, { "date": "2014-02-20T00:00:00", "number": "000004567", "serial": "A", "clientId": "000041", "client": "ANTONIO JOSE DA SILVA COMERCIO", "total": 36, "status": "" }, { "date": "2014-02-27T00:00:00", "number": "000004747", "serial": "A", "clientId": "000041", "client": "ANTONIO JOSE DA SILVA COMERCIO", "total": 159.5, "status": "" } ] } |
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": "2012-10-31T00:00:00", "number": "000048321", "serial": "U", "clientId": "000026", "client": "C V NEIVA DE OLIVEIRA", "total": 118.8, "status": "" }, { "date": "2015-01-09T00:00:00", "number": "000007793", "serial": "A", "clientId": "000026", "client": "C V NEIVA DE OLIVEIRA", "total": 53.91, "status": "" }, { "date": "2012-12-19T00:00:00", "number": "000048636", "serial": "A", "clientId": "000026", "client": "C V NEIVA DE OLIVEIRA", "total": 96.2, "status": "" } ] } |
Exemplo 4: Retornando documentos de entrada ordenados por id do cliente em ordem decrescente
localhost/Purchase?order=clientid desc |
---|
{ "total": 1017, "hasNext": false, "lines": [ { "date": "2014-12-24T00:00:00", "number": "000148467", "serial": "U", "clientId": "000453", "client": "AUTO PECAS PADRE CICERO", "total": 120, "status": "" }, { "date": "2014-12-03T00:00:00", "number": "000010025", "serial": "A", "clientId": "000452", "client": "ADEMIR BOSSACO", "total": 5580, "status": "" }, { "date": "2014-12-15T00:00:00", "number": "000017841", "serial": "U", "clientId": "000452", "client": "ADEMIR BOSSACO", "total": 7840, "status": "" } ] } |
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": "2012-09-11T00:00:00", "number": "000001090", "serial": "", "clientId": "000019", "client": "NOVO PERFIL COMERCIO DE EMBALAGENS LTDA", "total": 3940.5, "status": "" }, { "date": "2012-09-13T00:00:00", "number": "000005502", "serial": "", "clientId": "000018", "client": "CIPEL DE PADUA IND DE PAPEIS LTDA", "total": 30601.87, "status": "" }, { "date": "2012-09-11T00:00:00", "number": "000003895", "serial": "001", "clientId": "000164", "client": "TECNOLOGIA EM PLASTICOS IND E COM LTDA", "total": 1217.19, "status": "" } ] } |