Get Invoice
post
[PlatformAddress]/api/1.0/invoice?action=getInvoice
Get Invoice

Example Request

Get a specific invoice
1
{
2
"id":15
3
}
Copied!

Returns

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
The status of the invoice
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
The “to” Address of the invoice
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)
items
List of invoice items Item Details
payments
List of payments of the invoice Payment Details
refunds
List of refunds of the invoice Refund Details

Current status

#
Description
0
Not Paid
1
Un-confirmed Paid
2
Paid
3
Written Off
4
Cancelled
5
Refunded

Reference type

#
Description
0
Custom
1
Event Registration
2
Membership Sign Up
3
Membership Renewal
4
Venue Booking

Refund Details

Property
Description
id
The unique identifier of the invoice refund
invoiceId
The identifier of the invoice related to this invoice refund
refundId
The identifier of the refund
refundDate
The refund timestamp of the refund
amountRefunded
The refund amount
notes
The refund notes
refundMethodId
The refund method(if any selected)

Address Details

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

Item Details

Property
Description
id
The identifier of the item
description
The description of the item
quantity
Quantity of the item
unitCost
The unit cost of the item
totalCost
The total cost of the item
totalTaxCost
The tax of the item
amountPaid
The amount paid of the item'
refType
The reference type of the item
refId
The reference type of the item
ref2Id
The reference type of the item
costCenters
The total cost and total tax cost by cost center
taxes
The taxes applied to the item. Some information in the tax item might be empty if information is not available. ie. for old invoices. See Item Taxes Details for the data in each tax item

Item Taxes Details

Property
Description
taxId
The identifier of the tax
amount
The amount of tax
taxRateId
The identifier of the rate that overrided the default tax rate. Zero (0) when the default tax rate is not overridden
taxRateAmount
The rate at which the tax was calculated
taxRateAmountType
The tax rate amount type: 1 = A percentage, 2 = An amount
costcenterId
The identifier of the cost center to which the tax applies

Item Ref Type

Used to categorise the line based on the type of item sold. Note: This isn't linked to cost centres as a package can be a single line on an invoice, but revenue can be allocated to multiple cost centres.
RefType
Description
0
Unknown
100
Fee ( [102] => Card Fee, [103] => Payment Fee)
500
Deposit
501
Package (refId = Venue Package id, ref2Id = Booking Package Id)
502
Invoice
503
Payment
505
Session
506
Menu Package
507
Beverage Package
508
Resource
509
Product
510
Accommodation
511
Additional Line

Payment Details

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
customPaymentMethodId
The id of the custom 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
cardType
The type of card used for a credit card payment
Note about fee: If the payment is applied to multiple invoices, the fee amount is applied to the first invoice only.

Throws

Code
Description
Specific Code: 24137
Unable to find invoice
The invoice identifier must be provided as part of this call to fetch the specific invoice. E.g. {"id":1} can be used to fetch the details of an invoice with the identifier of 1.
Last modified 1mo ago