ApiDocumentation

JSON documentation for the API.

Method Name Description
GET Get_Controllers

Get Documentation for a List of Controllers.

GET Get_Controller

Get Documentation for a Controller.

GET Get_Method

Get Documentation for a Method.

GET Get_Type

Get Documentation for a Type.

HtmlDocumentation

HTML documentation for the API.

Method Name Description
GET Get_Home

Returns the HTML Documentation home page.

GET Get_Controller

Get HTML Documentation for a Controller.

GET Get_Method

Get HTML Documentation for a Method.

GET Get_Type

Get HTML Documentation for a Type.

BearerTokenAuth

Authentication endpoints for Bearer Token Authentication actions.

Method Name Description
POST Refresh

Refresh Access token using current Refresh token.

GET GetAuthLevel

Return the value as an integer for the current user (or zero for non-authenticated requests).

DELETE Logout

Destroy Bearer tokens for the currently authenticated user.

EmailAuth

Authentication endpoints for Email Authentication actions.

Method Name Description
POST RequestAuth

Initiate Email Authentication (MFA) for the currently authenticated user.

POST VerifyAuth

Complete Email Authentication (MFA) for the currently authenticated user.

PasswordAuth

Authentication endpoints for Password Authentication actions.

Method Name Description
POST Login

Attempt to authenticate and receive Access and Refresh Bearer tokens.

POST RequestPasswordChange

Initiate Password change request by email.

POST VerifyPasswordChange

Complete Password change request using code sent by email.

Default

Default API Controlller

Method Name Description
GET DefaultRedirect

Default redirect to HTML documentation.

GET IsApiUp_GET

Responds with JSON Status of API. Useful for service monitoring.

HEAD IsApiUp_HEAD

Responds with Success. Useful for service monitoring.

User

User Controller

Method Name Description
POST RegisterUser_Client

Used to Create a new top-level (Corporate) Client User. Used by Portal Signup process for Clients.

POST InviteUser_Client

Invite an additional User to join the Client account

POST ReInviteUser_Client

Re-Invite an addiitional User to join the Client account.

PUT UpdateUser_Client

Allows a Client User to update their User record.

GET GetCurrentUser

Get the currently signed-in User record.

GET GetUserById

Get the User account by Id. Can only get a Client User account you have access to. Used by Client User accounts that have multiple Client User accounts.

GET GetUsers

PATCH PatchUser

Update Email / Password for a Client User account.

POST CompleteAndSignIn

Used for CRM-led client account creation. This method allows the new User to set a password and signin. Confirmation code is provided by email prior to call, so no need for a second visual auth step.

GET ClientUserIsSetup

User for CRM-led client account creation. Checks if the Client User has completed setup.

POST CompleteInviteAndSignIn

Used for invite-led user account creation. This method allows the new User to set a password and signin. Confirmation code is provided by email prior to call, so no need for a second visual auth step.

Client

Client Controller

Method Name Description
GET GetClient

GET GetClients

POST CreateClient

Create a new Client account for this User.

PUT UpdateClient

PATCH PatchClient

DataTypes

Method Name Description
GET GetCountries

Gets a table of ISO-3166 Countries.

GET GetCurrencies

Gets a table of Currencies.

GET GetTelephoneSystems

Gets a table of supported Telephone Systems (numbering systems).

GET GetClientIpAddress

Get the Client IP Address

Debtor

Debtor Controller

Method Name Description
GET GetDebtor

Gets a Debtor by debtorId. Debtor must be child of supplied clientId. User must have access to Client hierarchy.

GET GetDebtors

POST CreateDebtor

POST UpdateDebtor

DebtorHistory

DebtorHistory Controller

Method Name Description
GET GetHistoryItems

Upload

Method Name Description
POST Uploads_Client

POST Uploads_ClientDebtor_DefinedForm

GET GetUploads_Client