Get a invoices by filters.
GET {{baseUrl}}/invoices?fiscalDocumentNumber=magna id in elit&paymentOrderStatusId=97910643&startDueDate=1954-02-22T12:10:55.556Z&endDueDate=1954-02-22T12:10:55.556Z&startPaymentDate=1954-02-22T12:10:55.556Z&endPaymentDate=1954-02-22T12:10:55.556Z&paymentTypeId=97910643&buyerBranchDocument=id labore nostrud quis dolore&supplierBranchDocument=id labore nostrud quis dolore&buyerId=ff812afd-020b-d6c1-e21c-0476e4101b0a&supplierId=ff812afd-020b-d6c1-e21c-0476e4101b0a&page=&pageSize=10
All filters are optionals and can be used to improve your search.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
fiscalDocumentNumber | string | ||
paymentOrderStatusId | number | ||
startDueDate | string | ||
endDueDate | string | ||
startPaymentDate | string | ||
endPaymentDate | string | ||
paymentTypeId | number | ||
buyerBranchDocument | string | ||
supplierBranchDocument | string | ||
buyerId | string | ||
supplierId | string | ||
page | null | The number of items to skip before starting to collect the result set | |
pageSize | number | The numbers of items to return. |
RESPONSES
status: OK
{"totalRecords":2,"page":"0","pageSize":10,"isNumberPagination":true,"pageCount":2,"items":[{"id":"ce59cfcb-2e64-41fe-9e93-fe4464e4fe4e","fiscalDocumentNumbers":"00001-X","installmentNumber":"1","buyerId":"565914b5-1559-4c80-b620-307a8e90a72f","buyerName":"Buyer Name","supplierId":"565914b5-1559-4c80-b620-307a8e90a72f","supplierName":"Supplier Name","totalValue":800.5,"formattedTotalValue":"800.50","discount":10,"formattedDiscount":"10","netValue":790.5,"formattedNetValue":"790.50","paymentOrderStatusId":5,"paymentOrderStatus":"Paid","notAnticipableReason":"","canceledReason":"","isPastDueDate":true,"dueDate":"1959-12-06T07:05:59.066Z","daysToDue":0,"paymentDate":"1960-02-18T01:44:31.442Z","currencyId":1,"currency":"BRL"},{"id":"ce59cfcb-2e64-41fe-9e93-fe4464e4fe4e","fiscalDocumentNumbers":"00001-X","installmentNumber":"1","buyerId":"565914b5-1559-4c80-b620-307a8e90a72f","buyerName":"Buyer Name","supplierId":"565914b5-1559-4c80-b620-307a8e90a72f","supplierName":"Supplier Name","totalValue":800.5,"formattedTotalValue":"800.50","discount":10,"formattedDiscount":"10","netValue":790.5,"formattedNetValue":"790.50","paymentOrderStatusId":5,"paymentOrderStatus":"Paid","notAnticipableReason":"","canceledReason":"","isPastDueDate":true,"dueDate":"1960-06-04T05:51:04.640Z","daysToDue":0,"paymentDate":"1953-01-15T09:36:22.074Z","currencyId":1,"currency":"BRL"}]}