Read bank accounts

GET /bankaccounts

Read a list of bank accounts with details. Each bank account includes information such as account number, BIC, type, name, owner details, creation timestamp, modification timestamp, and the latest balance information, should there be one available.

Headers

Query parameters

  • before string(date)

    The date to get the balance from. The balance returned will be the last balance before this date. If omitted, the current date is used. The date format here is YYYY-MM-DD.

Responses

  • 200 application/json
    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object

    Response model for a bank account

    • id string(uuid) Required

      A unique identifier for the bank account within 24SevenOffice.

    • number string Required

      The account number of the bank account.

    • bic string Required

      The Business Identifier Codes (BIC) for the bank that manages the bank account.

    • type string Required

      The type of the bank account, which is one of the following:

      • bban: Basic Bank Account Number is a country-specific bank account number format.
      • iban: International Bank Account Number format.

      Values are bban or iban.

    • name string Required

      A user-defined name of the bank account, as it is shown in 24SevenOffice.

    • owner object Required

      Details for the bank account owner.

      Hide owner attributes Show owner attributes object
      • name string Required

        The company name of the bank account owner.

      • organizationNumber string Required

        The organization number of the bank account owner.

      • contact object Required

        Details for the contact person for the bank account owner.

        Hide contact attributes Show contact attributes object
        • name string Required

          The name of the contact person.

        • email string(email) Required

          The email of the contact person.

    • balance object

      The balance of the bank account. The whole balance object is omitted if no balance is available.

      Hide balance attributes Show balance attributes object
      • amount number

        The amount of the balance.

      • timestamp string(date-time)

        The timestamp of the balance.

      • currency object

        The currency of the balance.

        It is recommended to avoid sending in the currency rate and rely on the automatic default exchange rate calculated by 24SevenOffice.

        Hide currency attributes Show currency attributes object
        • code string Required

          The currency code of the balance.

        • rate number

          The exchange rate of the currency. This rate is used when converting the balance to the currency used in 24SevenOffice.

          The automatic default exchange rate works like the following:

          • If the bank account balance currency is different from the currency stored in 24SevenOffice, the exchange rate is automatically looked up using the timestamp of the balance.
          • If the bank account balance currency is the same as the currency stored in 24SevenOffice, the exchange rate defaults to 1.
    • createdAt string(date-time) Required

      A timestamp for when a record was created, in ISO 8601 format.

    • modifiedAt string(date-time) Required

      A timestamp for when one of the properties of a record was last modified, in ISO 8601 format. The Bank Account Balance changes are not included here, as these are defined by a separate "timestamp" property for the balance object.

GET /bankaccounts
curl \
 -X GET https://rest.api.24sevenoffice.com/v1/bankaccounts \
 -H "Authorization: string"
Response examples (200)
[
  {
    "id": "123-456-789",
    "bic": "DNBANOKKXXX",
    "name": "ABC bank account",
    "type": "bban",
    "owner": {
      "name": "ABC Corporation",
      "contact": {
        "name": "John Doe",
        "email": "doe@example.com"
      },
      "organizationNumber": "123456789"
    },
    "number": "90000000001",
    "balance": {
      "amount": 1100,
      "currency": {
        "code": "NOK",
        "rate": 1
      },
      "timestamp": "2024-06-02T12:00:00.000Z"
    },
    "createdAt": "2022-01-01T18:00:00.000Z",
    "modifiedAt": "2023-12-31T18:00:00.000Z"
  },
  {
    "id": "456-789-012",
    "bic": "DNBANOKKYYY",
    "name": "XYZ bank account",
    "type": "iban",
    "owner": {
      "name": "XYZ Corporation",
      "contact": {
        "name": "Jane Doe",
        "email": "jane@example.com"
      },
      "organizationNumber": "987654321"
    },
    "number": "90000000002",
    "balance": {
      "amount": 1500,
      "currency": {
        "code": "USD",
        "rate": 10
      },
      "timestamp": "2024-07-01T12:00:00.000Z"
    },
    "createdAt": "2023-01-01T18:00:00.000Z",
    "modifiedAt": "2024-01-01T18:00:00.000Z"
  },
  {
    "id": "789-012-345",
    "bic": "DNBANOKKZZZ",
    "name": "DEF bank account",
    "type": "bban",
    "owner": {
      "name": "DEF Corporation",
      "contact": {
        "name": "Alice Smith",
        "email": "alice@example.com"
      },
      "organizationNumber": "987654321"
    },
    "number": "90000000003",
    "createdAt": "2023-02-01T18:00:00.000Z",
    "modifiedAt": "2024-02-01T18:00:00.000Z"
  }
]