API Reference
Start typing to search…

Update Specific Agent Profile

patch https://example.com/agent/web/Agents//Profiles

Update a specific Agent Profile for a specified agent.

Log in to see full request history
Path Params
int64
required

The unique Agent identifier. Field values are accessed through the Agent Management specification endpoint GET /Agents/Profiles .

Body Params
int32

The unique Dealer Code assigned to an Agent.

string

The unique Dealer Representative Number assigned to an Agent.

int64

The unique Client Number of the Parent Agent Profile. Field values are accessed through the Agent Management specification endpoint GET /Agents/Profiles.

boolean

If TRUE, a Parent Agent Profile exists; FALSE otherwise.

string

The Agent Type of an Agent Profile specifying how Agent Commissions are paid. Field values are accessed through the Agent Management specification endpoint GET /System/Agents/AgentTypes.

boolean

Indicates if the specified Agent will have commission paid by PAD. This value is not editable if HasParentProfile is 'true' and will be set by the value under the Parent Agent Client.

string

The unique code identifying a Cost Centre.

string

Not currently implemented.

string

The unique code of the Home Branch to which an Agent is assigned.

string

The unique Bank Customer Number to which a Bank assigns to an Agent.

string

The Distribution channel of an agent. Field values are accessed using the Agent Management specification endpoint GET /System/Agents/DistributionChannels.

boolean

If TRUE, the Agent Rate is used; if FALSE, the Standard Rate is used. This field is applicable to Term Deposits only.

boolean

If TRUE, Net Commission is posted; FALSE otherwise. This field is applicable to Term Deposits only.

boolean

If TRUE, Net Settlement is used; if FALSE, Gross Settlement is used. This field is applicable to Term Deposits only.

string

The File Types included in the Net Settlement process. This field is applicable to Term Deposits only. Field values are accessed through the Agent Management specification endpoint GET /System/Agents/NetSettlementTypes.

boolean

If TRUE, a bar code is printed on Term Deposit cheques; FALSE otherwise. This field is applicable to Term Deposits only.

boolean

If TRUE, Secondary Agent information is printed on Term Deposit cheques; FALSE otherwise. This field is applicable to Term Deposits only.

string

Not currently implemented.

string

Not currently implemented.

string

The LEI-Legal Entity Identifier-of an Agent.

boolean

Indicates if all active deposits will have the home branch updated. This is only required when doing a PATCH and when the HomeBranch is changed.

boolean

Indicates if all active deposits will have the LEI updated. This is only required when doing a PATCH and when the LEI is changed.

Responses

Response body
object
data
object
int64

The unique code identifying a Client.

int32

The unique Dealer Code assigned to an Agent.

string

The unique Dealer Representative Number assigned to an Agent.

int64

The unique Client Number of the Parent Agent Profile. Field values are accessed through the Agent Management specification endpoint GET /Agents/Profiles.

boolean

If TRUE, a Parent Agent Profile exists; FALSE otherwise.

string

The Agent Type of an Agent Profile specifying how Agent Commissions are paid. Field values are accessed through the Agent Management specification endpoint GET /System/Agents/AgentTypes.

boolean

Indicates if the specified Agent will have commission paid by PAD. This value is not editable if HasParentProfile is 'true' and will be set by the value under the Parent Agent Client.

string

The unique code identifying a Cost Centre.

string

Not currently implemented.

string

The unique code of the Home Branch to which an Agent is assigned.

string

The unique Bank Customer Number to which a Bank assigns to an Agent.

string

The Distribution channel of an agent. Field values are accessed using the Agent Management specification endpoint GET /System/Agents/DistributionChannels.

boolean

If TRUE, the Agent Rate is used; if FALSE, the Standard Rate is used. This field is applicable to Term Deposits only.

boolean

If TRUE, Net Commission is posted; FALSE otherwise. This field is applicable to Term Deposits only.

boolean

If TRUE, Net Settlement is used; if FALSE, Gross Settlement is used. This field is applicable to Term Deposits only.

string

The File Types included in the Net Settlement process. This field is applicable to Term Deposits only. Field values are accessed through the Agent Management specification endpoint GET /System/Agents/NetSettlementTypes.

boolean

If TRUE, a bar code is printed on Term Deposit cheques; FALSE otherwise. This field is applicable to Term Deposits only.

boolean

If TRUE, Secondary Agent information is printed on Term Deposit cheques; FALSE otherwise. This field is applicable to Term Deposits only.

string

Not currently implemented.

string

Not currently implemented.

string

The LEI-Legal Entity Identifier-of an Agent.

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

500

An error occurred on the backend server

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
Authenticate

Updated about 2 months ago

Did this page help you?