Invoices (v3) | Megaport

{
  "data": {
    "$id": 1,
    "batchId": 1,
    "invoices": [
      {
        "$id": 2,
        "currencyCode": "AUD",
        "dueDate": "2023-12-01T12:00:00",
        "invoiceAmount": 2420,
        "invoiceDate": "2023-11-01T12:00:00",
        "invoiceId": "AUS00012345",
        "openBalance": 0
      },
      {
        "$id": 3,
        "currencyCode": "AUD",
        "dueDate": "2023-12-31T12:00:00",
        "invoiceAmount": 2420,
        "invoiceDate": "2023-12-01T12:00:00",
        "invoiceId": "AUS00012346",
        "openBalance": 0
      },
      {
        "$id": 4,
        "currencyCode": "AUD",
        "dueDate": "2024-02-01T12:00:00",
        "invoiceAmount": 2420,
        "invoiceDate": "2024-01-02T12:00:00",
        "invoiceId": "AUS00012347",
        "openBalance": 0
      }
    ]
  },
  "message": "Invoice list for customer [1]",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Returns a list of all the invoices for the company and billing market combination, for the specified date range.

You can find the companyUid and supplierId from the following Megaport endpoints:

companyUid is returned in the GET Product List /v2/products endpoint or the GET API Keys /v2/auth/apikeys endpoint.
supplierId is the “firstPartyId” returned in the GET Billing Markets /v2/market endpoint for the relevant supplier.

Note: A 401 error is returned if the user does not have Finance permissions in the specified company. For more information, see Managing User Roles.

Path parameters

companyUidstringRequired

supplierIdstringRequired

Query parameters

fromDatestringOptional

The start date for which to return all invoices for the company / billing market combination. Enter the date in the format: yyyy-mm-dd. (Optional)

toDatestringOptional

The end date for which to return all invoices for the company / billing market combination. Enter the date in the format: yyyy-mm-dd. (Optional).

Response

Invoices (v3) / Invoices (v3)

dataobjectOptional

messagestringOptional

termsstringOptional