List credit notes
GET {{baseInfraUrl}}/{{version}}/credit-note
Here you can list and filter all Credit Notes you have made. We return it paged.
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 | Maximum number of objects to be retrieved. Max = 100. | |
fields | null | String used to get the next batch of results. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
status | null | List of strings to filter Credit Notes by their status. | |
tags | null | Filter entities that contain the specified tags. | |
ids | null | List of strings to get specific Credit Notes by their ids. |
RESPONSES
status: OK
{"cursor":"CkgKFAoHY3JlYXRlZBIJCMvP6rvBm_gCEixqEWl-YXBpLW1zLWJvbmQtZGV2chcLEgpDcmVkaXROb3RlGICAgNjEy44LDBgAIAE=","notes":[{"amount":193240,"city":"São Paulo","created":"2022-06-07T14:09:40.371518+00:00","district":"Jardim Paulista","documentId":"5760205505691648","expiration":"2022-06-14T11:09:40.226984+00:00","externalId":"my_unique_id_postman1","id":"5745965138968576","interest":20.68,"invoices":[{"amount":234413,"descriptions":[],"discounts":[],"due":"2023-06-17T02:59:59.999999+00:00","expiration":5097600,"fine":2,"id":"","interest":1,"name":"Jamie Lannister","tags":[],"taxId":"012.345.678-90"}],"name":"Jamie Lannister","nominalAmount":200000,"nominalInterest":16.71,"payment":{"accountNumber":"5005482","accountType":"checking","amount":193240,"bankCode":"60701190","branchCode":"7248","id":"","name":"Jamie Lannister","scheduled":"2022-06-07T14:09:40.238601+00:00","status":"","tags":[],"taxId":"594.739.480-42"},"paymentType":"transfer","rebateAmount":0,"scheduled":"2022-06-07T11:09:40.226984+00:00","signers":[{"contact":"jamie.lannister@gmail.com","method":"link","name":"Jamie Lannister"},{"contact":"39.908.427/0001-28","method":"server","name":"Stark Sociedade de Crédito Direto S.A."}],"stateCode":"SP","status":"created","streetLine1":"Rua ABC","streetLine2":"Ap 123","tags":[],"taxAmount":6760,"taxId":"012.345.678-90","templateId":"5707012469948416","transactionIds":[],"updated":"2022-06-07T14:09:41.352465+00:00","workspaceId":"6275127679385600","zipCode":"01234-567"},{"amount":193240,"city":"São Paulo","created":"2022-06-07T14:06:14.894539+00:00","district":"Jardim Paulista","documentId":"5188107540365312","expiration":"2022-06-14T11:06:14.705451+00:00","externalId":"my_unique_id_postman","id":"6256617557327872","interest":20.68,"invoices":[{"amount":234413,"descriptions":[],"discounts":[],"due":"2023-06-17T02:59:59.999999+00:00","expiration":5097600,"fine":2,"id":"","interest":1,"name":"Jamie Lannister","tags":[],"taxId":"012.345.678-90"}],"name":"Jamie Lannister","nominalAmount":200000,"nominalInterest":16.71,"payment":{"accountNumber":"5005482","accountType":"checking","amount":193240,"bankCode":"60701190","branchCode":"7248","id":"","name":"Jamie Lannister","scheduled":"2022-06-07T14:06:14.714676+00:00","status":"","tags":[],"taxId":"594.739.480-42"},"paymentType":"transfer","rebateAmount":0,"scheduled":"2022-06-07T11:06:14.705451+00:00","signers":[{"contact":"jamie.lannister@gmail.com","method":"link","name":"Jamie Lannister"},{"contact":"39.908.427/0001-28","method":"server","name":"Stark Sociedade de Crédito Direto S.A."}],"stateCode":"SP","status":"created","streetLine1":"Rua ABC","streetLine2":"Ap 123","tags":[],"taxAmount":6760,"taxId":"012.345.678-90","templateId":"5707012469948416","transactionIds":[],"updated":"2022-06-07T14:06:15.993285+00:00","workspaceId":"6275127679385600","zipCode":"01234-567"}]}