hris
bankaccount

Retrieve a bankaccount

Changed on
get/hris/{connection_id}/bankaccount/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/bankaccount/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Bankaccount

Query parameters

fieldsstring[]

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

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring

employee ID (required for listcreate) (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

account_type'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'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)

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 07678e2ad542Revision changes
    • info

      added the enum value bic to the property items/ of the query request parameter fields

    • info

      added the enum value country_code to the property items/ of the query request parameter fields

    • info

      added the enum value currency to the property items/ of the query request parameter fields

    • info

      added the enum value iban to the property items/ of the query request parameter fields

    • info

      added the enum value priority to the property items/ of the query request parameter fields

    • info

      added the enum value split_amount to the property items/ of the query request parameter fields

    • info

      added the enum value split_type to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status