v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Update Internal Account

patch/internal_accounts/{id}

Path parameters

idstring required

Request body

namestring

A nickname for the internal account

metadatastring json

Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or null as the value.

external_idstring

An optional user-defined 180 character unique identifier

ledger_account_idstring

The Ledger Account you would like to link to the internal account.

contra_ledger_account_idstring

The Contra Ledger Account you would like to link to the internal account.

Response

200

idstring

objectstring

live_modeboolean

{"stackTrail":"paths:/internal_accounts/{id}:patch:responses:200:content:application/json:schema:properties:account_type","oasType":"schema","type":"unknown"}

party_namestring

{"stackTrail":"paths:/internal_accounts/{id}:patch:responses:200:content:application/json:schema:properties:party_type","oasType":"schema","type":"unknown"}

namestring

metadataobject

currencystring

{"stackTrail":"paths:/internal_accounts/{id}:patch:responses:200:content:application/json:schema:properties:parent_account_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/internal_accounts/{id}:patch:responses:200:content:application/json:schema:properties:counterparty_id","oasType":"schema","type":"unknown"}

ledger_account_idstring

contra_ledger_account_idstring

created_atstring

updated_atstring

external_idstring nullable

debitableboolean nullable

Example response

{
  "id": "7355aaa7-1be9-4b6a-b0f7-2d67eeae0666",
  "object": "internal_account",
  "party_name": "Your Company",
  "party_address": {
    "id": "1655db64-7c75-4f91-bf9d-6ff5af8a8f14",
    "object": "address",
    "line1": "1994 Wyman Islands",
    "line2": "Suite 337",
    "locality": "North Marianoland",
    "region": "SC",
    "postal_code": "24640-3149",
    "country": "US",
    "created_at": "2022-08-30T21:47:29Z",
    "updated_at": "2022-08-30T21:47:29Z"
  },
  "account_details": [
    {
      "id": "d1029673-e5ef-489d-aeba-c4bdf71e1e53",
      "object": "account_detail",
      "account_number": "9080669990",
      "account_number_type": "other",
      "created_at": "2022-08-30T21:47:29Z",
      "updated_at": "2022-08-30T21:47:29Z"
    }
  ],
  "routing_details": [
    {
      "id": "d04ff7bd-9c41-4d3f-b396-068107997e73",
      "object": "routing_detail",
      "routing_number": "021000021",
      "routing_number_type": "aba",
      "bank_name": "JPMorgan Chase Bank National Association",
      "bank_address": {
        "id": "28d54680-7b1c-45da-949d-5f322701241d",
        "object": "address",
        "line1": "1111 Polaris Parkway",
        "locality": "Columbus",
        "region": "OH",
        "postal_code": "43240",
        "country": "US",
        "created_at": "2022-08-30T21:47:29Z",
        "updated_at": "2022-08-30T21:47:29Z"
      },
      "created_at": "2022-08-30T21:47:29Z",
      "updated_at": "2022-08-30T21:47:29Z"
    }
  ],
  "name": "Expenses",
  "connection": {
    "id": "d44f7ff2-9899-4331-84de-2e4e7cdb8fb3",
    "object": "connection",
    "vendor_id": "example1",
    "vendor_name": "Gringotts Wizarding Bank",
    "created_at": "2022-08-30T21:47:29Z",
    "updated_at": "2022-08-30T21:47:29Z"
  },
  "currency": "USD",
  "created_at": "2022-08-30T21:47:29Z",
  "updated_at": "2022-08-30T21:47:29Z",
  "external_id": "111000025"
}