Invoicing API Data

This section details the data structures the API exchanges.

Schemas

Notification

Specifies a set of people to notify whenever an invoice is available for a set of contracts.

Sample GET:

{
    "status": "ACTIVE",
    "title": "Billing Center Invoice Notification",
    "contractIds": [
        "1-3CV382"
    ],
    "emails": [
        "user@example.com"
    ],
    "modificationDate": "2015-01-01T00:00:00Z",
    "creationDate": "2015-01-01T00:00:00Z",
    "id": 2584
}

Notification Members  

Member Type Required Description
contractIds Array Lists string identifiers representing the range of contracts for which the notification applies. Each notification reports on a unique set of contracts.
creationDate String Read-only. The time when the notification was created, ISO 8601-formatted.
emails Array Lists recipients’ email address strings.
id Integer Read-only. Unique identifier for each notification.
modificationDate String Read-only. The time of the notification’s most recent change, ISO 8601-formatted.
status Enumeration Either ACTIVE to notify recipients about changes to invoices, or SUSPENDED to disable a notification.
title String Descriptive title to identify each notification.

Invoice

Contains contract-specific invoice data. All members are read-only and always present in GET responses.

Sample GET:

[
    {
        "files": [
            "1234567890_FINAL.pdf",
            "1234567890_FINAL.csv",
            "Akamai_1234567890.json"
        ],
        "fileVersion": "1",
        "invoiceDate": "2015-01-01",
        "invoiceDueDate": "2015-01-20",
        "invoiceTotal": 50000.42,
        "invoiceNumber": "1234567890",
        "accountId": "1-XYZ",
        "contractId": "1-ABCD"
    }
]

Invoice Members  

Member Type Required Description
accountId String Unique identifier for the account to which the invoice applies. Corresponds to the InvoiceFile object’s ACCOUNT_ID.
contractId String Unique identifier for the contract to which the invoice applies.
fileVersion String An integer version string that identifies any changes to the set of files, incrementing when a file is added or modified.
files Array Identifies each invoice filename. Separate files are typically available in JSON, PDF, and CSV formats.
invoiceDate String The invoice’s published date, formatted as ISO–8601 YYYY-MM-DD. Corresponds to the InvoiceFile object’s INVOICE_DATE.
invoiceDueDate String The invoice’s last permissible published date, formatted as ISO–8601 YYYY-MM-DD.
invoiceNumber String Unique identifier for the invoice. Corresponds to the InvoiceFile object’s INVOICE_ID.
invoiceTotal Number The amount billed, measured in U.S. dollars. Corresponds to the sum of all of the InvoiceFile object’s ITEM_TOTAL values after the currency is normalized.

InvoiceFile

Encapsulates detailed invoice information available in a JSON file download.

Sample GET:

{
    "INVOICE": {
        "INVOICE_ORDER_ID": "3-1ABCD12",
        "ACCOUNT_ID": "1-ABCDE",
        "FINALIZED_DATE": "2017-02-28",
        "INVOICE_TYPE": "Standard Invoice",
        "INVOICE_ID": 17331001020,
        "INVOICE_DATE": "2017-03-01",
        "END_CUSTOMER": [
            {
                "END_CUSTOMER_ACCOUNT_NAME": "Stream&Store, Inc.",
                "END_CUSTOMER_ORDER_ID": "3-1ABCD12",
                "END_CUSTOMER_ACCOUNT_ID": "1-ABCDE",
                "INVOICE_LINE": [
                    {
                        "PRODUCT": "Dynamic Site Delivery::HTTPS Option::SSL Network Access - 3rd Party Certificate",
                        "ITEM_END_DATE": "2017-03-31",
                        "PRODUCT_ID": "M-LC-159850",
                        "CREDITED_INVOICE_LINE_NUMBER": null,
                        "ITEM_UNIT_PRICE": 250,
                        "ITEM_TOTAL_SERVICES": 7500,
                        "ITEM_TYPE": "P",
                        "ITEM_DESC": "Dynamic Site Delivery::HTTPS Option::SSL Network Access - 3rd Party Certificate Committed ",
                        "ITEM_TOTAL_TAXES": 1500,
                        "EFFECTIVE_END_DATE": "2018-07-31",
                        "ITEM_UNITS": 30,
                        "ITEM_START_DATE": "2017-03-01",
                        "ITEM_TOTAL": 9000,
                        "CREDITED_INVOICE_NUMBER": null,
                        "UNIT_MEASURE": "Unit"
                    },
                    {
                        "PRODUCT": "Professional Services - Enterprise::Professional Services - Enterprise",
                        "ITEM_END_DATE": "2017-03-31",
                        "PRODUCT_ID": "M-LC-135915",
                        "CREDITED_INVOICE_LINE_NUMBER": null,
                        "ITEM_UNIT_PRICE": 1400,
                        "ITEM_TOTAL_SERVICES": 1400,
                        "ITEM_TYPE": "P",
                        "ITEM_DESC": "Professional Services - Enterprise::Professional Services - Enterprise",
                        "ITEM_TOTAL_TAXES": 280,
                        "EFFECTIVE_END_DATE": "2018-07-31",
                        "ITEM_UNITS": 1,
                        "ITEM_START_DATE": "2017-03-01",
                        "ITEM_TOTAL": 1680,
                        "CREDITED_INVOICE_NUMBER": null,
                        "UNIT_MEASURE": "Per Month"
                    },
                    {
                        "PRODUCT": "Akamai University Customer Training - Classroom",
                        "ITEM_END_DATE": "2017-03-31",
                        "PRODUCT_ID": "M-LC-133443",
                        "CREDITED_INVOICE_LINE_NUMBER": null,
                        "ITEM_UNIT_PRICE": 110,
                        "ITEM_TOTAL_SERVICES": 110,
                        "ITEM_TYPE": "P",
                        "ITEM_DESC": "Akamai University Customer Training - Classroom Committed ",
                        "ITEM_TOTAL_TAXES": 22,
                        "EFFECTIVE_END_DATE": "2018-07-31",
                        "ITEM_UNITS": 1,
                        "ITEM_START_DATE": "2017-03-01",
                        "ITEM_TOTAL": 132,
                        "CREDITED_INVOICE_NUMBER": null,
                        "UNIT_MEASURE": "Each"
                    },
                    {
                        "PRODUCT": "Dynamic Site Delivery::HTTPS Option",
                        "ITEM_END_DATE": "2017-03-31",
                        "PRODUCT_ID": "M-LC-121907",
                        "CREDITED_INVOICE_LINE_NUMBER": null,
                        "ITEM_UNIT_PRICE": 24672,
                        "ITEM_TOTAL_SERVICES": 24672,
                        "ITEM_TYPE": "P",
                        "ITEM_DESC": "HTTPS \u2013 Custom Certificate \u2013 Dynamic Site Delivery",
                        "ITEM_TOTAL_TAXES": 4934.4,
                        "EFFECTIVE_END_DATE": "2018-07-31",
                        "ITEM_UNITS": 1,
                        "ITEM_START_DATE": "2017-03-01",
                        "ITEM_TOTAL": 29606.4,
                        "CREDITED_INVOICE_NUMBER": null,
                        "UNIT_MEASURE": "Base Fee"
                    }
                ],
                "END_CUSTOMER_EXTERNAL_REFERENCE": null
            },
            {
                "END_CUSTOMER_ACCOUNT_NAME": "Stream&Store, Inc.",
                "END_CUSTOMER_ORDER_ID": "M-1ABCD13",
                "END_CUSTOMER_ACCOUNT_ID": "1-ABCDE",
                "INVOICE_LINE": [
                    {
                        "PRODUCT": "Dynamic Site Delivery::China CDN",
                        "ITEM_END_DATE": "2017-03-31",
                        "PRODUCT_ID": "M-LC-122113",
                        "CREDITED_INVOICE_LINE_NUMBER": null,
                        "ITEM_UNIT_PRICE": 1413,
                        "ITEM_TOTAL_SERVICES": 1413,
                        "ITEM_TYPE": "P",
                        "ITEM_DESC": "Dynamic Site Delivery::China CDN",
                        "ITEM_TOTAL_TAXES": 282.6,
                        "EFFECTIVE_END_DATE": "2018-07-31",
                        "ITEM_UNITS": 1,
                        "ITEM_START_DATE": "2017-03-01",
                        "ITEM_TOTAL": 1695.6,
                        "CREDITED_INVOICE_NUMBER": null,
                        "UNIT_MEASURE": "Per Month"
                    }
                ],
                "END_CUSTOMER_EXTERNAL_REFERENCE": null
            }
        ],
        "ACCOUNT_NAME": "Stream&Store, Inc.",
        "PO_NUMBER": null,
        "INVOICE_VERSION": 1,
        "INVOICE_CURRENCY": "GBP"
    }
}

InvoiceFile Members  

Member Type Required Description
INVOICE InvoiceFile.INVOICE All invoice file data is encapsulated within this top-level member.

InvoiceFile.INVOICE  

All invoice file data is encapsulated within this top-level member.

Member Type Required Description
ACCOUNT_ID String Unique identifier for the account this invoice reflects. Corresponds to the Invoice object’s accountId.
ACCOUNT_NAME String The name for the account this invoice reflects.
END_CUSTOMER InvoiceFile.INVOICE.END_CUSTOMER[n] Collects products and services purchased as a bundle.
FINALIZED_DATE String Date when final values have been calculated, formatted as ISO–8601 YYYY-MM-DD.
INVOICE_CURRENCY String Three-letter ISO 4217 code indicating the currency that measures all totals.
INVOICE_DATE String Date when the invoice was issued, formatted as ISO–8601 YYYY-MM-DD. Corresponds to the Invoice object’s invoiceDate.
INVOICE_ID Integer Unique identifier for each invoice. Corresponds to the Invoice object’s invoiceNumber.
INVOICE_ORDER_ID String Unique identifier for the purchase order this invoice reflects.
INVOICE_TYPE String The overall category for the invoice, such as Standard Invoice or Credit Memo for adjustments.
INVOICE_VERSION Integer Invoices are versioned in case they later need to be adjusted.
PO_NUMBER String The purchase order number. Value may be null.

InvoiceFile.INVOICE.END_CUSTOMER[n]  

Collects products and services purchased as a bundle.

Member Type Required Description
END_CUSTOMER_ACCOUNT_ID String The ACCOUNT_ID under which this bundle of services was purchased.
END_CUSTOMER_ACCOUNT_NAME String The ACCOUNT_NAME under which this bundle of services was purchased.
END_CUSTOMER_EXTERNAL_REFERENCE String An optional identifier for which the value may be null.
END_CUSTOMER_ORDER_ID String The INVOICE_ORDER_ID under which this bundle of services was purchased.
INVOICE_LINE InvoiceFile.INVOICE.END_CUSTOMER[n].INVOICE_LINE[n] Encapsulates invoice items aggregated by product, corresponding to each row of CSV data.

InvoiceFile.INVOICE.END_CUSTOMER[n].INVOICE_LINE[n]  

Encapsulates invoice items aggregated by product, corresponding to each row of CSV data.

Member Type Required Description
CREDITED_INVOICE_LINE_NUMBER String In case this total reflects an adjusted value, this indexes the earlier invoice’s INVOICE_LINE where the error occurred. This value is usually null.
CREDITED_INVOICE_NUMBER String In case this total reflects an adjusted value, this identifies the INVOICE_ID that contains the error. This value is usually null.
EFFECTIVE_END_DATE String Indicates when the measured service would expire under the contract, formatted as ISO–8601 YYYY-MM-DD.
ITEM_DESC String Describes the product.
ITEM_END_DATE String The end of the measured term, formatted as ISO–8601 YYYY-MM-DD.
ITEM_START_DATE String The start of the measured term, formatted as ISO–8601 YYYY-MM-DD.
ITEM_TOTAL Number The sum of ITEM_TOTAL_SERVICES and ITEM_TOTAL_TAXES. The sum of all these values corresponds to the Invoice object’s invoiceTotal, where the latter value is normalized is U.S. dollar terms.
ITEM_TOTAL_SERVICES Integer The total for all provided services.
ITEM_TOTAL_TAXES Number All additional taxes based on the ITEM_TOTAL_SERVICES.
ITEM_TYPE Enumeration The type of charge on an invoice. Possible values are B for bursting charges, C for true-up period unit commit charges, F for arrears commit charges, P for pre-bill commit charges, R where a previously prebilled commit is adjusted due to having reached re-pricing tiers, S for non-recurring commit charges, U for usage charges, X for super bursting charges, Z for true-up revenue commit charges, and AU for usage period commit adjustments.
ITEM_UNITS Integer The number of priced units, typically 1 for individual items or the number of days for a term of service.
ITEM_UNIT_PRICE Integer The price per ITEM_UNITS.
PRODUCT String Description of the invoiced product.
PRODUCT_ID String Unique identifier for each invoiced product.
UNIT_MEASURE String Characterizes the unit of sale or term of service.

Last modified: 4/10/2017