New Invoice APIs FAQs
Our invoice APIs are changing.
To ensure you keep receiving the most accurate, up-to-date and complete invoice data, including credit notes and tax information, you are required to migrate to the new invoice API endpoints.
For more information on the invoice APIs, visit https://dev.megaport.com.
Which invoice APIs are impacted?
These API endpoints have been deprecated and replaced with new API endpoints.
| Title | Old API | New API |
|---|---|---|
| GET Invoices | GET /v2/invoice Returns a list of invoices for the company associated with the user account. |
GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}? Returns a list of invoices for the company ID and billing market ID combination, for the specified date range. |
| GET Single Invoice | GET v2/invoice/{invoiceId} Returns the invoice for the specified invoiceId. |
GET /v2/company/${companyId}/invoice/${invoiceId} Returns the invoice for the specified companyId and invoiceId in JSON format. |
| GET Single Invoice PDF | GET /v2/invoice/{invoiceId}/pdf Returns a PDF version of the invoice for the specified invoiceId. |
GET /v2/company/${companyId}/invoice/${invoiceId}/pdf Returns a PDF version of the invoice for the specified companyId and invoiceId. |
| GET Single Invoice CSV | GET /v2/invoice/{invoiceId}/csv Returns a CSV version of the invoice for the specified invoiceId. |
GET /v2/company/${companyId}/invoice/${invoiceId}/csv Returns a CSV version of the invoice for the specified companyId and invoiceId. |
Where do I find the supplier and company information?
All of the new invoice APIs require you to send company and supplier information as part of the API call. You can find these values from the following Megaport APIs:
supplierIdis the “firstPartyId” returned in the GET Billing Markets/v2/marketAPI for the relevant supplier.companyUidis returned in the GET Product List/v2/productsAPI or the GET API Keys/v2/auth/apikeysAPI.companyIdis returned in the GET Company Details/v2/company/companyUidAPI.
When do I need to start using the new invoice APIs?
As soon as possible. The new invoice APIs are currently available in Production, any future enhancements related to invoices will be applied to the new APIs only.
When will the legacy invoice APIs be decommissioned?
The legacy invoice APIs have been deprecated and are no longer supported.
Who can I talk to for more information?
Please reach out to your Account Manager or Megaport Support. For more information, see Contacting Support.