List all credit notes
curl --request GET \
--url https://api.yorlet.com/v1/credit_notes \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "credit_note",
"amount": 123,
"currency": "gbp",
"customer": "<string>",
"description": "<string>",
"discount_amount": 123,
"invoice": "<string>",
"memo": "<string>",
"number": "<string>",
"voided_at": 123,
"account": "<string>",
"deleted": false,
"credit_amount": 0,
"lines": [
{
"id": "<string>",
"created": 123,
"object": "credit_note_line_item",
"amount": 123,
"amount_excluding_tax": 123,
"credit_note": "<string>",
"currency": "gbp",
"description": "<string>",
"invoice_item": "<string>",
"pretax_credit_amounts": [
{
"amount": 123,
"credit_grant": "<string>",
"display_name": "<string>",
"invoice_item": "<string>",
"type": "credit_grant"
}
],
"tax_amounts": [
{
"amount": 123,
"tax_rate": 123,
"taxable_amount": 123
}
],
"type": "invoice_item",
"account": "<string>",
"deleted": false
}
],
"metadata": {},
"out_of_band_amount": 0,
"subtotal": 0,
"subtotal_excluding_tax": 0,
"tax_amounts": [],
"tax": 0,
"total": 0,
"total_excluding_tax": 0,
"total_pretax_credit_amounts": []
}
]
}Credit Notes
List all credit notes
GET
/
v1
/
credit_notes
List all credit notes
curl --request GET \
--url https://api.yorlet.com/v1/credit_notes \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "credit_note",
"amount": 123,
"currency": "gbp",
"customer": "<string>",
"description": "<string>",
"discount_amount": 123,
"invoice": "<string>",
"memo": "<string>",
"number": "<string>",
"voided_at": 123,
"account": "<string>",
"deleted": false,
"credit_amount": 0,
"lines": [
{
"id": "<string>",
"created": 123,
"object": "credit_note_line_item",
"amount": 123,
"amount_excluding_tax": 123,
"credit_note": "<string>",
"currency": "gbp",
"description": "<string>",
"invoice_item": "<string>",
"pretax_credit_amounts": [
{
"amount": 123,
"credit_grant": "<string>",
"display_name": "<string>",
"invoice_item": "<string>",
"type": "credit_grant"
}
],
"tax_amounts": [
{
"amount": 123,
"tax_rate": 123,
"taxable_amount": 123
}
],
"type": "invoice_item",
"account": "<string>",
"deleted": false
}
],
"metadata": {},
"out_of_band_amount": 0,
"subtotal": 0,
"subtotal_excluding_tax": 0,
"tax_amounts": [],
"tax": 0,
"total": 0,
"total_excluding_tax": 0,
"total_pretax_credit_amounts": []
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
A object with a data property that contains an array of credit notes.
Was this page helpful?
⌘I