Sign in

v1

latestSwagger 2.02026-07-13107162315.5 KB
Payment

Retrieves a single customer payment by its Transaction ID, including allocations to invoices.

get/api/Payment/{id}

Path parameters

idinteger required

Invoice Transaction ID Number

Response

Returns the payment details with invoice allocations.

TransactionIDinteger

Unique identifier for the payment transaction.

AccountIDFKinteger

The Avaza account this payment belongs to.

TransactionPrefixstring

The prefix used in the payment number.

PaymentNumberstring

The full payment number including prefix.

TransactionReferencestring

External reference number (e.g. cheque number or bank reference).

CustomerIDFKinteger

The customer company ID this payment is from.

DateIssuedstring date-time

The date the payment was made.

TransactionStatusCodestring

Current status of the payment.

PaymentProviderCodestring

Code identifying the payment provider/method used.

ExchangeRatenumber double

Exchange rate to the account's base currency.

Balancenumber double

Unallocated balance remaining on the payment.

CurrencyCodestring

ISO 3-character currency code for the payment.

TotalAmountnumber double

Total payment amount.

Notesstring

Additional notes on the payment.

DateCreatedstring date-time

Date and time the record was created.

DateUpdatedstring date-time

Date and time the record was last updated.

ViewPaymentURLstring

URL to view this payment in the Avaza web application.