BIbill
transactions

Get list of transactions

Changed on

Get a list of transaction objects. By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

In the response, you get information about transactions, reversals, and refunds.

  • Transaction: For a standard transaction, the transactionType is set as AUTHORIZATION or DECLINE. The status is updated to CLEAR once BILL moves the money from the funding account. The CLEAR transactions receive a new ID and reference to the original AUTHORIZATION transaction via the originalAuthTransactionUuid field.
  • Reversal: For a reversal (a cancellation before funds are settled), the transactionType remains AUTHORIZATION, but the amount is typically a negative value.
  • Refund: For a refund (a cancellation after funds are settled), the transactionType is set to CLEAR and the amount is a negative value.

Note: Only parent transactions are available in the response.

get/v3/spend/transactions

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/spend/transactions
  • Auth
    none declared

Query parameters

maxinteger nullable

Maximum number of results

Example:10
nextPagestring nullable

Next page of results.

When a list has multiple pages, the nextPage and prevPage values in the response enable you to navigate between the pages of results. Set this field as the nextPage value for navigation.

prevPagestring nullable

Previous page of results. Set this field as the prevPage value for navigation.

sortstring nullable

Field name and sort order. You can set only one sort field.

The format is sort={field}:{sort_order}.

The sortable fields are:

  • amount
  • merchantName
  • occurredTime
Example:occurredTime:desc
filtersstring nullable

Field name, operator, and value. You can set multiple filters.

The format is filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

Example: filters=cardId:eq:MyCardID,userId:in:"123,456"

The filterable fields are:

  • cardId - List of string IDs or UUIDs. Operators: eq, in.
  • merchantName - String. Operators: eq.
  • userId - List of string IDs or UUIDs. Operators: eq, in.
  • budgetId - List of string IDs or UUIDs. Operators: eq, in.
  • fees - Number with 2 decimal places. Operators: lte, gte.
  • transactionIds - List of string IDs or UUIDs. Operators: eq, in.
  • customFieldIds - List of string IDs or UUIDs. Operators: eq, in.
  • customFieldValueIds - List of string IDs or UUIDs. Operators: eq, in. Note: Use customFieldIds and customFieldValueIds to filter transactions based on custom fields. Use the showCustomFieldIds query parameter to control which custom fields are shown for each transaction.
  • receiptStatus - VALIDATED, NOT_VALIDATED, ATTACHED, MISSING, NOT_REQUIRED, NOT_ATTACHED. Operators: eq, ne, in, nin.
  • type - CLEAR, DECLINE, AUTHORIZATION, OTHER. Operators: eq, ne, in, nin. Deprecated: use transactionType.
  • transactionType - CLEAR, DECLINE, AUTHORIZATION, OTHER. Operators: eq, ne, in, nin.
  • occurredTime - DateTime. Operators: lte, gte.
  • authorizedTime - DateTime. Operators: lte, gte.
  • updatedTime - DateTime. Operators: lte, gte.
  • isLocked - true or false. Operators: eq.
  • complete - true or false. Operators: eq.
  • amount - Number with 2 decimal places. Operators: lte, gte.
  • isReviewed - true or false. Operators: eq.
  • syncStatus - PENDING, SYNCED, ERROR, MANUAL_SYNCED, NOT_SYNCED. Operators: eq, ne, in, nin.
Example:amount:gte:100.00
showCustomFieldIdsstring nullable

List of BILL-generated IDs of custom fields to be displayed for each transaction. Set the IDs as comma-separated values. By default, all the custom fields are displayed for all transactions.

NOTE: Use customFieldIds and customFieldValueIds to filter transactions based on custom fields.

includeReceiptsboolean nullable

Set as true to include transaction receipts in the response. By default, receipts are not included in the response.

Example:true

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Response

Get list of transactions response

nextPagestring

Next page token

prevPagestring

Previous page token

Changes

  • 54edddceb0a5Revision changes
    • warning

      added the new OTHER enum value to the ////////// response property for the response status

    • info

      for the query request parameter max, the max was increased from 50.00 to 100.00

    • info

      removed the UNSPECIFIED enum value from the ////////// response property for the response status