Single Invoice (v3)

GET

/v3/company/:companyUid/supplier/:supplierId/invoice/:invoiceid

GET

/v3/company/:companyUid/supplier/:supplierId/invoice/:invoiceid

curl https://api.megaport.com/v3/company/companyUid/supplier/supplierId/invoice/invoiceid

200Retrieved

{
  "data": {
    "companyId": "1",
    "companyName": "Netflix",
    "consumerId": "1",
    "createDate": 1698796800000,
    "currencyEnum": "AUD",
    "dueAmount": 0,
    "dueDate": 1701388800000,
    "grandTotal": 2420,
    "invoiceId": 1,
    "invoiceNumber": "AUS00012345",
    "lineItemTotal": 2200,
    "lineItems": [
      {
        "billableCode": "Port",
        "chargePeriod": {
          "end": 1701302400000,
          "start": 1698796800000
        },
        "chargeType": "",
        "chargedFromTo": "From 11/1/2023 to 11/30/2023",
        "description": "Port 1 MEGAPORT recurring",
        "end": 1701302400000,
        "managedAccountReference": "",
        "nominalDueDate": 0,
        "productName": "",
        "productUid": "",
        "promocode": "",
        "rateLimit": "",
        "shortProductUid": "1234abcd",
        "size": "",
        "speed": "",
        "start": 1698796800000,
        "tax": 110,
        "taxRate": 0.1,
        "unitPrice": 1100
      },
      {
        "billableCode": "Port",
        "chargePeriod": {
          "end": 1701302400000,
          "start": 1698796800000
        },
        "chargeType": "",
        "chargedFromTo": "From 11/1/2023 to 11/30/2023",
        "description": "Port 2 MEGAPORT recurring",
        "end": 1701302400000,
        "managedAccountReference": "",
        "nominalDueDate": 0,
        "productName": "",
        "productUid": "",
        "promocode": "",
        "rateLimit": "",
        "shortProductUid": "abcd1234",
        "size": "",
        "speed": "",
        "start": 1698796800000,
        "tax": 110,
        "taxRate": 0.1,
        "unitPrice": 1100
      }
    ],
    "marketCurrencyEnum": "AUD",
    "marketGrandTotal": 2420,
    "marketLineItemTotal": 2200,
    "marketTaxTotal": 220,
    "mixedCurrency": false,
    "previousInvoiceDate": 1696291200000,
    "previousInvoiceId": 2,
    "supplierId": "808",
    "taxRate": 0.1,
    "taxTotal": 220
  },
  "message": "Found invoice AUS00012345",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Returns the invoice for the specified companyUid, supplierId, and invoiceId in JSON format.

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

invoiceidstringRequired

Response

Single Invoice (v3) / Single Invoice (v3)

dataobjectOptional

messagestringOptional

termsstringOptional