Skip to content
FRAGMENT
API Reference
Transactions

List

client.transactions.list(TransactionListParams { account, reconciliation_status } query?, RequestOptionsoptions?): TransactionListResponse { data }
GET/transactions

Lists all transactions.

ParametersExpand Collapse
query: TransactionListParams { account, reconciliation_status }
account?: string

Filter by account id or external_id. If the account does not exist, returns an empty list.

reconciliation_status?: "reconciled" | "unreconciled"

Filter by reconciliation status. reconciled returns transactions where unallocated_amount is 0. unreconciled returns transactions where unallocated_amount is not 0. Omit for all transactions.

Accepts one of the following:
"reconciled"
"unreconciled"
ReturnsExpand Collapse
TransactionListResponse { data }
data: Array<Transaction { id, account, allocations, 9 more } >

List of transaction objects matching the filter criteria.

id: string

FRAGMENT generated unique ID.

account: Account { id, external_id }

External account for the transaction.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

allocations: Array<Allocation>

Allocations applied to the transaction.

amount: string

Allocated amount, as a non-negative string in the smallest currency unit, such as cents for USD.

invoice_id: string

Invoice the allocation is applied against.

type: "invoice_payin" | "invoice_payout"

Type of allocation.

Accepts one of the following:
"invoice_payin"
"invoice_payout"
user: User { id, external_id }

User associated with the allocation.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

amount: string

Transaction amount, as a string in the smallest currency unit, such as cents for USD.

created: string

Timestamp when the transaction was created. Uses ISO 8601 format.

formatdate-time
currency: "ADA" | "BTC" | "DAI" | 176 more

ISO 4217 or crypto currency code.

Accepts one of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
external_id: string

User-provided unique ID.

posted: string

Timestamp when the transaction was posted. Uses ISO 8601 format.

formatdate-time
tags: Array<Tag>

Tags for the transaction.

key: string

Tag key.

value: string

Tag value.

unallocated_amount: string

Amount not yet allocated, as a string.

version: number

Current version of the transaction.

modified?: string

Timestamp when the transaction was last modified. Uses ISO 8601 format.

formatdate-time

List

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const transactions = await client.transactions.list();

console.log(transactions.data);
{
  "data": [
    {
      "id": "txn_dHhuX2ZyYWdfMDAx",
      "account": {
        "id": "ext_account_YWJjMTIz",
        "external_id": "acct_external_123"
      },
      "allocations": [
        {
          "amount": "1000",
          "invoice_id": "inv_abc123",
          "type": "invoice_payin",
          "user": {
            "id": "user_abc123",
            "external_id": "user_ext_001"
          }
        }
      ],
      "amount": "-1000",
      "created": "2024-01-13T00:00:00Z",
      "currency": "USD",
      "external_id": "bank_txn_123",
      "posted": "2024-01-13T00:00:00Z",
      "tags": [
        {
          "key": "department",
          "value": "engineering"
        }
      ],
      "unallocated_amount": "-1000",
      "version": 1,
      "modified": "2024-01-13T00:00:00Z"
    }
  ]
}
Returns Examples
{
  "data": [
    {
      "id": "txn_dHhuX2ZyYWdfMDAx",
      "account": {
        "id": "ext_account_YWJjMTIz",
        "external_id": "acct_external_123"
      },
      "allocations": [
        {
          "amount": "1000",
          "invoice_id": "inv_abc123",
          "type": "invoice_payin",
          "user": {
            "id": "user_abc123",
            "external_id": "user_ext_001"
          }
        }
      ],
      "amount": "-1000",
      "created": "2024-01-13T00:00:00Z",
      "currency": "USD",
      "external_id": "bank_txn_123",
      "posted": "2024-01-13T00:00:00Z",
      "tags": [
        {
          "key": "department",
          "value": "engineering"
        }
      ],
      "unallocated_amount": "-1000",
      "version": 1,
      "modified": "2024-01-13T00:00:00Z"
    }
  ]
}