List invoices
GET {{baseUrl}}/{{version}}/invoice
Get a list of invoices in chunks of at most 100. If you need smaller chunks, use the limit parameter.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cursor | null | String used to get the next batch of results. Our SDKs handle this for you. | |
limit | null | Number of results per cursor. Max = 100. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
status | null | Filter invoices by the specified status. | |
tags | null | Filter entities that contain the specified tags. | |
ids | null | List of strings to get specific entities by ids. | |
fields | null | List of strings to filter response JSON keys. Not available in the SDKs. |
RESPONSES
status: OK
{"cursor":null,"invoices":[{"status":"created","updated":"2020-11-23T23:20:00.788683+00:00","fee":0,"taxId":"20.018.183/0001-80","interest":1.3,"tags":[],"interestAmount":0,"created":"2020-11-23T23:16:26.985755+00:00","due":"2020-11-30T02:06:26.249976+00:00","descriptions":[{"key":"Product A","value":"R$10,00"},{"key":"Taxes","value":"R$100,00"}],"nominalAmount":100,"discounts":[{"percentage":10.5,"due":"2020-11-25T20:59:26+00:00"},{"percentage":5,"due":"2020-11-29T20:59:26+00:00"}],"amount":100,"brcode":"00020101021226890014br.gov.bcb.pix2567invoice-h.sandbox.starkbank.com/v2/824f06ebcc5f4233884b83f25cb832bf52040000530398654040.005802BR5915Stark Bank S.A.6009Sao Paulo62070503***6304A4FD","expiration":1,"fineAmount":0,"pdf":"https://invoice-h.sandbox.starkbank.com/pdf/824f06ebcc5f4233884b83f25cb832bf","discountAmount":0,"fine":2.5,"id":"6499273612984320","name":"Iron Bank S.A."}]}