Skip to main content
PUT
/
invoices
/
{invoiceId}
/
settle
{
  "currency": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "handle": "<string>",
    "name": "<string>",
    "billingAddress": {
      "street1": "<string>",
      "street2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "county": "<string>",
      "country": "<string>",
      "state": "<string>"
    }
  },
  "memo": "<string>",
  "handle": "<string>",
  "status": "draft",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "dueDate": "2023-12-25",
  "updatedAt": "2023-11-07T05:31:56Z",
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123,
      "unitAmount": 123,
      "sku": "<string>",
      "title": "<string>",
      "description": "<string>",
      "periodStart": "2023-12-25",
      "periodEnd": "2023-12-25",
      "amount": 123,
      "taxAmount": 123,
      "tax": {
        "taxable": true,
        "taxCode": "<string>",
        "taxRate": 123
      },
      "discount": {
        "percentage": 123,
        "amount": 123
      }
    }
  ],
  "settlements": [
    {
      "date": "2023-12-25",
      "amount": 123,
      "reference": "<string>",
      "note": "<string>"
    }
  ],
  "totalExclVat": 123,
  "totalVat": 123,
  "totalInclVat": 123,
  "totalDue": 123,
  "type": "invoice",
  "settlementStatus": "settled"
}

Headers

x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Path Parameters

invoiceId
string<uuid>
required

Id of invoice to settle.

Body

application/json
amount
integer<int32> | null

Amount to settle. If null, the outstanding amount of the invoice will be settled.

note
string | null

A noteor memo to attach to the settlement.

paymentSource
object
cash
object
invoiceReference
object

Response

OK

currency
string | null
required
createdAt
string<date-time>
required
customer
object
required
memo
string | null
handle
string | null

Unique invoice number.

status
enum<string>
Available options:
draft,
booked
id
string<uuid>
date
string<date>
dueDate
string<date> | null
updatedAt
string<date-time> | null
items
object[] | null
settlements
object[] | null
totalExclVat
integer<int64>
totalVat
integer<int64>
totalInclVat
integer<int64>
totalDue
integer<int64>
type
enum<string>
Available options:
invoice,
credit_note
settlementStatus
enum<string>
Available options:
settled,
over_settled,
under_settled,
not_settled