Transactions

List transactions

This endpoint allows you to retrieve a list of transactions for a given business. You can filter the transactions by date range, status, and expense completion status.

get/v2/businesses/{client_id}/transactions

Path parameters

client_idinteger required

Example:123

The ID of the business.

Query parameters

offsetinteger

Example:50

Offset to retrieve items from.

limitinteger

Example:50

Number of items per page.

min_auth_datestring date

The minimum authorised date for the transactions in UTC.

max_auth_datestring date

The maximum authorised date for the transactions in UTC.

min_cleared_datestring date

The minimum cleared date for the transactions in UTC.

max_cleared_datestring date

The maximum cleared date for the transactions in UTC.

expense_status'COMPLETE' | 'INCOMPLETE_EXPENSE'

Example:COMPLETE

The expense completion status of the transactions.

status'AUTHED' | 'CLEARED' | 'REFUNDED' | 'DECLINED'

The status of the transaction.

Example:CLEARED

The status of the transactions. Repeat the parameter to match more than one status, for example ?status=AUTHED&status=CLEARED.

Response

countinteger

The total number of transactions that match the query.

nextstring

The URL to the next page of transactions.

previousstring

The URL to the previous page of transactions.

Example response

{
  "count": 100,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "results": [
    {
      "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
      "cleared_date": "2024-01-01T00:00:00Z",
      "auth_date": "2024-01-01T00:00:00Z",
      "merchant_name": "Bunnings Warehouse",
      "attendees": [
        "Jane Doe"
      ],
      "budget": {
        "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
        "name": "Sales Team",
        "budget_type": "BUDGET"
      },
      "currency": "AUD",
      "custom_fields": [
        {
          "field_name": "Project",
          "entry_text": "Project 1"
        }
      ],
      "fx_amount": 100,
      "amount": -100,
      "gst": 9.09,
      "expense_status": "COMPLETE",
      "status": "CLEARED",
      "transaction_type": "CARD_TRANSACTION",
      "user": {
        "id": 123,
        "first_name": "John",
        "last_name": "Doe",
        "name": "John Doe"
      },
      "line_items": [
        {
          "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
          "amount": 100,
          "gst_amount": 9.09,
          "tax_rate": {
            "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
            "name": "GST",
            "rate": 0.1,
            "code": "GST",
            "is_default_for": "DOMESTIC",
            "is_enabled": true,
            "source": "WEEL"
          },
          "category": {
            "id": "f2c9897d-62fb-4d64-9647-3e6bf62d07c2",
            "name": "Accommodation",
            "code": "6668"
          },
          "custom_fields": [
            {
              "field_name": "Project",
              "entry_text": "Project 1"
            }
          ],
          "description": "Building supplies"
        }
      ],
      "receipt_urls": [
        "https://divipay-user-production.s3.amazonaws.com/123/68eae8f6-cb90-4403-ba76-a2cc12c3979j.png"
      ],
      "created": "2024-01-01T00:00:00Z",
      "updated": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

Changed in 1 of the 3 revisions of this API.21

Aug 11, 20265a8ffd533c9c21See the full diff
- ●
  added the new DECLINED enum value to the results/items/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new REFUNDED enum value to the results/items/status response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional query request parameter status
  new-optional-request-parameter

Full history