Export API Version 2 Invoices
Introduction
Give access to invoice information.
List Invoices
Lists invoice information for a specific IGRP.
Request:
GET /v2/igrps/{IGRP SPECIFIER}/invoicesGET Params
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- sort (array) OPTIONAL - One or more sorting params, see Sort Types.
- limit (integer) OPTIONAL - limit on the result set.
- offset (integer) OPTIONAL - offset of the result set.
Filter Types
The Invoices list may be filtered by any of the returned fields.
Sort Types
The Invoices list may be sorted by any of the returned fields.
Response:
Returns a 200 OK response on success, with the following properties:
- invoiceId (int) - Invoice ID
- invoiceType (string) - The type of invoice (invoice or credit note)
- invoiceDate (string) - The date the invoice is for (end of the month)
- accountId (int) - The accountId responsible for paying the bill
- accountName (string) - The account name of the bill payer
- igrp (int) - The IGRP identifier
- igrpName (string) - IGRP Name
- poNumber (int) - The P.O number for this invoice (if applicable)
- currencyCode (string) - The three-letter ISO-4217 currency code that the invoice will be billed in
- billingMethodCode (string) - Dictates how this invoice should be paid
- invoiceTotal (float) - Invoice Total amount to be payed
Example:
{"invoiceId":"20308","invoiceType":"installation","invoiceDate":"2015-11-30","accountId":"1","accountName":"Infinity-Tracking","igrp":"1100","igrpName":"Infinity Cloud","poNumber":"","currencyCode":"GBP","billingMethodCode":"in","invoiceTotal":"500.000000"}
Download Invoice
Downloads a PDF with all invoice information for a specific invoice ID
Request:
GET /v2/igrps/{IGRP SPECIFIER}/invoices/{INVOICE SPECIFIER}/downloadResponse:
Returns a 200 OK response on success with a PDF.