GET
/
credit_notes
curl --request GET \
  --url https://api.withorb.com/v1/credit_notes \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "voided_at": "2023-11-07T05:31:56Z",
      "credit_note_number": "<string>",
      "invoice_id": "<string>",
      "memo": "<string>",
      "reason": "Duplicate",
      "type": "refund",
      "subtotal": "<string>",
      "total": "<string>",
      "customer": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "credit_note_pdf": "<string>",
      "minimum_amount_refunded": "<string>",
      "discounts": [],
      "maximum_amount_adjustment": {
        "discount_type": "percentage",
        "percentage_discount": 123,
        "amount_applied": "<string>",
        "reason": "<string>",
        "applies_to_prices": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      },
      "line_items": [
        {
          "id": "<string>",
          "name": "<string>",
          "subtotal": "<string>",
          "amount": "<string>",
          "quantity": 123,
          "discounts": [],
          "tax_amounts": [
            {
              "tax_rate_description": "<string>",
              "tax_rate_percentage": "<string>",
              "amount": "<string>"
            }
          ],
          "item_id": "<string>"
        }
      ]
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Query Parameters

​
limit
integer
default:20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
created_at[gte]
string | null
​
created_at[gt]
string | null
​
created_at[lt]
string | null
​
created_at[lte]
string | null

Response

200
application/json

OK

The response is of type object.