coreplus API

The coreplus API provides access to appointment booking related end points, such as clients, practitioners, availability slots and appointments. It is a RESTful API, which utilises the HTTP verbs for creating viewing objects.

If you are a developer looking to create an external consumer server to server application for your coreplus clients, then by signing up for a sandbox account you will get access to your own trial coreplus account on our sandbox server with authorisation credentials.

If you have any questions regarding the API documentation, please do not hesitate to contact us at integrations@coreplus.com.au

Get A Invoice Record

Required parameters	Type	Description
InvoiceId	string	The id of the Invoice to get

Example request https://sandbox.coreplus.com.au/API/Core/v2/invoice/fa8d43d6-3a04-4afc-b8bb-e9e251a6e0c5

Example response

{
   "invoiceId":"fa8d43d6-3a04-4afc-b8bb-e9e251a6e0c5",
   "invoiceNumber":"210603-1",
   "clientId":"b39f1a2b-26cd-4edb-8278-6500f5dae9fa",
   "generatedAt":"2021-06-03",
   "lineItems":[
      {
         "lineItemId":"50481516-51ae-4446-b6bc-4a9d26d4cf75",
         "productId":"ba0f64bb-7560-47e5-be72-d8679a9a3b47",
         "description":"some item1",
         "itemNumber":"1",
         "unitAmount":50.0,
         "taxAmount":0.0,
         "lineAmount":50.0,
         "quantity":1.0
      }
   ],
   "amountOwing":"50.0",
   "locked": true
}

Optional parameters	Type	Description
getPractitionerId	Boolean	Returns Practitioner Id of the invoice
getLocationId	Boolean	Returns Location Id of the invoice
getClientgroupId	Boolean	Returns the client Group Id for the given client on the invoice

Example request https://sandbox.coreplus.com.au/API/Core/v2/invoice/fa8d43d6-3a04-4afc-b8bb-e9e251a6e0c5?getLocationId=True&getPractitionerId=True&getClientGroupId=True

Example response

{
   "invoiceId":"fa8d43d6-3a04-4afc-b8bb-e9e251a6e0c5",
   "invoiceNumber":"210603-1",
   "clientId":"b39f1a2b-26cd-4edb-8278-6500f5dae9fa",
   "generatedAt":"2021-06-03",
   "lineItems":[
      {
         "lineItemId":"50481516-51ae-4446-b6bc-4a9d26d4cf75",
         "productId":"ba0f64bb-7560-47e5-be72-d8679a9a3b47",
         "description":"some item1",
         "itemNumber":"1",
         "unitAmount":50.0,
         "taxAmount":0.0,
         "lineAmount":50.0,
         "quantity":1.0
      }
   ],
   "amountOwing":"50.0",
   "practitionerId": "3dc6e75d-20b6-42bf-bb72-193ce9da85fc",
   "locationId": "3c0639cc-0849-438e-b16e-aafd9548a0b8",
   "clientGroupId": "d50993cd-74ab-e611-952f-005056a3005d",
   "locked": true
}

Use the form to sign-up and start developing with coreplus today.

coreplus API

Get A Invoice Record

Develop with us