Sign in

v1

latestSwagger 2.02026-07-13107162315.5 KB
BillPayment

Retrieves a single supplier bill payment by its Transaction ID, including allocations to bills.

get/api/BillPayment/{id}

Path parameters

idinteger required

The Bill Payment Transaction ID to retrieve.

Response

Returns the bill payment details with 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).

SupplierIDFKinteger

The supplier company ID this payment is made to.

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.

ViewBillPaymentURLstring

URL to view this bill payment in the Avaza web application.