LEletsweel
Transactions

Get transaction

Changed on

This endpoint allows you to retrieve a single transaction. The transaction-level gst has the same sign as amount: negative for purchases, positive for refunds.

get/v3/businesses/{client_id}/transactions/{transaction_id}

Request

Path parameters

client_idinteger required
Example:123

The ID of the business.

transaction_idstring required

The ID of the transaction.

Response

OK

idstring

The ID of the transaction.

cleared_datestring date-time nullable

The date the transaction was cleared in UTC.

auth_datestring date-time

The date the transaction was authorised in UTC.

merchant_namestring

The name of the merchant.

attendeesstring[]

The names of the attendees of the transaction.

currencystring

The currency of the transaction.

fx_amountnumber

The foreign currency amount of the transaction.

amountnumber

The amount of the transaction in AUD (positive for credits, negative for debits).

gstnumber nullable

The GST amount of the transaction, with the same sign as amount: negative for purchases and other money leaving the business, positive for refunds and other money coming back. A value of 0 or null is returned as is. Line item gst_amount values are not signed.

expense_status'COMPLETE' | 'INCOMPLETE_EXPENSE'

The expense completion status of the transaction.

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

The status of the transaction.

transaction_type'CARD_TRANSACTION' | 'CHARGE' | 'DEPOSIT_DIRECT_CREDIT' | 'DEPOSIT_DIRECT_DEBIT' | 'BILL' | 'REIMBURSEMENT' | 'EXTERNAL_TRANSFER' | 'MANUAL_TRANSFER' | 'CREDIT'

The type of transaction.

receipt_urlsstring[]

The URLs of the receipts for the transaction. These are temporary, pre-signed links that expire 8 hours after the response is generated. Download the files before then, or request the transaction again to obtain fresh URLs. Do not store these URLs, as they will stop working once they expire.

createdstring date-time

The date and time when the transaction was created in UTC.

updatedstring date-time

The date and time when the transaction was last updated in UTC.

Example response

{
  "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": -0.91,
  "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