Developer API

This section is under development, please let us know if you find any errors.

About our API

API access is available for all account types and provides you with means to integrate a full featured invoicing solution into your product.

When data is returned by our API it is mostly returned in JSON format. Calls to our API can be made via POST requests.

Getting Started

In invoicing mode, under the Settings page, under the API Access tab, take note of your username and password, they are required with all API calls. Note that the username & password are randomly generated strings, please copy & use them exactly as given.

Your BusinessID is also supplied, mostly for informational purposes.

Issuing Calls

The current version of the API should be accessed on https://www.jobcardsonline.co.za/api/

This documentation always refers to the latest version of the API, and small things may change from time to time.

Parameters are case sensitive, always use as indicated.

Note, we recommend caching results on your server in order to improve performance to your clients.

Clients

The following client related functions are available:

• Get All Clients
• Get Specific Client
• Get Client History
• Add New Client
• Add Credit Card
• Client Statements
• Get ClientID
• Update Client

Suppliers

The following supplier related functions are available:

• Get All Suppliers
• Get Specific Supplier
• Get Supplier History
• Add New Supplier

Documents

The following document related functions are available:

• Add New Credit Note
• Add New Invoice
• Add New Jobcard
• Add New Pro-Forma Invoice
• Add New Payment
• Add New Payout
• Add New Purchase Order
• Add New Quote
• Add New Recurring Invoice
• Add Item to Recurring Invoice / Pro-Forma Invoice
• Remove Item from Recurring Invoice / Pro-Forma Invoice
• Get Client Documents by Type

Other

• Get Business Name

Updated: Fri, 13 August 2021