v1

Swagger 2.02026-07-13107162315.5 KB
BillPayment

Records a new supplier bill payment. Optionally include allocations to apply the payment against specific bills.

post/api/BillPayment

Request body

Amountnumber double

The total amount of the payment.

PaymentNumberstring

Optional. If not specified will be automatically generated

DateIssuedstring date-time

Date of Payment. If not specified, assumes today.

TransactionPrefixstring

Optional to override the default prefix added to Payment Numbers

CompanyIDFKinteger

Only required if no invoice allocations specified.

ExchangeRatenumber double

Optional. Only used when the Company's currency is different from the Avaza account's base currency. Specifies the exchange rate that should apply between the Company currency and base currency. If not provided we will obtain an up to date exchange rate for the Payment Issue Date.

TransactionReferencestring

Optional for storing the reference # of the payment method.

Notesstring

Additional notes on the payment.

PaymentProviderCodestring

Optional for storing the payment provider who was the source of funds.

CurrencyCodestring

Optional for specifying the Bill Payment's Currency (3 letter ISO Currency Code).

SendWebhooksboolean

If true, fires the bill_updated webhook event to any subscribed endpoints for each bill that was allocated against. Defaults to false to preserve existing integration behaviour.

Response

Returns the created bill payment 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.