Website logo

Retrieves a Job Pack invoice for a member

Retrieves a Job Pack invoice for a member

HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

invoiceId Integer (required)

Invoice Id to return

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.



A JobPackInvoiceDetail

InvoiceId Integer

Invoice Id

InvoiceDate DateTime

Date of the invoice

CompanyName String or null

The name of the company

PurchaseOrderNumber String or null

A Purchase Order (PO) Number

InvoiceDetails <InvoiceDetails> or null

Details of the purchase

AddOns Collection of <AddOn> or null

Add-ons purchased

Name String or null

The name of the add-on

Quantity Integer or null

The number of add-ons

Price Number or null

The price of an add-on

TotalPrice Number or null

The total price of all of the add-ons

PackSize Integer

The number of listings in the job pack being purchased

PackTotalPrice Number

The base price of the job pack before any discounts are applied

PackDiscount Number

The discount on the pack after the discount code is applied. Between 0.0 and 1.0.

PackTotalPriceAfterDiscount Number

The price of the job pack after pack discount is applied

SubTotal Number

The combined price of the add-ons and the job pack (after discount is applied)

ResellerDiscount Number

The reseller discount to apply to the sub total. Between 0.0 and 1.0.

TotalPriceAfterResellerDiscount Number

The total price after the reseller discount is applied to the sub total

TotalPriceExcludingGst Number

The final total price excluding GST

TotalPriceIncludingGst Number

The final total price including GST

ContactDetails <AccountPayableContact> or null

Details of the account payable contact for invoicing purposes

ContactName String or null

Required name of the contact

PrimaryEmail String or null

Required primary email address on the contact

SecondaryEmail String or null

Secondary email address of the contact

Address1 String or null

Line one of the postal address

Address2 String or null

Line two of the postal address

Suburb String or null

The suburb of the address

City String or null

The city of the address

Postcode String or null

The postcode of the address

Example XML Response (switch to JSON)

<JobPackInvoiceDetail xmlns="">

Example JSON Response (switch to XML)

  "InvoiceId": 123,
  "InvoiceDate": "\/Date(1514764800)\/",
  "CompanyName": "ABC",
  "PurchaseOrderNumber": "ABC",
  "InvoiceDetails": {
    "AddOns": [
        "Name": "ABC",
        "Quantity": 123,
        "Price": 123.0,
        "TotalPrice": 123.0
        "Name": "ABC",
        "Quantity": 123,
        "Price": 123.0,
        "TotalPrice": 123.0
    "PackSize": 123,
    "PackTotalPrice": 123.0,
    "PackDiscount": 123.0,
    "PackTotalPriceAfterDiscount": 123.0,
    "SubTotal": 123.0,
    "ResellerDiscount": 123.0,
    "TotalPriceAfterResellerDiscount": 123.0,
    "TotalPriceExcludingGst": 123.0,
    "TotalPriceIncludingGst": 123.0
  "ContactDetails": {
    "ContactName": "ABC",
    "PrimaryEmail": "ABC",
    "SecondaryEmail": "ABC",
    "Address1": "ABC",
    "Address2": "ABC",
    "Suburb": "ABC",
    "City": "ABC",
    "Postcode": "ABC"