Retrieves Job Pack invoices for a member

Retrieves a collection of Job Pack invoices associated with an authenticated member

URL:	https://api.trademe.co.nz/v1/Jobs/Payments/Invoices/JobPacks.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	MyTradeMeRead: Read your membership & listing data.
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Query String parameters

filter	String (optional)	Optional time based filter. Valid values are All, LastYear, LastSixMonths, LastThreeMonths, LastMonth. Default to LastYear
page	Integer (optional)	The page number of the set of results to return, starting from 1. Defaults to 1.
rows	Integer (optional)	The number of results per page. The maximum is 50. Defaults to 10.

Returns

A JobPackInvoiceSummaryCollection containing summary of Job Pack invoices

TotalCount

Integer

The total number of results in the collection. Can be larger than the number of returned results.

Page

Integer

The index of the current page of results (starts at 1).

PageSize

Integer

The number of results in the current page.

List

Collection of <JobPackInvoiceSummaryItem> or null

A list of the results in the current page.

InvoiceId	Integer	Invoice Id
JobPackTotal	Integer	Total number of Job Packs purchased
FeatureTotal	Integer	Total number of features purchased
BrandingTotal	Integer	Total number of brandings purchased
InvoiceDate	DateTime	Date of the invoice
TotalExcludingGst	Number	Total amount of the invoice excluding Gst
TotalIncludingGst	Number	Total amount of the invoice including Gst
PurchaseOrderNumber	String or null	Purchase Order number

Example XML Response (switch to JSON)

<JobPackInvoiceSummaryCollection xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <JobPackInvoiceSummaryItem>
      <InvoiceId>123</InvoiceId>
      <JobPackTotal>123</JobPackTotal>
      <FeatureTotal>123</FeatureTotal>
      <BrandingTotal>123</BrandingTotal>
      <InvoiceDate>2018-01-01T00:00:00Z</InvoiceDate>
      <TotalExcludingGst>123.0</TotalExcludingGst>
      <TotalIncludingGst>123.0</TotalIncludingGst>
      <PurchaseOrderNumber>ABC</PurchaseOrderNumber>
    </JobPackInvoiceSummaryItem>
    <JobPackInvoiceSummaryItem>
      <InvoiceId>123</InvoiceId>
      <JobPackTotal>123</JobPackTotal>
      <FeatureTotal>123</FeatureTotal>
      <BrandingTotal>123</BrandingTotal>
      <InvoiceDate>2018-01-01T00:00:00Z</InvoiceDate>
      <TotalExcludingGst>123.0</TotalExcludingGst>
      <TotalIncludingGst>123.0</TotalIncludingGst>
      <PurchaseOrderNumber>ABC</PurchaseOrderNumber>
    </JobPackInvoiceSummaryItem>
  </List>
</JobPackInvoiceSummaryCollection>

Example JSON Response (switch to XML)

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "InvoiceId": 123,
      "JobPackTotal": 123,
      "FeatureTotal": 123,
      "BrandingTotal": 123,
      "InvoiceDate": "\/Date(1514764800)\/",
      "TotalExcludingGst": 123.0,
      "TotalIncludingGst": 123.0,
      "PurchaseOrderNumber": "ABC"
    },
    {
      "InvoiceId": 123,
      "JobPackTotal": 123,
      "FeatureTotal": 123,
      "BrandingTotal": 123,
      "InvoiceDate": "\/Date(1514764800)\/",
      "TotalExcludingGst": 123.0,
      "TotalIncludingGst": 123.0,
      "PurchaseOrderNumber": "ABC"
    }
  ]
}