Merge · Schema

BankInfo

# The BankInfo Object ### Description The `BankInfo` object is used to represent the Bank Account information for an Employee. ### Usage Example Fetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank information.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
employee	stringnull	The employee with this bank account.
account_number	stringnull	The account number.
routing_number	stringnull	The routing number.
bank_name	stringnull	The bank name.
account_type	object	The bank account type
remote_created_at	stringnull	When the matching bank object was created in the third party system.
remote_was_deleted	boolean	Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BankInfo",
  "title": "BankInfo",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "employee": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The employee with this bank account."
    },
    "account_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account number."
    },
    "routing_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The routing number."
    },
    "bank_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The bank name."
    },
    "account_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/AccountTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The bank account type"
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the matching bank object was created in the third party system."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/BankInfoFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The BankInfo Object\n### Description\nThe `BankInfo` object is used to represent the Bank Account information for an Employee.\n\n### Usage Example\nFetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank information."
}