Este serviço exibe as informações sobre os documentos de saída.
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 saída. |
sellers | Código do vendedor. Podem ser informados vários vendedores separados por vírgula |
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 saída |
number | Número do documento de saída |
serial | Série do documento |
clientId | ID do cliente |
client | Nome do cliente |
sellerid | ID do vendedor |
seller | Nome do vendedor |
state | UF de destino |
total | Valor total da nota |
status | Status do documento |
Formato para obtenção de informações específicas de documentos de saída
localhost/Selling/Série/Número |
---|
Exemplos:
Caso seja necessário retornar documentos de saída com série 1
{ "total": 4138, "hasNext": false, "lines": [ { "date": "20121002", "number": "000002178", "serial": "1", "clientId": "000029", "client": "T M LEAL E CIA LTDA", "sellerId": "000002", "seller": "MARCELINA DOS SANTOS BEZERRA", "state": "", "total": 108, "status": "1" }, { "date": "20121003", "number": "000002180", "serial": "1", "clientId": "000110", "client": "MARTTOM COMERCIO LTDA ME", "sellerId": "000003", "seller": "SONIA VIRGINIA SALES FEITOSA", "state": "", "total": 2243.7, "status": "1" }, { "date": "20121003", "number": "000002181", "serial": "1", "clientId": "000167", "client": "MANOEL EMIDIO DE OLIVEIRA ME", "sellerId": "000002", "seller": "MARCELINA DOS SANTOS BEZERRA", "state": "", "total": 381, "status": "1" } ] } |
Retornando um número de documento específico:
localhost/Selling/1/000002178 |
---|
{ "date": "20121002", "number": "000002178", "serial": "1", "clientId": "000029", "client": "T M LEAL E CIA LTDA", "sellerId": "000002", "seller": "MARCELINA DOS SANTOS BEZERRA", "state": "", "total": 108, "status": "1" } |
Obtenção de itens de documentos de saída específicos
localhost/Selling/Série/Número/ITEMS |
---|
Exemplo:
localhost/Selling/1/000002178/ITEMS |
---|
{ "total": 1, "hasNext": false, "lines": [ { "id": "01", "productid": "04411", "product": "ESP P TOALHA INTERFOLHA CRE 22,5X21CM 1X1000", "quantity": 30, "price": 3.6, "total": 108, "lot": "", "storage": "01" } ] } |
Exemplos de consultas e retornos com parâmetros
Exemplo 1: Retornando os documentos de saída de vendas realizadas pelos vendedores de códigos 000001, 000004 e 000026
localhost/Selling?sellers=000001,000004,000026 |
---|
{ "total": 1311, "hasNext": false, "lines": [ { "date": "20121005", "number": "000002197", "serial": "1", "clientId": "000154", "client": "RF COMERCIAL DE ALIMENTOS LTDA", "sellerId": "000004", "seller": "MARCIO PEREIRA PASSOS REPRESENTACOES LTDA", "state": "", "total": 1740, "status": "1" }, { "date": "20121005", "number": "000002198", "serial": "1", "clientId": "000108", "client": "DUPLA DISTRIBUIDORA DE P A LTDA", "sellerId": "000004", "seller": "MARCIO PEREIRA PASSOS REPRESENTACOES LTDA", "state": "", "total": 3365.2, "status": "1" }, { "date": "20121009", "number": "000002206", "serial": "1", "clientId": "000036", "client": "MARCELO LEAL BEZERRA", "sellerId": "000004", "seller": "MARCIO PEREIRA PASSOS REPRESENTACOES LTDA", "state": "", "total": 580, "status": "1" } ] } |
Exemplo 2: Retornando documentos de saída buscando pelo nome do cliente
localhost/Selling?customer=NOLECON COM DE |
---|
{ "total": 4, "hasNext": false, "lines": [ { "date": "20121031", "number": "000002289", "serial": "1", "clientId": "000149", "client": "NOLECON COM DE MAT DE LIMPEZA", "sellerId": "000004", "seller": "MARCIO PEREIRA PASSOS REPRESENTACOES LTDA", "state": "", "total": 1420, "status": "1" }, { "date": "20121215", "number": "000002469", "serial": "1", "clientId": "000149", "client": "NOLECON COM DE MAT DE LIMPEZA", "sellerId": "000004", "seller": "MARCIO PEREIRA PASSOS REPRESENTACOES LTDA", "state": "", "total": 1775, "status": "1" }, { "date": "20130131", "number": "000002667", "serial": "1", "clientId": "000149", "client": "NOLECON COM DE MAT DE LIMPEZA", "sellerId": "000004", "seller": "MARCIO PEREIRA PASSOS REPRESENTACOES LTDA", "state": "", "total": 897.5, "status": "1" } ] } |
Exemplo 3: Retornando documentos de saída em ordem decrescente de número
localhost/Selling?order=number desc |
---|
{ "total": 6212, "hasNext": false, "lines": [ { "date": "20150126", "number": "000049799", "serial": "A", "clientId": "000026", "client": "C V NEIVA DE OLIVEIRA", "sellerId": "000001", "seller": "CARLOS VINICIUS NEIVA DE OLIVEIRA", "state": "", "total": 210, "status": "1" }, { "date": "20150126", "number": "000049798", "serial": "A", "clientId": "000083", "client": "T R DE S MACEDO", "sellerId": "000002", "seller": "MARCELINA DOS SANTOS BEZERRA", "state": "", "total": 411, "status": "1" }, { "date": "20150126", "number": "000049797", "serial": "A", "clientId": "000437", "client": "MARCOS NATANAEL DOS SANTOS ROCHA ME", "sellerId": "000003", "seller": "SONIA VIRGINIA SALES FEITOSA", "state": "", "total": 985.7, "status": "1" } ] } |
Exemplo 4: Retornando a página 20 com 3 registros por página
localhost/Selling?max=3&page=20 |
---|
{ "total": 6212, "hasNext": true, "lines": [ { "date": "20121023", "number": "000002256", "serial": "1", "clientId": "000211", "client": "JR PRESTADORA DE SERVICOS LTDA EPP", "sellerId": "000003", "seller": "SONIA VIRGINIA SALES FEITOSA", "state": "", "total": 92, "status": "1" }, { "date": "20121023", "number": "000002257", "serial": "1", "clientId": "000121", "client": "FRANCISCO ALBERTO BEZERRA EPP", "sellerId": "000002", "seller": "MARCELINA DOS SANTOS BEZERRA", "state": "", "total": 2800, "status": "1" }, { "date": "20121023", "number": "000002258", "serial": "1", "clientId": "000119", "client": "PLASTICOS MARANHENSE LTDA", "sellerId": "000004", "seller": "MARCIO PEREIRA PASSOS REPRESENTACOES LTDA", "state": "", "total": 1984, "status": "1" } ] } |