Bank Transactions

Server

Download schema

Search and retrieve bank transaction records.

Search Bank Transactions

POST

https://api-stag.utilitycloud.app

/be/v3/ledger/banktransactions/search

Bearer (JWT)

Returns a paginated list of bank transactions matching the specified search criteria.

Search Bank Transactions › query Parameters

page

integer · int32 · required

The page number to retrieve. The first page is 1.

size

integer · int32 · required

The number of results per page.

Search Bank Transactions › Request Body

be_ledger_v3_BankTransactionSearchDto

bookedDayFrom

string | null · date

bookedDayTo

string | null · date

amountFrom

number | null · double

amountTo

number | null · double

itemRef

string | null

text

string | null

onlyUnmatched

boolean

includeHidden

boolean

Search Bank Transactions › Responses

Success

be_ledger_v3_BankTransactionDto[]

be_ledger_v3_BankTransactionDto

transactionKey

string

createdUtc

string · date-time

itemRef

string | null

customerGuid

string | null · uuid

matchedMethod

string | null

matchedDetails

string | null

bookedDay

string | null · date

transactionCode

string | null

issuer

string | null

servicerRef

string | null

paymentInfoId

string | null

paymentInstrId

string | null

payeerName

string | null

accountId

string | null

accountName

string | null

bic

string | null

customerIdentificationNumber

string | null

additionalInformation

string | null

amount

number | null · double

amountCcy

string | null

payeerAddress

string | null

payeerPostCode

string | null

payeerCity

string | null

payeerCountry

string | null

filename

string | null

sentToInterimLedgerUtc

string | null · date-time

array | null

POST/be/v3/ledger/banktransactions/search

curl 'https://api-stag.utilitycloud.app/be/v3/ledger/banktransactions/search?page=<number>&size=<number>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bookedDayFrom": "2024-08-25",
  "bookedDayTo": "2024-08-25",
  "amountFrom": 0,
  "amountTo": 0,
  "itemRef": "itemRef",
  "text": "text",
  "onlyUnmatched": true,
  "includeHidden": true
}'

Example Request Body

{
  "bookedDayFrom": "2024-08-25",
  "bookedDayTo": "2024-08-25",
  "amountFrom": 0,
  "amountTo": 0,
  "itemRef": "itemRef",
  "text": "text",
  "onlyUnmatched": true,
  "includeHidden": true
}

json

Example Responses

[
  {
    "transactionKey": "transactionKey",
    "createdUtc": "2024-08-25T15:00:00Z",
    "itemRef": "itemRef",
    "customerGuid": "00000000-0000-0000-0000-000000000000",
    "matchedMethod": "matchedMethod",
    "matchedDetails": "matchedDetails",
    "bookedDay": "2024-08-25",
    "transactionCode": "transactionCode",
    "issuer": "issuer",
    "servicerRef": "servicerRef",
    "paymentInfoId": "paymentInfoId",
    "paymentInstrId": "paymentInstrId",
    "payeerName": "payeerName",
    "accountId": "accountId",
    "accountName": "accountName",
    "bic": "bic",
    "customerIdentificationNumber": "customerIdentificationNumber",
    "additionalInformation": "additionalInformation",
    "amount": 0,
    "amountCcy": "amountCcy",
    "payeerAddress": "payeerAddress",
    "payeerPostCode": "payeerPostCode",
    "payeerCity": "payeerCity",
    "payeerCountry": "payeerCountry",
    "filename": "filename",
    "sentToInterimLedgerUtc": "2024-08-25T15:00:00Z",
    "suggestedCustomers": [
      {
        "matchedMethod": "matchedMethod",
        "matchedDetails": "matchedDetails",
        "customerGuid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "suggestedItemRefs": [
      {
        "matchedMethod": "matchedMethod",
        "matchedDetails": "matchedDetails",
        "itemRef": "itemRef",
        "customerGuid": "00000000-0000-0000-0000-000000000000",
        "accountGuid": "00000000-0000-0000-0000-000000000000",
        "invoiceNumber": "invoiceNumber"
      }
    ]
  }
]

json

application/json

Dimensions Debt Collection

API Reference

Bank Transactions

Server

Download schema

Search and retrieve bank transaction records.

Search Bank Transactions

POST

https://api-stag.utilitycloud.app

/be/v3/ledger/banktransactions/search

Bearer (JWT)

Returns a paginated list of bank transactions matching the specified search criteria.

Search Bank Transactions › query Parameters

page

integer · int32 · required

The page number to retrieve. The first page is 1.

size

integer · int32 · required

The number of results per page.

Search Bank Transactions › Request Body

be_ledger_v3_BankTransactionSearchDto

bookedDayFrom

string | null · date

bookedDayTo

string | null · date

amountFrom

number | null · double

amountTo

number | null · double

itemRef

string | null

text

string | null

onlyUnmatched

boolean

includeHidden

boolean

Search Bank Transactions › Responses

Success

be_ledger_v3_BankTransactionDto[]

be_ledger_v3_BankTransactionDto

transactionKey

string

createdUtc

string · date-time

itemRef

string | null

customerGuid

string | null · uuid

matchedMethod

string | null

matchedDetails

string | null

bookedDay

string | null · date

transactionCode

string | null

issuer

string | null

servicerRef

string | null

paymentInfoId

string | null

paymentInstrId

string | null

payeerName

string | null

accountId

string | null

accountName

string | null

bic

string | null

customerIdentificationNumber

string | null

additionalInformation

string | null

amount

number | null · double

amountCcy

string | null

payeerAddress

string | null

payeerPostCode

string | null

payeerCity

string | null

payeerCountry

string | null

filename

string | null

sentToInterimLedgerUtc

string | null · date-time

array | null

POST/be/v3/ledger/banktransactions/search

curl 'https://api-stag.utilitycloud.app/be/v3/ledger/banktransactions/search?page=<number>&size=<number>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bookedDayFrom": "2024-08-25",
  "bookedDayTo": "2024-08-25",
  "amountFrom": 0,
  "amountTo": 0,
  "itemRef": "itemRef",
  "text": "text",
  "onlyUnmatched": true,
  "includeHidden": true
}'

Example Request Body

{
  "bookedDayFrom": "2024-08-25",
  "bookedDayTo": "2024-08-25",
  "amountFrom": 0,
  "amountTo": 0,
  "itemRef": "itemRef",
  "text": "text",
  "onlyUnmatched": true,
  "includeHidden": true
}

json

Example Responses

[
  {
    "transactionKey": "transactionKey",
    "createdUtc": "2024-08-25T15:00:00Z",
    "itemRef": "itemRef",
    "customerGuid": "00000000-0000-0000-0000-000000000000",
    "matchedMethod": "matchedMethod",
    "matchedDetails": "matchedDetails",
    "bookedDay": "2024-08-25",
    "transactionCode": "transactionCode",
    "issuer": "issuer",
    "servicerRef": "servicerRef",
    "paymentInfoId": "paymentInfoId",
    "paymentInstrId": "paymentInstrId",
    "payeerName": "payeerName",
    "accountId": "accountId",
    "accountName": "accountName",
    "bic": "bic",
    "customerIdentificationNumber": "customerIdentificationNumber",
    "additionalInformation": "additionalInformation",
    "amount": 0,
    "amountCcy": "amountCcy",
    "payeerAddress": "payeerAddress",
    "payeerPostCode": "payeerPostCode",
    "payeerCity": "payeerCity",
    "payeerCountry": "payeerCountry",
    "filename": "filename",
    "sentToInterimLedgerUtc": "2024-08-25T15:00:00Z",
    "suggestedCustomers": [
      {
        "matchedMethod": "matchedMethod",
        "matchedDetails": "matchedDetails",
        "customerGuid": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "suggestedItemRefs": [
      {
        "matchedMethod": "matchedMethod",
        "matchedDetails": "matchedDetails",
        "itemRef": "itemRef",
        "customerGuid": "00000000-0000-0000-0000-000000000000",
        "accountGuid": "00000000-0000-0000-0000-000000000000",
        "invoiceNumber": "invoiceNumber"
      }
    ]
  }
]

json

application/json

Dimensions Debt Collection