Headers

• Authorization string Required

  Authorization header

Query parameters

• dateFrom string(date) Required

  Filter bank transactions by start date (inclusive). Date format should be YYYY-MM-DD. Compares dates by greater or equal. Accepts dates in ISO 8601 format.

• dateTo string(date) Required

  Filter bank transactions by end date (inclusive). Date format should be YYYY-MM-DD. Compares dates by less or equal. Accepts dates in ISO 8601 format.

• bankAccountId string(uuid)

  Filter bank transactions by bank account ID.

• limit integer

  Specify the number of items to fetch per page, defaults to 25.

  Minimum value is 1, maximum value is 100. Default value is 25.

• page integer(int)

  Specify the page number to fetch, defaults to 1.

  Minimum value is 1. Default value is 1.

Responses

• 200 application/json

  Successful operation

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string
  • Access-Control-Allow-Credentials string
  • X-Trace-Id string
  Hide response attributes Show response attributes object

  A single bank transaction

  • bankTransactionReference string Required

    Unique identifier for the bank transaction supplied by the bank that manages the bank account. It must be globally unique across all bank accounts for the client. A duplication warning is returned if this is not the case.

  • type string Required

    Direction of the payment. "Inbound" stands for an incoming payment. E.g. a payment of an invoice by a customer. "Outbound" is a payment originating from this bank account. E.g a debet card transaction, when paid for goods and services.

    Values are inbound or outbound.

  • bankAccount object Required

    Details of the bank account involved in the transaction.

    Additional properties are allowed.

    Hide bankAccount attribute Show bankAccount attribute object

    • id string Required

      A unique identifier for the bank account within 24SevenOffice.

  • paymentReference object Required

    The payment reference must be one of the following types: text, ocr, invoiceRef.

    • text: The value is a free text reference.
    • ocr: The value is an structured OCR reference. KID number in Norway.
    • invoiceRef: The value is an invoice number.

    The actual value of the reference is set in the value property.

    Additional properties are allowed.

    Hide paymentReference attributes Show paymentReference attributes object

    • type string Required

      Values are text, ocr, or invoiceRef.

    • value string Required

      This must be a string of max 1000 characters.

  • amount object Required

    Amount of the bank transaction.

    Additional properties are allowed.

    Hide amount attributes Show amount attributes object

    • value number Required

      The amount in the currency specified. Must be a positive number.

    • currency object Required

      The currency of the balance.

      Additional properties are allowed.

      Hide currency attribute Show currency attribute object

      • code string Required

        The currency code of the balance.

  • date string Required

    Date of the transaction.

  • fromBankAccount object

    The originating bank account for transactions. This is automatically set for outbound transactions, i.e. the property is always returned in the API responses for outbound transactions.

    Additional properties are allowed.

    Hide fromBankAccount attributes Show fromBankAccount attributes object

    • number string | null

      Number of the originating bank account for outbound transactions.

    • type string | null

      Type of the originating bank account for outbound transactions.

      Values are bban or iban. Default value is bban.

  • toBankAccount object

    The receiving bank account for transactions. This is automatically set for inbound transactions, i.e. the property is always returned in the API responses for inbound transactions.

    Additional properties are allowed.

    Hide toBankAccount attributes Show toBankAccount attributes object

    • number string | null

      Number of the receiving bank account for inbound transactions.

    • type string | null

      Type of the receiving bank account for inbound transactions.

      Values are bban or iban. Default value is bban.

  • bankTransactionCode object

    The bank transaction code is a structured code that identifies the type of a transaction. The code is structured in three levels: domain, family and subfamily.

    • The domain code is the highest level and is used to group the transaction codes into different domains.
    • The family code is used to group the transaction codes within a domain.
    • The subfamily code is used to group the transaction codes within a family.

    Additional properties are allowed.

    Hide bankTransactionCode attributes Show bankTransactionCode attributes object

    • domainCode string | null

      Domain code of the bank transaction.

    • familyCode string | null

      Family code of the bank transaction.

    • subFamilyCode string | null

      Subfamily code of the bank transaction.

  • status string Required

    Status of the bank transaction, controlled by the backend and always returned in the API-responses. Possible values are the following:

    • created: The transaction has been created.
    • closed: The transaction has been closed in the bank reconciliation module.

    Values are created or closed.

  • 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.