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        

1. clientId: [Required, part of URL] client to retrieve

Response

ClientDto

Field	Type	Description
id	Integer	The client ID
code	String	The client code
clientDetailsLink	Link	URL for the client details
dateOfBirth	DateTime (optional)	The client date of birth (if present)
active	Boolean	True if the client is active
contactName	String	The client contact name
physicalAddress	String	The client physical address
postalAddress	String	The client postal address
workEmailAddress	String	The client work email address
homeEmailAddress	String	The client home email address
workPhone	String	The client work phone
homePhone	String	The client home phone
mobilePhone	String	The client mobile phone
companyNumber	String	The client company number
driversLicenceNumber	String	The client company number
withholdingTaxRate	Number	The client withholding tax rate
bankAccount	String	The client bank account
numberOfAccounts	Integer	The number of client accounts
branchId	Integer	Identifier of the branch
directPhone	String	Direct phone number
genderId	Integer	Identifier of the gender
homeFax	String	Home fax number
notes	String	Notes on the client
occupationId	Integer	Identifier of the occupation
taxNumber	String	Taxation authority number
workFax	String	Work fax number
nextReviewDate	DateTime	The client credit next review date
lastReviewDate	DateTime	The client credit last review date
creditCode	String	The client credit code
secondaryCode	String	The client secondary code
tags	List	The client tags

Example

{                                                                                                                                         

"nextReviewDate": "2024-07-18T00:57:47.688Z",

"lastReviewDate": "2024-07-18T00:57:47.688Z",

"creditCode": "string",

"secondaryCode": "string",

"tags": [

      {

      "value": "string",

      "category": "string",

      "code": "string",

      "description": "string",

      "id": 0

      }

],

"dateOfBirth": "2024-07-18T00:57:47.688Z",

"contactName": "string",

"physicalAddress": "string",

"postalAddress": "string",

"workEmailAddress": "string",

"homeEmailAddress": "string",

"workPhone": "string",

"homePhone": "string",

"mobilePhone": "string",

"companyNumber": "string",

"driversLicenceNumber": "string",

"withholdingTaxRate": 0,

"bankAccount": "string",

"numberOfAccounts": 0,

"branchId": 0,

"directPhone": "string",

"genderId": 0,

"homeFax": "string",

"notes": "string",

"occupationId": 0,

"taxNumber": "string",

"workFax": "string",

"id": 0,

"code": "string",

"active": true,

"clientDetailsLink": {

      "description": "string",

      "url": "string"

      }

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
400	Bad Request (request format error)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
404	Client not found
503	Service Unavailable (due to maintenance)

Online Documentation

https://api.argos.co.nz/WebApi/swagger/ui/index#!/Clients

• Related Articles

• Get All Clients API

  Description Get a list of all clients in the system Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients?clientCode={clientCode}&clientName={clientName}&activeOnly={false}&groupCode={groupCode} Parameters ...

• Get Account Transactions API

  Description Retrieve the transactions for an account Security Logged in user has account API permissions URL GET ...

• Get Account Details API

  Description Retrieve the system specific details for an account Security Logged in user has account API permissions URL GET http://exampleserver.com/api/{system}/{accountId}?calculationDate=date Parameters system: [Required, part of URL] One of (case ...

• Search Accounts API

  Description Search for accounts matching criteria Security Logged in user has account API permissions URL GET http://exampleserver.com/api/accounts?code={code}&activeOnly={false}&clientId={clientId}&system={system}&openOnly={false} Parameters code: ...

• Create Client API

  Description Add a new client Security Logged in user has client API permissions URL POST http://example.com/api/clients/createClient Parameters TBC Response Create Client Request Field Type Description code String The client code name String The ...