Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Invoice

Get invoice

get/invoices/{id}

Path parameters

idstring int64 required

Query parameters

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

ValueFormat
archived_atdate-time
deleted_atdate-time

Response

Successful operation

archived_atstring date-time nullable
calculation_method1 | 2 | 3 nullable
Enum ValueDescription
1Legacy
2Tax exclusive
3Tax inclusive
calculation_method_description'Legacy' | 'Tax exclusive' | 'Tax inclusive' nullable
closed_atstring date-time nullable
created_atstring date-time
deleted_atstring date-time nullable
discounted_amountstring decimal nullable
idstring int64
invoice_tostring nullable
issue_datestring date
net_amountstring decimal nullable
notesstring nullable
numberinteger
online_payment_urlstring uri nullable
patient_extra_informationstring nullable
status10 | 20 | 30 | 40 nullable
Enum ValueDescription
10Open
20Paid
30Closed
40Open credit
status_description'Open' | 'Paid' | 'Closed' | 'Open credit' nullable
tax_amountstring decimal nullable
total_amountstring decimal nullable
updated_atstring date-time

Example response

{
  "appointment": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/appointments/1"
    }
  },
  "attendee": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/attendees/1"
    }
  },
  "business": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/businesses/1"
    }
  },
  "invoice_items": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/invoices/1"
  },
  "original_invoice": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/invoices/1"
    }
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "practitioner": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/practitioners/1"
    }
  },
  "reversed_invoices": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=invoice_id%3A%3D1"
    }
  },
  "signature": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/signatures/1"
    }
  }
}