Website logo

Retrieves a Job Pack invoice for a member

Retrieves a Job Pack invoice for a member

URL: https://api.trademe.co.nz/v1/Jobs/Payments/Invoices/JobPacks/{invoiceId}.{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

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.

Returns

<JobPackInvoiceDetail>

A JobPackInvoiceDetail

InvoiceId Integer InvoiceId
InvoiceDate DateTime InvoiceDate
CompanyName String or null CompanyName
PurchaseOrderNumber String or null PurchaseOrderNumber
InvoiceDetails <InvoiceDetails> or null InvoiceDetails
AddOns Collection of <AddOn> or null AddOns
Name String or null Name
Quantity Integer or null Quantity
Price Number or null Price
TotalPrice Number or null TotalPrice
PackSize Integer PackSize
PackTotalPrice Number PackTotalPrice
PackDiscount Number PackDiscount
PackTotalPriceAfterDiscount Number PackTotalPriceAfterDiscount
SubTotal Number SubTotal
ResellerDiscount Number ResellerDiscount
TotalPriceAfterResellerDiscount Number TotalPriceAfterResellerDiscount
TotalPriceExcludingGst Number TotalPriceExcludingGst
TotalPriceIncludingGst Number TotalPriceIncludingGst
ContactDetails <AccountPayableContact> or null ContactDetails
ContactName String or null ContactName
PrimaryEmail String or null PrimaryEmail
SecondaryEmail String or null SecondaryEmail
Address1 String or null Address1
Address2 String or null Address2
Suburb String or null Suburb
City String or null City
Postcode String or null Postcode

Example XML Response (switch to JSON)

<JobPackInvoiceDetail xmlns="http://api.trademe.co.nz/v1">
  <InvoiceId>123</InvoiceId>
  <InvoiceDate>2018-01-01T00:00:00Z</InvoiceDate>
  <CompanyName>ABC</CompanyName>
  <PurchaseOrderNumber>ABC</PurchaseOrderNumber>
  <InvoiceDetails>
    <AddOns>
      <AddOn>
        <Name>ABC</Name>
        <Quantity>123</Quantity>
        <Price>123.0</Price>
        <TotalPrice>123.0</TotalPrice>
      </AddOn>
      <AddOn>
        <Name>ABC</Name>
        <Quantity>123</Quantity>
        <Price>123.0</Price>
        <TotalPrice>123.0</TotalPrice>
      </AddOn>
    </AddOns>
    <PackSize>123</PackSize>
    <PackTotalPrice>123.0</PackTotalPrice>
    <PackDiscount>123.0</PackDiscount>
    <PackTotalPriceAfterDiscount>123.0</PackTotalPriceAfterDiscount>
    <SubTotal>123.0</SubTotal>
    <ResellerDiscount>123.0</ResellerDiscount>
    <TotalPriceAfterResellerDiscount>123.0</TotalPriceAfterResellerDiscount>
    <TotalPriceExcludingGst>123.0</TotalPriceExcludingGst>
    <TotalPriceIncludingGst>123.0</TotalPriceIncludingGst>
  </InvoiceDetails>
  <ContactDetails>
    <ContactName>ABC</ContactName>
    <PrimaryEmail>ABC</PrimaryEmail>
    <SecondaryEmail>ABC</SecondaryEmail>
    <Address1>ABC</Address1>
    <Address2>ABC</Address2>
    <Suburb>ABC</Suburb>
    <City>ABC</City>
    <Postcode>ABC</Postcode>
  </ContactDetails>
</JobPackInvoiceDetail>

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"
  }
}