Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Billing Invoice: API vs. Excel

The following table shows the relationship between the billing API fields(*) and the corresponding names on the Excel billing invoice.

(*) response of data payload for GET Invoices Details.

N/A - the header does not apply to the Excel invoice.

API field nameExcel invoice (column header)Relationship
transactionIdTransaction #One-to-one.
businessLegalEntityEquinix Legal EntityOne-to-one.
transactionTypeTransaction Type One-to-one.
transactionDateTransaction DateOne-to-one.
orderIdSales Order #One-to-one.
lineNumberLN #One-to-one.
subLineNumberSubline # One-to-one.
customerDetailsN/ANone.
The API object consists of the following fields where applicable:
  • accountName
  • accountNumber
  • legalEntity
  • region
  • countryCode
accountNameCustomer Bill to Name One-to-one.
The API field of the customerDetails object.
accountNumberCustomer Account # One-to-one.
The API field of the customerDetails object.
legalEntityCustomer Legal Entity One-to-one.
The API field of the customerDetails object.
regionRegion One-to-one.
The API field of the customerDetails object.
countryCodeCountryOne-to-one.
The API field of the customerDetails object.
purchaseOrderNumberPurchase Order # One-to-one.
billingAgreementIdBilling Agreement #One-to-one.
customerReferenceIdCustomer Reference #One-to-one.
priorAdjustmentReferenceAdjustment for Prior Invoice #One-to-one.
ibxsIBX CenterOne-to-one.
recurringStartDateRecurring From Date One-to-one.
recurringEndDateRecurring To Date One-to-one.
contactsN/ANone.
Array of objects. Each object consists of the following fields where applicable:
  • firstName
  • lastName
  • type
firstNameBooked By One-to-many.
The API field of the contacts object.
Billing Analyst
lastNameBooked By One-to-many.
The API field of the contacts object.
Billing Analyst
typeN/ANone.
The API field of the contacts object.
Depending on the enum type: BOOKED_BY or BILLING_ANALYST, the proper first name and last name are displayed in the Booked By and Billing Analyst column headers.
orderBookedDateOrder Booked Date One-to-one.
activityTypeActivity Type One-to-one.
productCategoryProduct Category One-to-one.
productDescriptionProduct Description One-to-one.
productCodeProduct Code One-to-one.
productNameProduct NameOne-to-one.
detailedDescriptionLocation of item with Serial NumberOne-to-one.
ibxDescriptionIBX LocationOne-to-one.
quantityQty One-to-one.
unitOfMeasureUnits One-to-one.
unitPriceUnit Price One-to-one.
frequencyInvoice Frequency One-to-one.
currencyCodeInvoice CurrencyOne-to-one.
localCurrencyCodeLocal CurrencyOne-to-one.
exchangeRateFx RateOne-to-one.
nonRecurringAmountNon Recurring AmountOne-to-one.
recurringAmountRecurring AmountOne-to-one.
adjustmentAdjustmentsOne-to-one.
taxAmountTaxOne-to-one.
totalAmountTotal AmountOne-to-one.
legacyOrderIdLegacy Order #One-to-one.
additionalInfoN/ANone.
Array of the objects (key-value pairs.)
keyPUE
PDU / Distribution Panel #
Start Reading
End Reading
Sub Account Number
Sub Account Name
Z Side Customer Name
Serial #
IBX:Floor:Cage:Cabinet
First Price Increase Applicable After
Price Increase Percentage
One-to-many.
valueN/AValue related to the key in the key-value pair.
termsOfUseN/ANone.
Array of the objects (value-type-period pairs.)
valueN/AValue related to the period in the period-value pair.
Number represents months.
typeInitial Term
Renewal Term
One-to-many.
The enum types: INITIAL_TERM and RENEWAL_TERM.
periodN/ANone.
The enum type: MONTHS.