Create Client API

Create Client API

Description

Add a new client

Security

Logged in user has client API permissions

URL

Parameters        

  1. TBC

Response

Create Client Request

FieldTypeDescription
codeStringThe client code
name
String
The client name
actualAddress
String (optional)
The client's physical, or street address
postalAddress
String (optional)
The client's postal address
notes
String (optional)
Notes on the client
genderCode
String
Codes of the client's gender
occupationCode
String
Codes of the client's occupation
branchCode
String
Codes of the client's branch
workPhone
String (optional)
The client's work phone number
workFax
String (optional)
The client's work fax number
workEmail
String (optional)
The client's work email address
mobilePhone
String (optional)
The client's mobile phone number
directPhone
String (optional)
The client's direct phone number
homePhone
String (optional)
The client's home phone number
homeFax
String (optional)
The client's home fax number
homeEmail
String (optional)
The client's home email address
taxNumber
String (optional)
The client's IRD number
withholdingTaxCode
String
Code of the client's withholding tax code

Example

Notes

{                                                                                                                                          
"success": "string",
"documentNumber": "string"
} 

Error Codes

HTTP Status CodeType
200OK (Success)
400Bad Request (request format error or validation failure)
401Unauthorised (not Authenticated)
403Forbidden (invalid Authorisation)
503Service Unavailable (due to maintenance)

Online Documentation



    • Related Articles

    • Create Interest Profile API

      Description Add a new interest profile Security Logged in user has client API permissions URL POST http://example.com/api/interestProfiles/CreateInterestProfile Parameters CreateInterestProfileRequest Field Type Description code String The interest ...

    • Create Variable Loan Account API

      Description Add a new variable loan Security Logged in user has client API permissions URL POST http://example.com/api/accounts/CreateVariableLoanAccount Parameters CreateVariableLoanAccountRequest Field Type Description code String The account code ...

    • Update Client API

      Description Update the details of a specific client Security Logged in user has client API permissions URL PATCH http://exampleserver.com/api/v3/Clients/{client_id} Parameters Model Field Type Description actualAddress String (optional) The client's ...

    • Get Client API

      Description Get details for a specific client Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients/{clientId} Parameters clientId: [Required, part of URL] client to retrieve Response ClientDto Field Type ...

    • Installing Argos Internal API

      The Argos Internal API is used to power the Vault and Bailment applications. Note, this is available from Argos v6.0 onwards Installation Types The installer can be used to install a production instance of the Argos Internal API. Instructions to ...