Create a bankaccount

Updated:

POST/hris/{connection_id}/bankaccount

Creates a HrisBankaccount. Provide the unified HrisBankaccount fields in the request body; they are mapped to the provider's API. Returns the created HrisBankaccount.

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

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstring
employee ID (required for list and create) (reference to HrisEmployee)
company_idstring
(reference to HrisCompany)
account_type enum
Valid values:
"CHECKING"
"SAVINGS"
bank_namestring
routing_numberstring
9-digit US routing number
account_numberstring
account_number_last4string
when full number not returned
namestring
account nickname (e.g. "BoA Checking")
is_primaryboolean
primary for direct deposit
ibanstring
International Bank Account Number (non-US accounts)
bicstring
BIC / SWIFT code
country_codestring
ISO 2-digit country code of the bank account
currencystring
split_type enum
Valid values:
"PERCENTAGE"
"FIXED"
"REMAINDER"
how net pay is split into this account when an employee has several accounts
split_amountnumber
percentage (when split_type is PERCENTAGE) or money (when FIXED)
prioritynumber
order in which split accounts are funded (1 = first)
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringNoemployee ID (required for list and create) (reference to HrisEmployee)
company_idstringNo(reference to HrisCompany)
account_typeenumNoValues: CHECKING, SAVINGS
bank_namestringNo
routing_numberstringNo9-digit US routing number
account_numberstringNo
account_number_last4stringNowhen full number not returned
namestringNoaccount nickname (e.g. "BoA Checking")
is_primarybooleanNoprimary for direct deposit
ibanstringNoInternational Bank Account Number (non-US accounts)
bicstringNoBIC / SWIFT code
country_codestringNoISO 2-digit country code of the bank account
currencystringNo
split_typeenumNohow net pay is split into this account when an employee has several accounts Values: PERCENTAGE, FIXED, REMAINDER
split_amountnumberNopercentage (when split_type is PERCENTAGE) or money (when FIXED)
prioritynumberNoorder in which split accounts are funded (1 = first)
metadataHrisMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.

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: 'POST',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/bankaccount',
  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?