post https://infrapay.stg.libercapital.com.br/api/payment/bill/filter
Filter Bill Pagination
Role-based access control
Required role customerBillStatusRead
REQUEST OBJECT HAS THE FOLLOWING PROPERTIES:
| Attribute | Type | Description | Required |
|---|---|---|---|
document | string | Customer document(cpf/cnpj) | No |
name | string | Customer name | No |
startDate | string | ISO String format YYYY-MM-DDTHH:mm:ss.sssZ | No |
endDate | string | ISO String format YYYY-MM-DDTHH:mm:ss.sssZ | No |
startDueDate | string | ISO String format YYYY-MM-DDTHH:mm:ss.sssZ | No |
endDueDate | string | ISO String format YYYY-MM-DDTHH:mm:ss.sssZ | No |
status | number | Pending = 1, Expired = 2, Canceled = 3, Paid = 4, WaitingToCancel = 5, WaitingNewDueDate = 6 | No |
page | number | Current page | Yes |
perPage | number | Number records by page | Yes |
Response object has the following properties:
| Attribute | Type | Description |
|---|---|---|
items[]._id | string | Id of bill |
items[].valuePaid | number | Paid value of bill |
items[].barCode | string | Bar code |
items[].digitableLine | string | Digitable line |
items[].externalId | string | Your id reference |
items[].value | number | Value of bill |
items[].dueDate | date | Due Date, ISO String format YYYY-MM-DDTHH:mm:ss.sssZ |
items[].status.id | number | Id of status |
items[].status.statusText | string | Text of status |
items[].customer.name | string | Customer name |
items[].customer.document | string | Customer document(cpf/cnpj) |
items[].createDate | date | Create date, ISO String format YYYY-MM-DDTHH:mm:ss.sssZ |
total | number | Total records |
page | number | Current page |
pages | number | Total pages |
Response status code
| status | Description |
|---|---|
| 200 | OK |
| 400 | BAD_REQUEST |
| 500 | INTERNAL_SERVER_ERROR |
| 403 | FORBIDDEN |