Edit Client

put

https://fslpresales.fslcgix-uat.co.uk/FSLPresales_PhoenixAPI/clients/{clientGuid}

Edit an existing Client

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientGuid

uuid

required

The Unique Identifier for the Client

Body Params

To edit a Client complete the parameters detailed below

clientId

string | null

The identifier for the CGiX Client

clientName

string | null

The name of the Client

sortName

string | null

The sort name of the Client

clientTaxType

string

enum

companyId

string | null

The identifier for the CGiX Company

isIncomeClient

boolean

Is this an income client?

currencyIso

string | null

The ISO Currency Code

incomeTaxRateId

string | null

The Income Tax Rate used by the Client

taxReportingPeriodName

string | null

The name of the Tax Reporting period

isHmrcReportable

boolean | null

Is this Client reportable to HMRC?

incomeTypeName

string | null

The name of the Income Type

incomeSubTypeName

string | null

The name of the Income Sub Type

taxIdentificationNumber

string | null

The Client's Tax Identification Number

taxFormTypeName

string | null

The Tax Form Type

taxFormDate

date-time | null

The Tax Form Date

relationshipStartDate

date-time | null

The Start Date of the relationship

dateOfBirth

date-time | null

The date of birth of the Client

placeOfBirth

string | null

The place of birth

birthCountryIso

string | null

The ISO Country code of the place of birth

residenceCountryIso

string | null

The ISO Country code of the country of residence

passport1CountryIso

string | null

The ISO Country code used in the Client's Passport

passport2CountryIso

string | null

The ISO Country code used in the Client's Passport

countryOfCitizenshipIso

string | null

The ISO Country code of the country of citizenship

usTaxIdNumber

string | null

The US Tax ID Number

dateFormSigned

date-time | null

The date the W8BEN form was signed

dateOfExpiry

date-time | null

The W8BEN form expiry date

externalId

uuid | null

External identifier for the request

externalProcessedDateTime

date-time | null

External date and time of the request

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Accepted

401Unauthorized