<!--
{
  "documentType" : "article",
  "framework" : "ExternalPurchaseServerAPI",
  "identifier" : "/documentation/ExternalPurchaseServerAPI/lineitems",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Line item fields"
}
-->

# Line item fields

Properties that describe a single transaction or correction in an external purchase report.

## Topics

### Identifying the line item

[`string lineItemId`](/documentation/ExternalPurchaseServerAPI/lineItemId)

A unique identifier for the line item, that you determine.

### Providing transaction info

[`int64 creationDate`](/documentation/ExternalPurchaseServerAPI/creationDate)

The UNIX date, in milliseconds, that the customer authorized the transaction.

[`string eventType`](/documentation/ExternalPurchaseServerAPI/eventType)

The type of transaction the line item reports, whether it’s a buy or refund.

[`string referenceLineItemId`](/documentation/ExternalPurchaseServerAPI/referenceLineItemId)

The line item identifier of another transaction, that the report  references.

### Providing product info

[`string productIdentifier`](/documentation/ExternalPurchaseServerAPI/productIdentifier)

A string that identifies the product.

[`string productType`](/documentation/ExternalPurchaseServerAPI/productType)

The type of product in the transaction, whether it’s a one-time buy, or a subscription.

[`int64 quantity`](/documentation/ExternalPurchaseServerAPI/quantity)

The quantity of the product the customer purchased in a single transaction.

### Specifying amounts and currency

[`int64 amountTaxExclusive`](/documentation/ExternalPurchaseServerAPI/amountTaxExclusive)

The amount, in milli-units, that the customer paid or was refunded, excluding taxes.

[`int64 amountTaxInclusive`](/documentation/ExternalPurchaseServerAPI/amountTaxInclusive)

The amount, in milli-units, that the customer paid, including taxes.

[`int64 netAmountTaxExclusive`](/documentation/ExternalPurchaseServerAPI/netAmountTaxExclusive)

The net amount, in milli-units, that you charged the customer, pre-tax, and after deducting all refunds.

[`int64 taxAmount`](/documentation/ExternalPurchaseServerAPI/taxAmount)

The amount, in milli-units, that the customer paid in taxes.

[`string taxCountry`](/documentation/ExternalPurchaseServerAPI/taxCountry)

The three-letter country code of the country that collects the taxes for the transaction.

[`string pricingCurrency`](/documentation/ExternalPurchaseServerAPI/pricingCurrency)

The currency used in the transaction to bill or refund the customer.

[`string reportingCurrency`](/documentation/ExternalPurchaseServerAPI/reportingCurrency)

The currency the line item uses to report all amount values.

[`double exchangeRate`](/documentation/ExternalPurchaseServerAPI/exchangeRate)

A decimal value that is the exchange rate you use to convert the pricing currency to the reporting currency, when the two currencies differ.

### Supplying subscription info

[`int32 subscriptionDaysOfPaidService`](/documentation/ExternalPurchaseServerAPI/subscriptionDaysOfPaidService)

The total number of days of paid service for the subscription.

[`int64 subscriptionEndDate`](/documentation/ExternalPurchaseServerAPI/subscriptionEndDate)

The UNIX date, in milli-seconds, the subscription renewal cycle ends.

[`string subscriptionEvent`](/documentation/ExternalPurchaseServerAPI/subscriptionEvent)

The event in the subscription’s life cycle that the transaction represents.

[`int64 subscriptionStartDate`](/documentation/ExternalPurchaseServerAPI/subscriptionStartDate)

The UNIX date, in milli-seconds, of the start of the subscription renewal period.

[`string referenceLineItemId`](/documentation/ExternalPurchaseServerAPI/referenceLineItemId)

The line item identifier of another transaction, that the report  references.

### Submitting corrections

[`boolean erroneouslySubmitted`](/documentation/ExternalPurchaseServerAPI/erroneouslySubmitted)

A Boolean value that indicates whether a line item was submitted in error.

[`boolean restatement`](/documentation/ExternalPurchaseServerAPI/restatement)

A Boolean value that indicates a line item contains a correction.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)