Update an account

PUT/accounting/{connection_id}/account/{id}

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Account

Payload

Chart of accounts

idstring
Identifier used by the SaaS application to uniquely identify the Account
created_atdate-time
Date and time when the Account was created, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
Date and time when the Account was last updated, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
Account name
descriptionstring
Account description
type enum
Valid values:
"ACCOUNTS_PAYABLE"
"ACCOUNTS_RECEIVABLE"
"BANK"
"CREDIT_CARD"
"FIXED_ASSET"
Account type, such as BANK. EQUITY, ASSET, ...
status enum
Valid values:
"ACTIVE"
"ARCHIVED"
Account status, such as ACTIVE or ARCHIVED
balancenumber
Balance of the account.
currencystring
Account’s currency, in ISO 4217 format (e.g. U.S. dollars is USD)
customer_defined_codestring
Identifier for tracking and categorizing accounts for reporting or analysis purposes that is defined by the end-customer
is_payableboolean
True if the account is an “accounts payable” account
parent_idstring
The parent account ID for this account
taxonomy array
organization_idstring

Returns

Response fieldTypeRequiredDescription
idstringNoIdentifier used by the SaaS application to uniquely identify the Account
created_atstring (date-time)NoDate and time when the Account was created, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoDate and time when the Account was last updated, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoAccount name
descriptionstringNoAccount description
typeenumNoAccount type, such as BANK. EQUITY, ASSET, ... Values: ACCOUNTS_PAYABLE, ACCOUNTS_RECEIVABLE, BANK, CREDIT_CARD, FIXED_ASSET, LIABILITY, EQUITY, EXPENSE, REVENUE, OTHER
statusenumNoAccount status, such as ACTIVE or ARCHIVED Values: ACTIVE, ARCHIVED
balancenumberNoBalance of the account.
currencystringNoAccount’s currency, in ISO 4217 format (e.g. U.S. dollars is USD)
customer_defined_codestringNoIdentifier for tracking and categorizing accounts for reporting or analysis purposes that is defined by the end-customer
is_payablebooleanNoTrue if the account is an “accounts payable” account
parent_idstringNoThe parent account ID for this account
taxonomyAccountingAccountTaxonomy[]No
taxonomy[].typeenumYesValues: CLASSIFICATION, GROUP, SUBGROUP, SYSTEM_ROLE, OTHER
taxonomy[].original_typestringNo
taxonomy[].valuestringYes
organization_idstringNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'PUT',
  url: 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/account/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?