Skip to main content

API R3

· 2 min read
Craig Herrington

Release 3 of the API includes billable invoices and payments, including payment allocation.

These new endpoints allow for formulary records to be posted to the clinical record, retrieved as draft-invoices before being invoiced as a single document.

Payments can be allocated to invoices (note donations cannot be allocated), with the retrieval of payments and invoices showing the amount allocated.

Billing​

  • New API Service for Billing - View in the preview API explorer
  • GET billing - New endpoint for retrieving the billing record for a contact.
  • GET billing/:uuid - New endpoint
  • GET /discount-categories - New endpoint
  • GET /discount-categories/:uuid - New endpoint
  • GET /taxes - New endpoint
  • GET /payments/donation-types - New endpoint
  • GET /payments/donation-types/:donation-type-uuid - New endpoint
  • GET /payments/payment-methods - New endpoint
  • GET /payments/payment-methods/:uuid - New endpoint
  • GET /draft-invoices - New endpoint for getting clinical charges not yet invoiced.
  • POST /invoices - New endpoint for invoicing draft-invoice content.
  • GET /invoices - New endpoint
  • GET /invoices/:uuid - New endpoint
  • GET /invoices/:uuid/invoice-contents - New endpoint to retrieve the invoice lines.
  • GET /balance - New endpoint
  • GET /payments - New Endpoint
  • GET /payments/:uuid - New Endpoint
  • POST /payments - New endpoint for adding payments and donations (charities only)

Clinical​

View in the preview API explorer

  • POST /billable-records - New endpoint for adding chargeable clinical work.
  • POST /vital-metric/weight - New endpoint for adding patient weight.
  • DELETE /vital-metric/weight - New dndpoint
  • GET /clinical-notes/protocols - New endpoint
  • GET /clinical-notes/protocols/:protocol-uuid/questions - New endpoint
  • GET /clinical-notes/questions - New endpoint
  • GET /clinical-notes/questions/:clinical-question-uuid - New Endpoint to retrieve questions for clinical notes.
  • GET /clinical-notes/questions/:clinical-question-uuid/answers - New endpoint to retrieve allowed answers to the specified question.
  • GET /clinical-notes/questions/answers - New endpoint

Please note that the suite of clinical note endpoints is incomplete in this release, more will be released in R4.

If you have any questions please contact us.