/updateaccount

V1.0

Description

Updates a given account in iCasework with the provided details. Both Type and ExternalAccountId must be specified.. The other parameters noted below can be optionally provided to update certain aspects of the account.

Request Method

POST

API Service endpoints

UAT: https://uat.icasework.com/updateaccount?db=[youriCaseworkAccount]
eUAT / Production system: https://[youriCaseworkAccount].icasework.com/updateaccount

Your iCasework account name will be supplied to you by your iCasework Account or Project Manager

Request Parameters

Parameter	Description	Example Input	Required value?

Parameter	Description	Example Input	Required value?
Type	The type of account to be updated. Please contact your iCasework representative for the exact codes to use for your configuration.	"CTAX"	Yes.
ExternalAccountId	A reference for the account to be updated.	"abc12345"	Yes.
Balance	The balance for the account.	"100.00"	No.
BalanceDate	The date the balance was applied to the account. Should be in YYYY-MM-DD format.	"2021-03-21"	No.
ClosedDate	The date the account was closed. Should be in YYYY-MM-DD format.	"2021-03-21"	No.
StartDate	The date from which this account will be open. Should be in YYYY-MM-DD format.	"2021-03-21"	No.
EndDate	The date until this account will be open. Should be in YYYY-MM-DD format.	"2021-03-21"	No.
Format	Defines the format of the API response. The default value is "xml"	"xml" or "json"	No.
Description	A description of the account.	"30 Stamford Street"	No.
Status	The current status of the account.	"New account"	No.
DateRemoved	The date the account was removed. Passing a value will remove the account. Should be in YYYY-MM-DD format.	“2021-09-07"	No.

Example

Request

<https://example.icasework.com/updateaccount>

{
 "Type": "CTAX",
 "ExternalAccountId": "abc1234",
 "Balance": "150.00",
 "Format": "json"
}

<?xml version="1.0" encoding="UTF-8" ?>
<Type>CTAX</Type>
<ExternalAccountId>abc1234</ExternalAccountId>
<Balance>150.00</Balance>

Response

<?xml version="1.0" encoding="UTF-8"?> 
  <updateaccountattributeresponse>
    <accountid>abc1234</accountid>
  </updateaccountattributeresponse>

{
  "updateaccountattributeresponse": {
    "accountid": "abc1234"
  }
}

HTTP 400 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
84000	Invalid HTTP Method	Check the HTTP method; this should be a POST
84001	API not available here	Check the endpoint of the request
84002	Required parameter Type was not supplied	Include `Type` parameter in the request
84003	Required parameter ExternalAccountId was not supplied	Include `ExternalAccountId` parameter in the request
84099	Unable to locate account	An account for the provided `Type` and `ExternalAccountId` could not be identified; check that these values are correct

HTTP 403 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
84021	Incorrect key or signature	Check the authentication method is valid
84021	Invalid token (6)	Check the authentication method is valid

updateaccount