Comment on page
Get Invoice List
post
[PlatformAddress]/api/1.0/invoice?action=getInvoiceList
Get Invoice List
Property | Description | Type |
|---|---|---|
fromModifiedDate | Filter by Modified Date | |
includePaymentDetails | Filter by Payment Details | boolean |
toModifiedDate | Filter by Modified Date | |
venueId | Filter invoices that belong to a specific Venue | integer |
refType | integer |
# | Description |
|---|---|
0 | Custom |
1 | Event Registration |
2 | Membership Sign Up |
3 | Membership Renewal |
4 | Venue Booking |
A collection object with the following properties in the results
Property | Description |
|---|---|
id | The unique invoice identifier |
reference | The unique reference number of the invoice |
title | The title of the invoice |
description | The description of the invoice |
currency | The currency of the invoice |
totalCost | The total of the invoice |
totalTaxCost | The tax of the invoice |
amountPaid | The amount paid against the invoice |
toContactEmail | The contact email of the invoice |
toContactName | The contact name of the invoice |
contact | The contact details of the invoice |
company | The company details of the invoice |
currentStatus | |
createdDate | The created date of the invoice |
modifiedDate | The modified date of the invoice |
refType | The reference type of the invoice |
refId | The reference Id of the invoice |
taxRateUsed | The tax rate percent applied to invoice |
isTaxCharged | Whether tax charged on the invoice |
paymentDueDate | Payment due date of the invoice |
eventId | Event Identifier to which the invoice belongs |
venueId | Venue Identifier to which the invoice belongs |
toContactId | Contact Id against which invoice is created |
toAddress | |
bookingCode | The unique reference code of the booking if refType is 4 (Venue Booking) |
bookingId | The unique identifier of the booking if refType is 4 (Venue Booking) |
payments | List of payments of the invoice Payment Details |
# | Description |
|---|---|
0 | Not Paid |
1 | Un-confirmed Paid |
2 | Paid |
3 | Written Off |
4 | Cancelled |
5 | Refunded |
Property | Description |
|---|---|
line1 | Line 1 of the address (part of the "street") |
line2 | Line 2 of the address (part of the "street") |
line3 | Line 3 of the address (part of the "street") |
line4 | Line 4 of the address (part of the "street") |
city | The city name of the address |
stateCode | The state code of the address (e.g. QLD) |
stateName | The state name of the address (e.g. Queensland) |
countryCode | The country code of the address (e.g. AU) |
countryName | The country name of the address (e.g. Australia) |
postalCode | The postal code of the address |
Property | Description |
|---|---|
id | The unique identifier of the payment |
paymentId | The identifier of the credit card payment transaction (if payment was by credit card) |
receiptNum | The receipt number of the payment |
amountPaid | The amount paid of the payment |
notes | The notes of the payment |
chequeNumber | The chequeNumber of the payment |
paymentMethod | The payment method of the payment |
paidDate | The paid timestamp of the payment |
feePercentage | The percentage fee included in amountPaid |
feeAmount | The fee amount included in amountPaid |
invoiceId | The unique invoice identifier |
The result from this call will be a collection of all the invoices the user has access to. This call also accepts the pagination and filter properties.
Last modified 1mo ago