POST
/
credit_notes
curl --request POST \
  --url https://api.withorb.com/v1/credit_notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "line_items": [
    {
      "invoice_line_item_id": "4khy3nwzktxv7",
      "amount": "<string>"
    }
  ],
  "reason": "duplicate",
  "memo": "An optional memo for my credit note."
}'
{
  "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>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Response

201
application/json

Created

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