GetTransaction

Returns one receipt or payment: its header, the invoices or bills it is allocated to, and its data fields. A receipt records money received from an entity against its invoices; a payment records money paid to an entity against its bills. Use it after GetPaymentsByStatusDate to read each payment, for example to mark the bills paid in your accounting system. The fields are the ones of the Receipt or payment page.

How to sign in and read the response: Authentication, Responses.

GET /api/v1/GetTransaction?ID=60218
Token: your-token

Parameter	Required	Meaning
ID	Yes	The ID of the receipt or payment, a whole number, as ID in GetPaymentsByStatusDate. It can be a receipt or payment of any company.

Rules

Rule	Info when it fails
The Token header holds a valid token.	Token missing in header, Token invalid or expired, or another answer listed in Login token
The user is a system administrator with API access.	API User must be SysAdmin with API Access
A receipt or payment has that ID.	No such Payment

Response

On success, Code is 1 and RetInfo holds three parts: Header, List and Data. RowsAffected and Identity are 0.

{
  "Code": 1,
  "Info": "",
  "RetInfo": {
    "Header": {
      "ID": 60218,
      "Type": 1,
      "Date": "2026-10-06",
      "CurrCode": "USD",
      "Amount": 1150.00,
      "Remarks": null,
      "Reference": "TRF-88412",
      "Sequence": "HQ20260012",
      "Created": "2026-10-06T08:02:37.4",
      "CreatedBy": "jsmith",
      "Method": "Bank Transfer",
      "Approved": "2026-10-06T10:45:12.13",
      "ApprovedBy": "jsmith",
      "EntID": 2214,
      "EntName": "Example Shipping Co",
      "Finalised": null,
      "FinalisedBy": null
    },
    "List": [
      {
        "ID": 109827,
        "Number": "INV-2026-0042",
        "Date": "2026-10-01T00:00:00",
        "Jobs": "JOB-2610-0021; JOB-2610-0034",
        "EntName": "Example Shipping Co",
        "CurrCode": "USD",
        "Total": 1150.00,
        "TaxDeduct": 0.00,
        "Allocated": 1150.00,
        "Outstanding": 0.00
      }
    ],
    "Data": [
      {
        "Field": "Bank Reference",
        "Code": "BANKREF",
        "CompID": null,
        "Value": "TRF-88412",
        "ValueID": null,
        "Remarks": null,
        "Updated": "2026-10-06T08:03:10.22",
        "UserID": "jsmith"
      }
    ]
  },
  "RowsAffected": 0,
  "Scalar": null,
  "Identity": 0
}

Header

Field	Meaning
ID	The ID of the receipt or payment.
Type	0 for a receipt, 1 for a payment.
Date	The Transaction Date, as yyyy-MM-dd.
CurrCode	The currency.
Amount	The total amount received or paid.
Remarks	The remarks, or null.
Reference	The Reference, or null.
Sequence	The Sequence Number, given on approval: the company’s code, the year and a running number. null until it is approved.
Created, CreatedBy	When it was created, in UTC, and the user ID of who created it.
Method	The Transaction Mode: how the money was received or paid.
Approved, ApprovedBy	When it was approved, in UTC, and by whom. null until it is approved.
EntID, EntName	The ID and name of the entity that paid or was paid. See GetEntity.
Finalised, FinalisedBy	When it was finalized, in UTC, and by whom. null until it is finalized.

The status follows from the dates: a draft has no Approved date, an approved one has no Finalised date. See How a receipt moves on.

List

List holds the invoices a receipt is allocated to, or the bills a payment is allocated to, as on its Invoices/Bills tab, oldest first:

Field	Meaning
ID	The ID of the invoice or bill. See GetInvoice and GetBill.
Number	The invoice number or the supplier’s bill number.
Date	The invoice or bill date, as a date and time at midnight.
Jobs	The job number: for an invoice, the number of its job, or null for an invoice that is not for one job; for a bill, the numbers of the jobs of its accounts, separated by ; .
EntName	The name of the entity of the invoice or bill.
CurrCode	The currency of the invoice or bill.
Total	The invoice total, or the bill’s billed amount, less its adjustments.
TaxDeduct	The tax deduction on the invoice or bill.
Allocated	The part of this receipt or payment allocated to it.
Outstanding	What is still due on it: Total less TaxDeduct and the approved receipts or payments. A draft’s own Allocated amount counts only once it is approved.

Data

Data lists the data fields set up for receipts or for payments (see the Receipts and Payments tabs of Data fields), each with this record’s value:

Field	Meaning
Field	The field’s name.
Code	The field’s code.
CompID	The IDs of the companies the field is for, separated by commas, such as "3,7". Empty or null when it is for all companies.
Value	The value, or null when the field has none on this record.
ValueID	For a field that holds an entity or a location, the ID of the one chosen. Otherwise null.
Remarks	The remarks entered with the value, or null.
Updated, UserID	When the value was last changed, in UTC, and by whom.

To set these values, use SaveDataField.