Get Credit Note List
Get Invoice List
POST
[PlatformAddress]/api/1.0/invoice?action=getCreditNoteList
Get a list of Credit Notes
Path Parameters
perPage*
integer
The number of credit notes to get in a single api call
start*
integer
The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.)
Example Request
Get credit note list
Reference type
0
Custom
1
Event Registration
2
Membership Sign Up
3
Membership Renewal
4
Venue Booking
Returns
A collection object with the following properties in the results
id
The unique credit note identifier
reference
The unique reference number of the credit note
title
The title of the credit note
notes
The description of the credit note
currency
The currency of the credit note
totalAmount
The total of the credit note
totalTaxAmount
The tax of the credit note
amountAllocated
Sum of the allocated amounts to invoices from the credit note
amountRefunded
Sum of the refunded amounts from the credit note
createdDate
The created date of the credit note
modifiedDate
The modified date of the credit note
refType
The reference type of the credit note
refId
The reference Id of the credit note
eventId
Event Identifier to which the credit note belongs
venueId
Venue Identifier to which the credit note belongs
companyId
Company Identifier to which the credit note belongs
invoiceId
Invoice Identifier from which the credit note is created
The result from this call will be a collection of all the credit notes the user has access to. This call also accepts the pagination and filter properties.
Last updated