API Reference

Transactions

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Search

POST/transactions/search

Searches transactions.

Body ParametersJSONExpand Collapse

filter: object { account, tags }

Filter for searching transactions.

account: optional object { any }

Account filter.

any: array of object { id, external_id }

Match transactions belonging to any of these accounts, using OR logic.

id: optional string

FRAGMENT generated unique ID.

minLength1

external_id: optional string

User-provided unique ID.

minLength1

tags: optional object { all, any }

Tag-based filter criteria. When both any and all are provided, results must match every entry in all AND at least one entry in any.

all: optional array of object { key, value }

Returns transactions matching every specified tag, using AND logic.

key: string

Tag key to filter on. Must be an exact match; wildcards are not supported.

value: string

Tag value pattern to filter on. Supports wildcards: * matches any characters, ? matches a single character. Use \* or \? to match literal asterisks or question marks. Use * to match any value for the given key.

any: optional array of object { key, value }

Returns transactions matching at least one of the specified tags, using OR logic.

key: string

Tag key to filter on. Must be an exact match; wildcards are not supported.

value: string

Tag value pattern to filter on. Supports wildcards: * matches any characters, ? matches a single character. Use \* or \? to match literal asterisks or question marks. Use * to match any value for the given key.

page_info: optional object { after, limit }

Pagination parameters.

after: optional string

Cursor for fetching the next page of results.

limit: optional number

Number of results to return. Defaults to 20.

minimum1

maximum200

ReturnsExpand Collapse

Deprecateddata: array of Transaction { id, account, allocations, 9 more }

Deprecated. Use data_v2.transactions instead. Returns the full unpaginated list of matching transactions.

id: string

FRAGMENT generated unique ID.

account: object { id, external_id }

External account for the transaction.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

allocations: array of object { amount, invoice_id, type, user }

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" or "invoice_payout"

Type of allocation.

Accepts one of the following:

"invoice_payin"

"invoice_payout"

user: object { 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" or "BTC" or "DAI" or 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 of object { key, value }

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: optional string

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

formatdate-time

data_v2: object { page_info, transactions }

page_info: object { next_cursor }

Pagination cursors.

next_cursor: optional string

Cursor to fetch the next page of results.

transactions: array of Transaction { id, account, allocations, 9 more }

Transactions matching the search criteria.

id: string

FRAGMENT generated unique ID.

account: object { id, external_id }

External account for the transaction.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

allocations: array of object { amount, invoice_id, type, user }

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" or "invoice_payout"

Type of allocation.

Accepts one of the following:

"invoice_payin"

"invoice_payout"

user: object { 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" or "BTC" or "DAI" or 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 of object { key, value }

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: optional string

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

formatdate-time

Search

HTTP

HTTP

TypeScript

Python

curl https://api.us-west-2.fragment.dev/billing/transactions/search \
    -H 'Content-Type: application/json' \
    -d '{
          "filter": {}
        }'

200 example

{
  "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"
    }
  ],
  "data_v2": {
    "page_info": {
      "next_cursor": "next_cursor"
    },
    "transactions": [
      {
        "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

200 example

{
  "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"
    }
  ],
  "data_v2": {
    "page_info": {
      "next_cursor": "next_cursor"
    },
    "transactions": [
      {
        "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"
      }
    ]
  }
}