APIs

Overview

APIs documented on this page are available for you to build processes and integrations between Catch-e and your other systems.

IP Address Security: IP addresses from all countries except for AUS, NZ, UK and USA are geo-blocked by the system as a standard security precaution. If you want to run APIs from other countries, you will need to whitelist IP addresses to do so.

HJSON Support: Use HJSON to mark up API JSON payloads with comments. This is useful when you are testing. Visit hjson.github.io for details of this mark up.

SDK: A PHP SDK can be provided by Catch-e to interface with the APIs. Please contact support if you would like further details.

Supplementary Documentation: Supplementary swagger documentation is available here: https://api.catch-e.com/docs/#/

Note: The linked swagger documentation lists all of the APIs that are used in the system. Most of the APIs listed on this page are available for external use. Contact your Account Manager to discuss API access or development.

Access

Run the Authenticate API first to generate the access token you need to pass on all the other APIs. No other API will run without an access token.

Authentication

Method

Comments

Authenticate with the API

Request an API token for use with secured methods.

Generate a signon token

Request a signon token to enable single signon for a user.

API Categories

Attachments

Method

Comments

Permission

Delete an attachment

Delete an existing attachment.

Get an attachment by attachment id

Get an existing attachment.

Get an attachment resource pre-signed URL

Get an attachment resource pre-signed URL

Save an attachment

Save an attachment.

Cards

Method

Comments

Permission

Create cards

Create cards.

Cards:Create

Get a list of cards

Get a list of cards.

Cards:Get

Update a list of cards

Update a list of cards.

Cards:Update

Get a card by card id

Get a card by card id.

Cards:Get

Update card

Update card.

Cards:Update

Clients

Method

Comments

Permission

createClients

Allows you to create new clients.

Clients:Create

copyClient

Allows you to copy a client record.

Clients:Create

patchClient

Allows you to edit clients.

Clients:Update

Supporting APIs

Method

Comments

Permission

getClient

Allows you to retrieve a list of client fields.

Clients:Get

getClientDivisions

Allows you to retrieve a list of client divisions.

ClientDivisions:Get

getClientIndustries

Allows you to retrieve a list of client industries.

ClientIndustries:Get

getClientCostCentres

Allows you to retrieve a list of client cost centres.

ClientCostCentres:Get

Client Groups

Method

Comments

Permission

getClientGroups

Get a list of Client Group/s

createClientGroup

Create new Client Group record

patchClientGroup

Update a Client Group

Contracts

Method

Comments

Permission

Perform a contract funds check

This method returns the values displayed on the Funds Check pop-up screen.

Contract:FundsCheck

createContracts

This method allows you to create Contracts.

Contracts:Create

getContract

This method allows you to get Contract details.

Contracts:Get

getContracts

This method allows you to get a list of Contracts and related details

Contracts:Get

patchContract

This method allows you to update a Contract.

Contracts:Update

Contract / Billing

Method

Comments

Permission

Edit budgets for a contract that has not yet billed

Edit budgets for a contract that has not yet billed.

ContractBilling:Edit

varyContractBilling

Modify future billings for a contract that has started billing.

ContractBilling:Vary

Contract / Budgets

Method

Comments

Permission

Get contract budgets for the specified search criteria

getContractBudgets

ContractBudgets:Get

Update contract budgets

updateContractBudgets: update either all remaining contract budget periods or a single period.

ContractBudgets:Update

Insert new contract budgets

Insert new contract budgets. This API replicates the system process to adjust a lease period billing.

ContractBudgets:Insert

Contract / Events

Method

Comments

Permission

getContractEventActions

Get contract event actions.

ContractEventActions:Get

getContractEventDescriptions

Get contract event descriptions.

ContractEventDescriptions:Get

getContractEventValues

Get contract event values.

ContractEventValues:Get

createContractEvents

Create contract events.

ContractEvents:Create

changeContractDriver

Change driver by creating a driver change event.

ContractEvents:ChangeDriver

changeContractCostCentre

Change cost centre by creating a client cost centre change event.

ContractEvents:changeContractCostCentre

Drivers

Method

Comments

Permission

createDrivers

Create new Driver records

getDrivers

Get a list of Drivers

updateDriversList

Update a list of Drivers

getDriver

Get details for a Driver

updateDriver

Update a Driver's details

deidentifyDriverData

Deidentify a Driver's personal details via a Scheduler Job.

Restricted

Drivers / Assets and Liabilities

These services allow you to update Assets details on the Drivers / Assets and Liabilities tab.

Method

Comments

Permission

Get finance asset types

Allows you to retrieve a Financiers Asset Types for use in the createDriverAssets and updateDriverAssets APIs.

Get assets for a driver

Allows you to retrieve a Drivers' Assets for use in the updateDriverAssets APIs.

Create asset for a driver

Allows you to add new Drivers' Asset/s.

Update asset for a driver

Allows you to update Drivers' Asset/s.

Delete asset for a driver

Allows you to Delete a Driver Asset.

Get finance liability types

Allows you to retrieve a Financiers Liability Types for use in the createDriverLiabilities and updateDriverLiabilities APIs.

Get finance liability financiers

Allows you to retrieve a list of Finance Liability Financiers for use in the createDriverLiabilities and updateDriverLiabilities APIs.

Get liabilities for a driver

Allows you to retrieve a Drivers' Liabilities for use in the updateDriverLiabilities APIs.

Create liability for a driver

Allows you to add new Drivers' Liabilities.

Update liability for a driver

Allows you to update Drivers' Liabilities.

Delete liability for a driver

Allows you to Delete a Driver Liability.

Drivers / Bank Accounts

These services allow you to update Bank Account details on the Drivers / Finances tab.

Method

Comments

Permission

Create bank accounts for drivers

Allows you to create bank account for drivers

DriverBankAccounts:Create

Get driver bank accounts

Allows you to retrieve list of Driver Bank accounts.

DriverBankAccounts:Get

Update a list of driver bank accounts

Allows you to update a list of driver bank accounts.

DriverBankAccounts:Update

Get driver bank account

Allows you to get a driver bank account.

DriverBankAccounts:Get

Update driver bank account

Allows you to update a driver bank account.

DriverBankAccounts:Update

Driver / Events

Method

Comments

Permission

getDriverEventActions

Get driver event actions.

DriverEventActions:Get

getDriverEventDescriptions

Get driver event descriptions.

DriverEventDescriptions:Get

getDriverEventValues

Get driver event values.

DriverEventValues:Get

getDriverEventCodes

Get driver event codes.

DriverEventCodes:Get

createDriverEvents

Create driver events.

DriverEvents:Create

getDriverEvent

Get driver event details for a given driver_event_id.

DriverEvent:Get

getDriverEvents

Get driver event details for a list of driver events.

DriverEvents:Get

patchDriverEvent

Update a given driver event.

DriverEvents:patchDriverEvent

patchDriverEvents

Update a given list of driver events.

DriverEvents:patchDriverEvents

Events

Method

Comments

Permission

emitEvent

Emit an event.

Events:Emit

createEventSubscription

Subscribe to events.

Events:Subscribe

deleteEventSubscription

Delete an event subscription.

Events:Subscribe

reconcileEventSubscriptions

Reconcile event subscriptions.

Events:ReconcileSubscriptions

getEventTypes

Get supported event types.

Events:GetTypes

Event / Jobs

Method

Comments

Permission

spApprovalsAutoBuildClaimsEventJob

Auto Build Claims Event Job.

Events:ExecuteJob

spApprovalsAutoPostClaimsEventJob

Auto Post Claims Event Job.

Events:ExecuteJob

G-NAF

Method

Comments

Permission

getGeocodedNationalAddressRecord

Allows you to get address detail records from the Geoscape Geocoded National Address File (G-NAF).

GNAF:GetAddressRecord

autocompleteGeocodededNationalAddress

Autocomplete (lookup) address detail records from the Geoscape Geocoded National Address File (G-NAF).

GNAF:AutocompleteAddressRecord

Import / Export

These services allow you to Import / Export data from the system.

Method

Comments

Permission

Request a list of tables authorised for data import

Allows you to retrieve a list of tables authorised for data import in the requestTableImport APIs.

ImportTable

Request a table data import

Allows you to import data in the system for validation before the records are updated.

ImportTable

Import public holiday data

This method allows to import public holidays data into table.

ImportTable

Get table data import status

This method is used to get the status of the data import job. To check if the job has finished validating data and it is ready to import.

ImportTable

Trigger table data import procedure

Once the data is validated, this method is used to start the import process (updating the records).

ImportTable

Cancel a table data import

Allows you to cancel data import started using requestTableImport API.

ImportTable

Request a list of tables authorised for data export

Allows you to retrieve a list of tables authorised for data export in the Request a table data export API.

ExportTable

Request a table data export

This method allow you request data export.

ExportTable

Download data for an existing table data export request

This method allow you to get export data.

ExportTable

readRecord

Allows to you to read a single record using the key field names and values.

Record:Get

upsert

Insert or update a record with auditing - use this API to insert or update values for a record. The process includes lock checks and auditing.

Record:Upsert

Interfaces / Salesforce (Legacy)

Method

Comments

Permission

Sync quote with Salesforce (legacy) interface

Sync quote with Salesforce (legacy) interface.

Mail

Method

Comments

Permission

deleteSuppressedDestination

Removes an email address from the suppression list.

Mail:SuppressedDestinationDelete

getSuppressedDestination

Check if a specified email address is a suppressed destination.

Mail:SuppressedDestinationGet

Originators

Method

Comments

Permission

getOriginators

Allows you to retrieve a list of originator records.

Originators:Get

Other

Method

Comments

Permission

Ping

Ping the API

Pay Cycles

Method

Comments

Permission

getPayCycles

Get a list of Pay Cycle ID's

Quotes

Method

Comments

Permission

createQuotes

Create a Quote

Quotes:Create

patchQuote

Edit a Quote.

Quotes:Update

acceptQuote

Accept a quote.

Quotes:Accept

copyQuote

Copy a Quote.

Quotes:Copy

getDealerOrder

Create a Dealer Order form

Quotes:RenderPDF

getChildQuotes

Get a list of child quotes including grand-child, great-grand-child, great-great-grand-child (and so on).

Quotes:GetChildQuotes

render Quote PDF

Render a Quote PDF using Browserless

Quotes:RenderPDF

render Quote PDF with Template

Render a Quote PDF using Browserless using a template archive

Quotes:RenderPDF, Quotes:TemplateDeveloper

Quote / Events

Method

Comments

Permission

getQuoteEvent

Get details for a single quote event.

QuoteEvents:Get

getQuoteEvents

Get a list of quote events.

QuoteEvents:Get

getQuoteEventCodes

Get a list of quote event codes.

QuoteEvents:Get

getQuoteEventActions

Get a list of quote event actions.

QuoteEvents:Get

createQuoteEvents

Create quote event/s.

QuoteEvents:Create

patchQuoteEvents

Edit a single quote event.

QuoteEvents:Update

patchQuoteEventList

Edit multiple quote events.

QuoteEvents:Update

Quote / Variants

Sources

Method

Comments

Permission

Get a list of variant data sources

This method will list details of all variant data sources.

QuotesVariants:Get

Makes

Method

Comments

Permission

Get a list of variant makes

This method will list the makes and its detail.

QuotesVariants:Get

Get a make by make id

This method will return requested make details.

QuotesVariants:Get

Models

Method

Comments

Permission

Get a list of variant models

This method will list the models and its detail.

QuotesVariants:Get

Get an array of model years for a given vehicle model

This method will list all the years for selected model.

QuotesVariants:Get

Get a model by model id

This method will return requested model details.

QuotesVariants:Get

Body Types

Method

Comments

Permission

Get a list of variant body types

This method will list the variant body types and its detail.

QuotesVariants:Get

Get a body type by body type id

This method will return requested body type details

QuotesVariants:Get

Variants

Method

Comments

Permission

Get a list of variants

This method will list requested variants and its detail.

QuotesVariants:Get

Get a variant by variant id

This method will return requested variant details.

QuotesVariants:Get

Get variant standard equipment by variant id

This method will list all standard equipment for selected variant.

QuotesVariants:Get

Get variant optional equipment by variant id

This method will list all optional equipment for selected variant.

QuotesVariants:Get

Get photos for a specific variant

This method will return photo URI of selected variants.

QuotesVariants:Get

createVariants

Create a variant

QuoteVariants:Create

patchVariant

Edit a variant profile.

QuoteVariants:Update

Variant Profiles

Method

Comments

Permission

getVariantProfiles

This method will list requested variant profiles and their details.

patchVariantProfile

Patch a variant profile - this is an embedded section of the patchVariant API.

QuoteVariants:Update

Queries

Method

Comments

Permission

createQuery

Create a new Query.

Queries:Create

getQueries

Get a list of Queries.

Queries:Get

deleteQuery

Delete a Query.

Queries:Delete

getQuery

Get query by Query ID.

Queries:Get

updateQuery

Update an existing Query.

Queries:Update

getArchiveQueries

Get archived Query by Query ID.

Queries:Get

printQuery

Execute a Query.

Queries:Print

Report Queries

Method

Comments

Permission

Print a report query

Print a report query stored in the table.

ReportQueries:Print

Suppliers

Method

Comments

Get a supplier by supplier id

This method returns the supplier details.

Get a list of configured suppliers

This method returns the list of configured suppliers.

Update supplier

This method allows to update the details of supplier

Web Services

  • billingReprintWebService - Re-print an invoice WebServices

  • executeReportWebService - Execute a System Report WebServices

  • createQuoteWebService - Create a new quote. WebServices

  • getQuickQuoteWebService - Performs a full Quote calculation for a salary packaged novated vehicle lease with ecm, and returns individually requested fields or all fields if none are requested. WebServices

  • getQuoteFieldsWebService - Returns quote template placeholders for a saved quote. WebServices

  • getQuotePdfWebService - Returns quote pdf for a saved quote. WebServices

  • reserveInterfaceBatchNosWebService - Reserve a sequence of interface batch nos. WebServices

  • reserveBatchNosWebService - Reserve a sequence of batch nos. WebServices

  • reservePaymentNosWebService - Reserve a sequence of payment nos. WebServices

Legend

Symbol

Description

(standard method)

The API is available by default.

(restricted method)

This API is not configured for external use by default. If you want to use this API, contact your Account Manager to discuss access.