v1
latestSwagger 2.02026-07-13107162315.5 KBRecords a new customer payment. Optionally include allocations to apply the payment against specific invoices.
Request body
Total amount of the payment.
Optional. If not specified will be automatically generated
Date of Payment. If not specified, assumes today.
Optional to override the default prefix added to Payment Numbers
Only required if no invoice allocations specified.
Optional. Only used when the Customer's currecy is different from the Avaza account's base currency. Specifies the exchange rate that should apply between the customer currency and base currency. If not provided we will obtain an up to date exchange rate for the Payment Issue Date.
Optional for storing the reference # of the payment method.
Optional for storing the payment provider who was the source of funds.
If true, fires the invoice_updated webhook event for each invoice that was allocated against. Defaults to false to preserve existing integration behaviour.
Response
Returns the created payment with allocations.
Unique identifier for the payment transaction.
The Avaza account this payment belongs to.
The prefix used in the payment number.
The full payment number including prefix.
External reference number (e.g. cheque number or bank reference).
The customer company ID this payment is from.
The date the payment was made.
Current status of the payment.
Code identifying the payment provider/method used.
Exchange rate to the account's base currency.
Unallocated balance remaining on the payment.
ISO 3-character currency code for the payment.
Total payment amount.
Additional notes on the payment.
Date and time the record was created.
Date and time the record was last updated.
URL to view this payment in the Avaza web application.