Update Account API

Update Account API

Description

Update the details of a specific account.

Security

Logged in user has account API permissions

URL

Parameters        

Model

FieldTypeDescription
descriptionString (optional)The accounts description
openDate
DateTime (optional)
The open date of account
closedDate
DateTime (optional)
The closed date of account
accountTypeId
Integer (optional)
The account type id of account
clientId
Integer (optional)
The client id on the account
dealerAccountId
Integer (optional)
The dealer account id on the account
regionId
Integer (optional)
The region id on the account
firstAnalysisCodeId
Integer (optional)
First analysis code id on account
secondAnalysisCodeId
Integer (optional)
Second analysis code id on account
accountSourceId
Integer (optional)
Account source id on account
warningIndicatorId
Integer (optional)
Warning indicator id on account

Example

Notes

{                                                                                                                                         
"description": "string",
"openDate": "2020-10-28T01:05:53.436Z",
"closedDate": "2020-10-28T01:05:53.436Z",
"accountTypeId": 0,
"clientId": 0,
"dealerAccountId": 0,
"regionId": 0,
"firstAnalysisCodeId": 0,
"secondAnalysisCodeId": 0,
"accountSourceId": 0,
  "warningIndicatorId": 0 
}

Response

Model

FieldTypeDescription
successBooleanTrue, if the account was successfully updated, false otherwise
errorMessageString (optional)Details the error if success is false, null otherwise
accountIdIntegerThe account id updated by successful call

Example

Notes

{                                                                                                                                         
"success": true,
"errorMessage": "string",
"accountId": 0

Error Codes

HTTP Status CodeType
400No Content (no records match the search)
403Forbidden (invalid Authorisation)
404Dealer not found or Order not found (error will be detailed in response)
503Service Unavailable (due to maintenance)

Online Documentation



    • Related Articles

    • 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: ...
    • Get Account Transactions API

      Description Retrieve the transactions for an account Security Logged in user has account API permissions URL GET ...
    • Argos Vault Release Notes V5.146

      Release Completion Date: 30 August 2024 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in ...
    • Argos Vault Release Notes V5.124

      Argos Vault Release Notes V5.124 Please disregard the release notes for the modules you do not use. Instructions for upgrade are attached to the release email. Unless otherwise indicated, more detail about any change will be included in the relevant ...
    • Argos Release Notes V5.123.54

      Argos Vault Release Notes V 5.123.54 Release Completion Date: 19 February 2020 Please disregard the release notes for the modules you do not use. Please refer to the Argos Installation Manual in your documents folder for instructions on installing ...