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@corepluspm.com

Add Payment

URL	`https://<server domain name>/api/core/<version>/Payment/`
Methods Supported	POST
Description	Add payment for an invoice

Required parameters	Type	Description
InvoiceId	string	The id of the Invoice to add payment
lineItemId	string	The id of the service item line
amountPaid	string	Amount to be added to the invoice. Note: Accepts only non negative numbers and only 2 decimals
datePaid	string	Date of the payment in format YYYY-MM-DD
paymentMethodId	string	The id of the payment method

URL https://sandbox.coreplus.com.au/API/Core/v2/payment

Example request

{
   "invoiceId":"987f22e1-2dfa-4c7f-a91c-a87c63f5fef6",
   "payments":[
      {
         "lineItemId":"912cb777-fef2-429d-bb7d-42ec612c2bfa",
         "amountPaid":"40.55",
         "datePaid":"2025-04-23",
         "paymentMethodId":"eda24a85-1ec5-4c4a-848f-97364d66fb2a"
      }
   ]
}

Example response

{
   "invoiceId":"987f22e1-2dfa-4c7f-a91c-a87c63f5fef6",
   "invoiceNumber":"250425-1",
   "clientId":"8ef93aca-06d3-4ecc-b800-dcac6bc64d39",
   "generatedAt":"2025-04-25",
   "lineItems":[
      {
         "lineItemId":"912cb777-fef2-429d-bb7d-42ec612c2bfa",
         "productId":"4aea27e2-8005-4230-818a-b6700ba1c906",
         "description":"Home test Set-up",
         "itemNumber":"00012",
         "quantity":1,
         "amountPaid":"40.55"
      }
   ],
   "amountOwing":"69.45",
   "locked":false
}

Optional parameters	Type	Description
dateBanked	String	Date of the banking in format YYYY-MM-DD
paymentNotes	String	Payment notes related notes

URL https://sandbox.coreplus.com.au/API/Core/v2/Payment/

Example request

{
   "invoiceId":"987f22e1-2dfa-4c7f-a91c-a87c63f5fef6",
   "payments":[
      {
         "lineItemId":"c9e436ff-64f6-4463-94de-1da19bef77a1",
         "amountPaid":"110.0",
         "datePaid":"2025-04-25",
         "dateBanked":"2025-04-25",
         "paymentMethodId":"eda24a85-1ec5-4c4a-848f-97364d66fb2a",
         "paymentNotes":"Amex payment using api"
      }
   ]
}

Example response

{
   "invoiceId":"987f22e1-2dfa-4c7f-a91c-a87c63f5fef6",
   "invoiceNumber":"250425-1",
   "clientId":"8ef93aca-06d3-4ecc-b800-dcac6bc64d39",
   "generatedAt":"2025-04-25",
   "lineItems":[
      {
         "lineItemId":"c9e436ff-64f6-4463-94de-1da19bef77a1",
         "productId":"4aea27e2-8005-4230-818a-b6700ba1c906",
         "description":"Home test Set-up",
         "itemNumber":"00012",
         "quantity":1,
         "amountPaid":"110.0"
      }
   ],
   "amountOwing":"0.0",
   "locked":false
}

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

coreplus API

Add Payment

Develop with us