Skip to main content
GET
/
credit_notes
/
{credit_note_id}
Fetch credit note
curl --request GET \
  --url https://api.withorb.com/v1/credit_notes/{credit_note_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>",
  "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,
      "tax_amounts": [
        {
          "tax_rate_description": "<string>",
          "tax_rate_percentage": "<string>",
          "amount": "<string>"
        }
      ],
      "item_id": "<string>",
      "discounts": [],
      "start_time_inclusive": "2023-11-07T05:31:56Z",
      "end_time_exclusive": "2023-11-07T05:31:56Z"
    }
  ],
  "discounts": []
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
credit_note_id
string
required

Response

OK

The Credit Note resource represents a credit that has been applied to a particular invoice.

​
id
string
required

The Orb id of this credit note.

​
created_at
string<date-time>
required

The creation time of the resource in Orb.

​
voided_at
string<date-time> | null
required

The time at which the credit note was voided in Orb, if applicable.

​
credit_note_number
string
required

The unique identifier for credit notes.

​
invoice_id
string
required

The id of the invoice resource that this credit note is applied to.

​
memo
string | null
required

An optional memo supplied on the credit note.

​
reason
enum<string> | null
required
Available options:
Duplicate,
Fraudulent,
Order change,
Product unsatisfactory
​
type
enum<string>
required
Available options:
refund,
adjustment
​
subtotal
string
required

The total prior to any creditable invoice-level discounts or minimums.

​
total
string
required

The total including creditable invoice-level discounts or minimums, and tax.

​
customer
CustomerMinified · object
required
​
credit_note_pdf
string | null
required

A URL to a PDF of the credit note.

​
minimum_amount_refunded
string | null
required

Any credited amount from the applied minimum on the invoice.

​
maximum_amount_adjustment
CreditNoteDiscount · object
required

The maximum amount applied on the original invoice

​
line_items
CreditNoteLineItem · object[]
required

All of the line items associated with this credit note.

​
discounts
CreditNoteDiscount · object[]

Any discounts applied on the original invoice.