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.

Get List of Invoices

Optional parameters Type Description
pageNumber int Used for paging the list of invoices – identify what page to get (default = 1)
pageSize int Used for paging the list of invoices – identify the number of results per page (default = 50)

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/invoice/
Example response
{
   "invoices":[
      {
         "invoiceId":"27625db9-416f-4e39-96a7-b0a1daa09dc1",
         "invoiceNumber":"210202-9",
         "clientId":"de2f18ac-6f23-4133-a2bb-4297220cf257",
         "generatedAt":"2021-02-02",
         "lineItems":[ ]
      },
      {
         "invoiceId":"cb6a645e-5b94-4587-9a48-7171019f4eb6",
         "invoiceNumber":"210202-69",
         "clientId":"de2f18ac-6f23-4133-a2bb-4297220cf257",
         "generatedAt":"2021-02-02",
         "lineItems":[ ]
      },
      {
         "invoiceId":"605d28fa-b975-4433-b7e6-ad15b8e90952",
         "invoiceNumber":"210202-66",
         "clientId":"de2f18ac-6f23-4133-a2bb-4297220cf257",
         "generatedAt":"2021-02-02",
         "lineItems":[ ]
      }
   ],
   "paging":{
      "totalRows":3,
      "pageNumber":1,
      "pageSize":1
   },
   "statusMessages":[
   ]
}

 

Additional Parameters

GET A LIST OF INVOICES WITH OPTIONAL FIELDS

This is an invoice filter for the Get invoice list which will retrieve a list of invoices with the specified fields within the organisation.

 

Optional parameters Type Description
invoice fields String The following invoice fields can be used

  • invoiceId
  • invoiceNumber
  • clientId
  • generatedAt
  • amountOwing
Line item fields string The following line item fields can be used

  • lineItems.lineItemId
  • lineItems.productId
  • lineItems.description
  • lineItems.itemNumber
  • lineItems.unitAmount
  • lineItems.taxAmount
  • lineItems.lineAmount
  • lineItems.quantity

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/invoice/?Field=invoiceNumber&Field=lineItems.itemNumber
Example response
{
   "invoices":[
      {
         "invoiceId":"0c1f5bab-da0f-4423-ac10-6bc2836956cc",
         "invoiceNumber":"171214-1",
         "lineItems":[
            {
               "lineItemId":"13dc9e61-85d1-41a1-b473-3d704128b167",
               "itemNumber":"123"
            }
         ]
      },
      {
         "invoiceId":"c383872b-3841-4af0-9295-c2312cb910de",
         "invoiceNumber":"171213-1",
         "lineItems":[
            {
               "lineItemId":"fb34e43c-58ba-48cb-bf1b-d158765376a0",
               "itemNumber":"756298"
            }
         ]
      }
   ],
   "paging":{
      "totalRows":2,
      "pageNumber":1,
      "pageSize":50
   },
   "statusMessages":[     
   ]
}

 

Get A List of Invoices Updated After Date

This is an invoice update filter for the Get invoice list which will retrieve a list of invoices within the organisation only where the invoice details have been updated after a specified date and time. The filter parameter is part of the URL on the invoice get call.

URL https://<server domain name>/api/core/<version>/invoice/?updatedSince=<Url encoded date time stamp with timezone>
Description Retrieve all invoices that have had iinvoice details updated since the specified date time stamp

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/invoice/?updatedSince=2017-06-30%2014:18:00%2B1000

The date time stamp is url encoded so in the above example

?updatedSince=2017-06-30%2014:18:00%2B1000 translates to

?updatedSince=2017-06-30 14:18:00+1000

See http://www.url-encode-decode.com/ for an encoding decoding example

The returned result will be the same as a normal invoice Get call except it will be filtered by the requested date time stamp

Develop with us

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


Please leave this field empty.