Introduction

The format was originally developed – as the EDItX Digital Sales Report format version 1.0 – in 2003, primarily for use in the nascent e-book supply chain in North America, for reporting e-book sales on wholesale terms, but a series of revisions have made it suitable for international use both in digital and physical book supply chains, for reporting sales under both wholesale and agency terms, and in a variety of tax regimes.

Introduction to Version 1.1

Version 1.1 incorporates a number of changes to meet North American sales and sales tax reporting requirements, as worked out in collaboration with the Sales Reporting Working Group of the Book Industry Study Group’s Supply Chain EDI Committee. A small number of new elements have been added in support of this North American usage.

An important change in this version, applicable internationally, allows the format to be used for sales tax reporting, especially for sales made under agency terms. A new top-level element – <SalesTaxReport> – has been added, to enable sales and sales tax reports to be distinguished when they relate to the same set of sales.

Introduction to Version 1.2

This version 1.2 of the EDItX Sales and Sales Tax Report format is intended to broaden the use of these reports, in particular by extending the pricing model to incorporate most of the variations of price that are used in ONIX for Books v3.0. This adds prices that are conditional on other purchases, for example, and prices that carry various usage constraints and DRM. In particular, a single product may have multiple prices with different conditions and constraints: in a sales report, these must be reported on separate lines. The new Report formats retain full backwards compatibility with version 1.1 (ie old messages are still valid under the new v1.1 specification and XML schemas), while introducing optional new data elements and functionality.

Some XML tags have been changed – eg the <Author> tag becomes <Contributor> – to better align the terminology with ONIX for Books. To maintain compatibility, the original tags can still be used – in effect, <Author> and <Contributor> are synonyms – but wherever possible, the newer version should be used. The newer tags are used in this document, with the older tags listed as ‘aliases’. These aliases will be removed from future updates of the standard. Textual codes used within data elements (for example ‘EAN’ or ‘TaxRegistrationCode’) have been retained, but alphanumeric codes from ONIX codelists can also be used in many cases. In general, where there is a choice, the alphanumeric codes are preferred and the older textual codes will be removed from future updates of the standard.

Use cases

The EDItX Sales and Sales Tax report message formats are intended to be used by a retailer, distributor or other intermediary reseller or selling agent, or by an agent reporting on their behalf, to report sales to a supplier or publisher.

The format allows these reporting options:

  1. Each report line may list an individual transaction, or it may provide a total of all transactions for a particular tradeable product under a given class of sale or at a given price point during the reporting period specified in the message header;
  2. A number of standard Classes of sale are predefined (Agency, Wholesale, Retail, Export and so on), more standard classes may be defined in future revisions of the format, and further classes may be defined as required by trading partners to reflect the details of the arrangements which they have negotiated;
  3. The monetary amounts due to the publisher may be calculated on the basis of an agreed net unit cost to the reseller, or on the basis of a discount from either the publisher’s list price of the reseller’s actual sale price, or on the basis of an agreed discount to the consumer that was applied by the selling agent to the publisher’s retail price. In addition, a reseller’s or agent’s fees may be deducted from the price. Where there is both a discount on price and a reseller’s or agent’s fee, the discounted price must be calculated before the fee is deducted;
  4. In support of the adoption of agency terms, especially in North America, commission may be reported as a percentage in much the same way as discounts are reported for sales under wholesale terms;
  5. It is also possible to use the format to identify sales by retail outlet, either as individual transactions or by aggregating all transactions for a given format of a given title through each retail outlet;
  6. For reports that list individual transactions, the sales tax or the value added tax that is due may be reported for each transaction. If the format is to be used for reporting sales and sales or value added tax in separate reports, these may be distinguished by using an alternative top-level name element <SalesTaxReport>. The only differences between the two formats are that in <SalesTaxReport> inclusion of a Product identifier is not mandatory, but inclusion of tax information is, whereas in <SalesReport>, an identifier is mandatory and tax information is optional (see Appendix 1 for all the differences between two report formats).

It is fundamental that reports should tally precisely with related payments, to make reconciliation as simple as possible. Depending on trading partner agreement, calculation of the amounts due to the publisher may be carried out and stated at ‘message level’, or they may be calculated and stated explicitly at line level, with a message total representing the sum of the line item amounts. If line-level subtotals are stated in the message, they must be shown with sufficient decimal places to ensure that, when added, they match the message total without rounding discrepancies.

Document history

2 February 2003
Initial release of EDItX Digital Sales Report Format v1.0 specification (as PDF).
9 March 2009
Initial release of EDItX Sales Report Format v1.0 specification, based on the Digital Sales Report Format (as PDF).
2 March 2011
Release of Sales Report Format v1.1, initial release of EDItX Sales Tax Report Format v1.1 (as PDF).
2 May 2014
Additions to embedded codes.
31 October 2018
Release of Sales Tax Report Format v1.2 specification (as HTML).
Addition of DRM, usage conditions and constraints and licensing detail related to e-products.
Additions to the <Price> composite to align with the pricing model of ONIX for Books.
Deprecations of a few data elements, aimed at reducing unnecessary variation in implementations.
Other minor changes including tag aliases to improve familiarity for ONIX users, integration with some ONIX codelists, and greatly improved documentation.

Message structure summary

The message consists of three parts – a header, a body and a trailer. The header contains information about the message itself, plus details of the parties involved in the sales that are the subject of the report. The trailer contains simple totals that can be used to ensure the whole message has been received and processed.

The tables below show all composites and data elements in the complete message. Indenting shows the nesting structure of the data elements within the composites. Aliases (old tag names that have been replaced by new tag names, but which are retained for compatibility purposes) and elements new in this version are highlighted in the Notes column.

Click on the element names to jump to a detailed description of the element and its content.

The rightmost column indicates the cardinality of each data element – whether the element is optional (0…1), optional and repeatable (0…n), mandatory (1) or mandatory and repeatable (1…n) – within its parent composite. Deprecated elements have the cardinality column in red. In general, data elements are not allowed to be empty. If there is no relevant data for an element, the whole element must be omitted – and if the element is mandatory, its enclosing composite must be omitted. The sole exception to this is the <TaxExempt> flag, which must be empty.

# Element Notes Card
M.0<?xml version="1.0" encoding="UTF-8" ?>
M.1<SalesReport version="1.2"> or <SalesTaxReport version="1.2">1
Message header
# Element Notes Card
H.1    <Header>1
H.2        <SalesTaxReportType>0…1
H.3        <SalesReportNumber>1
H.4        <IssueDateTime>1
H.5        <ReferenceCoded>0…n
H.6           <ReferenceTypeCode>1
H.7           <ReferenceTypeName>0…1
H.8           <ReferenceNumber>0…1
H.9           <ReferenceDate>0…1
H.10           <ReferenceDateTime>0…1
H.11        <PurposeCode>1
H.12        <SalesTaxReportType>New in v1.20…1
H.13        <SalesReportTypeCode>0…1
H.14        <ReportPriceType><ReportPriceQualifierCode>0…1
H.15        <CurrencyCode>0…1
H.16        <CountryCode>0…1
H.17        <FromDate>0…1
H.18        <ToDate>0…1
H.19        <DateCoded>0…n
H.20            <Date>1
H.21            <DateQualifierCode>1
H.22        <ClassOfSaleCode>0…n
H.23        <TradingZone>0…1
H.24        <Territory>New in v1.20…1
H.25            <CountriesIncluded>New in v1.20…1
H.26            <RegionsIncluded>New in v1.20…1
H.27            <CountriesExcluded>New in v1.20…1
H.28            <RegionsExcluded>New in v1.20…1
H.29        <SellerParty>0…1
H.30            <PartyIdentifier><PartyID>0…1
H.31                <PartyIDType>1
H.32                <IDTypeName>0…1
H.33                <IDValue><Identifier>1
H.34            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
H.35                <PartyIDType>1
H.36                <IDTypeName>0…1
H.37                <IDValue><Identifier>1
H.38            <PartyName>0…1
H.39                <NameLine>1…n
H.40            <PostalAddress>0…1
H.41                <AddressLine>1…n
H.42            <CommunicationDetails>0…n
H.43                <CommunicationTypeCode>1
H.44                <CommunicationLocator>1
H.45            <ContactPerson>0…n
H.46                <ContactRoleCode>0…1
H.47                <PersonName>1
H.48                <CommunicationDetails>0…n
H.49                    <CommunicationTypeCode>1
H.50                    <CommunicationLocator>1
H.51            <CountryCode>0…1
H.52            <RegionCode>0…1
H.53        <PublisherParty>0…1
H.54            <PartyIdentifier><PartyID>0…1
H.55                <PartyIDType>1
H.56                <IDTypeName>0…1
H.57                <IDValue><Identifier>1
H.58            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
H.59                <PartyIDType>1
H.60                <IDTypeName>0…1
H.61                <IDValue><Identifier>1
H.62            <PartyName>0…1
H.63                <NameLine>1…n
H.64            <PostalAddress>0…1
H.65                <AddressLine>1…n
H.66            <CommunicationDetails>0…n
H.67                <CommunicationTypeCode>1
H.68                <CommunicationLocator>1
H.69            <ContactPerson>0…n
H.70                <ContactRoleCode>0…1
H.71                <PersonName>1
H.72                <CommunicationDetails>0…n
H.73                    <CommunicationTypeCode>1
H.74                    <CommunicationLocator>1
H.75            <CountryCode>0…1
H.76            <RegionCode>0…1
H.77        <SupplierParty>0…1
H.78            <PartyIdentifier><PartyID>0…1
H.79                <PartyIDType>1
H.80                <IDTypeName>0…1
H.81                <IDValue><Identifier>1
H.82            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
H.83                <PartyIDType>1
H.84                <IDTypeName>0…1
H.85                <IDValue><Identifier>1
H.86            <PartyName>0…1
H.87                <NameLine>1…n
H.88            <PostalAddress>0…1
H.89                <AddressLine>1…n
H.90            <CommunicationDetails>0…n
H.91                <CommunicationTypeCode>1
H.92                <CommunicationLocator>1
H.93            <ContactPerson>0…n
H.94                <ContactRoleCode>0…1
H.95                <PersonName>1
H.96                <CommunicationDetails>0…n
H.97                    <CommunicationTypeCode>1
H.98                    <CommunicationLocator>1
H.99            <CountryCode>0…1
H.100            <RegionCode>0…1
H.101        <BuyerParty>0…1
H.102            <PartyIdentifier><PartyID>0…1
H.103                <PartyIDType>1
H.104                <IDTypeName>0…1
H.105                <IDValue><Identifier>1
H.106            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
H.107                <PartyIDType>1
H.108                <IDTypeName>0…1
H.109                <IDValue><Identifier>1
H.110            <PartyName>0…1
H.111                <NameLine>1…n
H.112            <PostalAddress>0…1
H.113                <AddressLine>1…n
H.114            <CommunicationDetails>0…n
H.115                <CommunicationTypeCode>1
H.116                <CommunicationLocator>1
H.117            <ContactPerson>0…n
H.118                <ContactRoleCode>0…1
H.119                <PersonName>1
H.120                <CommunicationDetails>0…n
H.121                    <CommunicationTypeCode>1
H.122                    <CommunicationLocator>1
H.123            <CountryCode>0…1
H.124            <RegionCode>0…1
H.125        <ReportingParty>0…1
H.126            <PartyIdentifier><PartyID>0…1
H.127                <PartyIDType>1
H.128                <IDTypeName>0…1
H.129                <IDValue><Identifier>1
H.130            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
H.131                <PartyIDType>1
H.132                <IDTypeName>0…1
H.133                <IDValue><Identifier>1
H.134            <PartyName>0…1
H.135                <NameLine>1…n
H.136            <PostalAddress>0…1
H.137                <AddressLine>1…n
H.138            <CommunicationDetails>0…n
H.139                <CommunicationTypeCode>1
H.140                <CommunicationLocator>1
H.141            <ContactPerson>0…n
H.142                <ContactRoleCode>0…1
H.143                <PersonName>1
H.144                <CommunicationDetails>0…n
H.145                    <CommunicationTypeCode>1
H.146                    <CommunicationLocator>1
H.147            <CountryCode>0…1
H.148            <RegionCode>0…1
H.149        <ReceivingParty>0…1
H.150            <PartyIdentifier><PartyID>0…1
H.151                <PartyIDType>1
H.152                <IDTypeName>0…1
H.153                <IDValue><Identifier>1
H.154            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
H.155                <PartyIDType>1
H.156                <IDTypeName>0…1
H.157                <IDValue><Identifier>1
H.158            <PartyName>0…1
H.159                <NameLine>1…n
H.160            <PostalAddress>0…1
H.161                <AddressLine>1…n
H.162            <CommunicationDetails>0…n
H.163                <CommunicationTypeCode>1
H.164                <CommunicationLocator>1
H.165            <ContactPerson>0…n
H.166                <ContactRoleCode>0…1
H.167                <PersonName>1
H.168                <CommunicationDetails>0…n
H.169                    <CommunicationTypeCode>1
H.170                    <CommunicationLocator>1
H.171            <CountryCode>0…1
H.172            <RegionCode>0…1
H.173        <SellingAgentParty>0…n
H.174            <PartyIdentifier><PartyID>0…1
H.175                <PartyIDType>1
H.176                <IDTypeName>0…1
H.177                <IDValue><Identifier>1
H.178            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
H.179                <PartyIDType>1
H.180                <IDTypeName>0…1
H.181                <IDValue><Identifier>1
H.182            <PartyName>0…1
H.183                <NameLine>1…n
H.184            <PostalAddress>0…1
H.185                <AddressLine>1…n
H.186            <CommunicationDetails>0…n
H.187                <CommunicationTypeCode>1
H.188                <CommunicationLocator>1
H.189            <ContactPerson>0…n
H.190                <ContactRoleCode>0…1
H.191                <PersonName>1
H.192                <CommunicationDetails>0…n
H.193                    <CommunicationTypeCode>1
H.194                    <CommunicationLocator>1
H.195            <CountryCode>0…1
H.196            <RegionCode>0…1

Message body

# Element Notes Card
B.1    <ItemDetail>1…n
B.2        <LineNumber>1
B.3        <ProductIdentifier><ProductID>0…n
B.4            <ProductIDType>1
B.5            <IDTypeName>0…1
B.6            <IDValue><Identifier>1
B.7        <ItemDescription>0…1
B.8            <TitleDetail>0…1
B.9            <Title>0…1
B.10            <Contributor><Author>0…1
B.11            <OtherDetail>0…1
B.12            <ProductClassification><ClassificationCoded>0…n
B.13                <ProductClassificationType><ClassificationCode>1
B.14                <ProductClassificationCode><ClassificationCodeType>1
B.15                <Percent>0…1
B.16        <PublisherDetail>0…1
B.17            <PublisherIdentifier><PublisherID>0…n
B.18                <PublisherIDType>1
B.19                <IDTypeName>0…1
B.20                <IDValue><Identifier>1
B.21            <PublisherName>0…1
B.22        <ImprintDetail>0…1
B.23            <ImprintIdentifier><ImprintID>0…n
B.24                <ImprintIDType>1
B.25                <IDTypeName>0…1
B.26                <IDValue><Identifier>1
B.27            <ImprintName>0…1
B.28        <FormatCode>0…n
B.29        <EpubTechnicalProtection>New in v1.20…1
B.30        <EpubUsageConstraint>New in v1.20…1
B.31            <EpubUsageType>New in v1.21
B.32            <EpubUsageStatus>New in v1.21
B.33            <EpubUsageLimit>New in v1.20…n
B.34                <Quantity>New in v1.21
B.35                <EpubUsageUnit>New in v1.21
B.36        <EpubLicense>New in v1.20…1
B.37            <EpubLicenseName>New in v1.21
B.38            <EpubLicenseExpression>New in v1.20…n
B.39                <EpubLicenseExpressionType>New in v1.21
B.40                <EpubLicenseExpressionTypeName>New in v1.20…n
B.41                <EpubLicenseExpressionLink>New in v1.21
B.42        <PriceCondition>New in v1.20…n
B.43            <PriceConditionType>New in v1.21
B.44            <PriceConditionQuantity>New in v1.20…n
B.45                <PriceConditionQuantityType>New in v1.21
B.46                <Quantity>New in v1.21
B.47                <QuantityUnit>New in v1.21
B.48        <DeviceType>0…1
B.49        <Quantity>0…1
B.50        <GrossSoldQuantity>0…1
B.51        <RefundedQuantity>0…1
B.52        <NetSoldQuantity>0…1
B.53        <NonSaleDisposal>0…n
B.54            <DisposalType>1
B.55            <DisposalQuantity>1
B.56        <ReferenceCoded>0…n
B.57            <ReferenceTypeCode>1
B.58            <ReferenceTypeName>0…1
B.59            <ReferenceNumber>0…1
B.60            <ReferenceDate>0…1
B.61            <ReferenceDateTime>0…1
B.62        <ShipToParty>0…1
B.63            <PartyIdentifier><PartyID>0…1
B.64                <PartyIDType>1
B.65                <IDTypeName>0…1
B.66                <IDValue><Identifier>1
B.67            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
B.68                <PartyIDType>1
B.69                <IDTypeName>0…1
B.70                <IDValue><Identifier>1
B.71            <PartyName>0…1
B.72                <NameLine>1…n
B.73            <PostalAddress>0…1
B.74                <AddressLine>1…n
B.75            <CommunicationDetails>0…n
B.76                <CommunicationTypeCode>1
B.77                <CommunicationLocator>1
B.78            <ContactPerson>0…n
B.79                <ContactRoleCode>0…1
B.80                <PersonName>1
B.81                <CommunicationDetails>0…n
B.82                    <CommunicationTypeCode>1
B.83                    <CommunicationLocator>1
B.84            <CountryCode>0…1
B.85            <RegionCode>0…1
B.86        <ShipToLocation>0…1
B.87            <LocationIdentifier><LocationID>1…n
B.88                <LocationIDType>1
B.89                <IDTypeName>0…1
B.90                <IDValue><Identifier>1
B.91        <BillToParty>0…1
B.92            <PartyIdentifier><PartyID>0…1
B.93                <PartyIDType>1
B.94                <IDTypeName>0…1
B.95                <IDValue><Identifier>1
B.96            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
B.97                <PartyIDType>1
B.98                <IDTypeName>0…1
B.99                <IDValue><Identifier>1
B.100            <PartyName>0…1
B.101                <NameLine>1…n
B.102            <PostalAddress>0…1
B.103                <AddressLine>1…n
B.104            <CommunicationDetails>0…n
B.105                <CommunicationTypeCode>1
B.106                <CommunicationLocator>1
B.107            <ContactPerson>0…n
B.108                <ContactRoleCode>0…1
B.109                <PersonName>1
B.110                <CommunicationDetails>0…n
B.111                    <CommunicationTypeCode>1
B.112                    <CommunicationLocator>1
B.113            <CountryCode>0…1
B.114            <RegionCode>0…1
B.115        <BillToLocation>0…1
B.116            <LocationIdentifier>1…n
B.117                <LocationIDType>1
B.118                <IDTypeName>0…1
B.119                <IDValue><Identifier>1
B.120        <DateCoded>0…1
B.121            <Date>1
B.122            <DateQualifierCode>1
B.123        <Date>New in v1.20…1
B.124        <PricingDetail>0…n
B.125            <ClassOfSaleCode>0…n
B.126            <Price>0…1
B.127                <PriceIdentifier>New in v1.20…1
B.128                    <PriceIDType>New in v1.21
B.129                    <IDTypeName>New in v1.20…1
B.130                    <IDValue>New in v1.21
B.131                <PriceType>New in v1.20…1
B.132                <PriceQualifier>New in v1.20…1
B.133                <DiscountCoded>New in v1.20…n
B.134                    <DiscountCodeType>New in v1.21
B.135                    <DiscountCodeTypeName>New in v1.20…1
B.136                    <DiscountCode>New in v1.21
B.137                <Discount>New in v1.20…n
B.138                    <DiscountType>New in v1.20…1
B.139                    <Quantity>New in v1.20…1
B.140                    <ToQuantity>New in v1.20…1
B.141                    <DiscountPercent>New in v1.20…1
B.142                    <DiscountAmount>New in v1.20…1
B.143                <PriceAmount><MonetaryAmount>1
B.144                <CurrencyCode>0…1
B.145                <CountryCode>0…1
B.146                <RegionCode>New in v1.20…1
B.147                <Territory>New in v1.20…1
B.148                    <CountriesIncluded>New in v1.20…1
B.149                    <RegionsIncluded>New in v1.20…1
B.150                    <CountriesExcluded>New in v1.20…1
B.151                    <RegionsExcluded>New in v1.20…1
B.152                <PriceQualifierCode>0…1
B.153                <Tax>0…n
B.154                    <ProductIdentifier>New in v1.20…n
B.155                         <ProductIDType>New in v1.21
B.156                         <IDTypeName>New in v1.20…1
B.157                         <IDValue>New in v1.21
B.158                    <PricePartDescription>New in v1.20…1
B.159                    <TaxType><TaxTypeCode>1
B.160                    <TaxTypeName>0…1
B.161                    <TaxRateCode>0…1
B.162                    <TaxRatePercent><Percent>0…1
B.163                    <TaxableAmount><AmountTaxable>0…1
B.164                    <TaxAmount>0…1
B.165                    <TaxComponent>0…n
B.166                        <TaxComponentTypeCode>1
B.167                        <TaxComponentTypeName>0…1
B.168                        <TaxRateCode>0…1
B.169                        <TaxRatePercent><Percent>0…1
B.170                        <TaxableAmount><AmountTaxable>0…1
B.171                        <TaxAmount>0…1
B.172                <TaxExempt/>New in v1.20…1
B.173            <DiscountPercentage>0…1
B.174            <CommissionDiscountPercentage>0…1
B.175            <CurrencyConversionRate>0…1
B.176            <SellerCharge>0…n
B.177                <ChargeTypeCode>0…1
B.178                <ChargeTypeDescription>0…1
B.179                <ChargeSourceCode>0…1
B.180                <MonetaryAmount>1
B.181                <CurrencyCode>0…1
B.182                <CountryCode>0…1
B.183                <RegionCode>New in v1.20…1
B.184                <Territory>New in v1.20…1
B.185                    <CountriesIncluded>New in v1.20…1
B.186                    <RegionsIncluded>New in v1.20…1
B.187                    <CountriesExcluded>New in v1.20…1
B.188                    <RegionsExcluded>New in v1.20…1
B.189                <ChargeQualifierCode>1
B.190                <Tax>0…n
B.191                    <TaxType><TaxTypeCode>1
B.192                    <TaxTypeName>0…1
B.193                    <TaxRateCode>0…1
B.194                    <TaxRatePercent><Percent>0…1
B.195                    <TaxableAmount><AmountTaxable>0…1
B.196                    <TaxAmount>0…1
B.197                    <TaxComponent>0…n
B.198                        <TaxComponentTypeCode>1
B.199                        <TaxComponentTypeName>0…1
B.200                        <TaxRateCode>0…1
B.201                        <TaxRatePercent><Percent>0…1
B.202                        <TaxableAmount><AmountTaxable>0…1
B.203                        <TaxAmount>0…1
B.204                <TaxExempt/>New in v1.20…1
B.205            <UnitAmountDueToPublisher><LineAmountDueToPublisher>0…1
B.206                <MonetaryAmount>1
B.207                <CurrencyCode>0…1
B.208                <CountryCode>0…1
B.209            <UnitAmountDueToSupplier><LineAmountDueToSupplier>0…1
B.210                <MonetaryAmount>1
B.211                <CurrencyCode>0…1
B.212                <CountryCode>0…1
B.213        <LineSalesAmounts>0…1
B.214            <GrossSalesAmountBeforeDiscounts>0…1
B.215            <DiscountsAmount>0…1
B.216            <GrossSalesAmount>0…1
B.217            <RefundedAmount>0…1
B.218            <NetSalesAmount>0…1
B.219            <SellerCharge>0…n
B.220                <ChargeTypeCode>0…1
B.221                <ChargeTypeDescription>0…1
B.222                <ChargeSourceCode>0…1
B.223                <MonetaryAmount>1
B.224                <CurrencyCode>0…1
B.225                <CountryCode>0…1
B.226                <RegionCode>New in v1.20…1
B.227                <Territory>New in v1.20…1
B.228                    <CountriesIncluded>New in v1.20…1
B.229                    <RegionsIncluded>New in v1.20…1
B.230                    <CountriesExcluded>New in v1.20…1
B.231                    <RegionsExcluded>New in v1.20…1
B.232                <ChargeQualifierCode>1
B.233                <Tax>0…n
B.234                    <TaxType><TaxTypeCode>1
B.235                    <TaxTypeName>0…1
B.236                    <TaxRateCode>0…1
B.237                    <TaxRatePercent><Percent>0…1
B.238                    <TaxableAmount><AmountTaxable>0…1
B.239                    <TaxAmount>0…1
B.240                    <TaxComponent>0…n
B.241                        <TaxComponentTypeCode>1
B.242                        <TaxComponentTypeName>0…1
B.243                        <TaxRateCode>0…1
B.244                        <TaxRatePercent><Percent>0…1
B.245                        <TaxableAmount><AmountTaxable>0…1
B.246                        <TaxAmount>0…1
B.247                <TaxExempt/>New in v1.20…1
B.248            <LineAmountDueToPublisher>0…1
B.249                <MonetaryAmount>1
B.250                <CurrencyCode>0…1
B.251                <CountryCode>0…1
B.252            <LineAmountDueToSupplier>0…1
B.253                <MonetaryAmount>1
B.254                <CurrencyCode>1
B.255                <CountryCode>0…1
B.256            <CurrencyCode>0…1
B.257            <CountryCode>0…1
B.258            <RegionCode>New in v1.20…1
B.259            <Territory>New in v1.20…1
B.260                    <CountriesIncluded>New in v1.20…1
B.261                    <RegionsIncluded>New in v1.20…1
B.262                    <CountriesExcluded>New in v1.20…1
B.263                    <RegionsExcluded>New in v1.20…1
B.264            <Tax>0…n
B.265                <ProductIdentifier>New in v1.20…n
B.266                    <ProductIDType>New in v1.21
B.267                    <IDTypeName>New in v1.20…1
B.268                    <IDValue>New in v1.21
B.269                <TaxType><TaxTypeCode>1
B.270                <TaxTypeName>0…1
B.271                <TaxRateCode>0…1
B.272                <TaxRatePercent><Percent>0…1
B.273                <TaxableAmount><AmountTaxable>0…1
B.274                <TaxAmount>0…1
B.275                <TaxComponent>0…n
B.276                    <TaxComponentTypeCode>1
B.277                    <TaxComponentTypeName>0…1
B.278                    <TaxRateCode>0…1
B.279                    <TaxRatePercent><Percent>0…1
B.280                    <TaxableAmount><AmountTaxable>0…1
B.281                    <TaxAmount>0…1
B.282            <TaxExempt/>New in v1.20…1
B.283        <SellingAgentParty>0…1
B.284            <PartyIdentifier><PartyID>0…1
B.285                <PartyIDType>1
B.286                <IDTypeName>0…1
B.287                <IDValue><Identifier>1
B.288            <AdditionalPartyIdentifier><AdditionalPartyID>0…n
B.289                <PartyIDType>1
B.290                <IDTypeName>0…1
B.291                <IDValue><Identifier>1
B.292            <PartyName>0…1
B.293                <NameLine>1…n
B.294            <PostalAddress>0…1
B.295                <AddressLine>1…n
B.296            <CommunicationDetails>0…n
B.297                <CommunicationTypeCode>1
B.298                <CommunicationLocator>1
B.299            <ContactPerson>0…n
B.300                <ContactRoleCode>0…1
B.301                <PersonName>1
B.302                <CommunicationDetails>0…n
B.303                    <CommunicationTypeCode>1
B.304                    <CommunicationLocator>1
B.305            <CountryCode>0…1
B.306            <RegionCode>0…1
B.307        <RetailerParty>0…1
B.308            <PartyName>1
B.309                <NameLine>1…n
B.310        <TradingZone>0…1
B.311        <Territory>New in v1.20…1
B.312            <CountriesIncluded>New in v1.20…1
B.313            <RegionsIncluded>New in v1.20…1
B.314            <CountriesExcluded>New in v1.20…1
B.315            <RegionsExcluded>New in v1.20…1

Message trailer

# Element Notes Card
T.1    <Summary>1
T.2        <NumberOfLines>1
T.3        <NumberOfUnits>0…1
T.4        <NumberOfGrossSalesUnits>0…1
T.5        <NumberOfRefundedUnits>0…1
T.6        <NumberOfNetSalesUnits>0…1
T.7        <NumberOfNonSaleUnits>0…1
T.8        <TotalSalesAmounts>0…n
T.9            <TotalGrossSalesAmount>0…1
T.10            <TotalRefundedSalesAmount>0…1
T.11            <TotalNetSalesAmount>0…1
T.12            <TotalSellerChargeAmount>0…1
T.13            <CurrencyCode>0…1
T.14            <CountryCode>0…1
T.15            <RegionCode>New in v1.20…1
T.16            <Territory>New in v1.20…1
T.17                <CountriesIncluded>New in v1.20…1
T.18                <RegionsIncluded>New in v1.20…1
T.19                <CountriesExcluded>New in v1.20…1
T.20                <RegionsExcluded>New in v1.20…1
T.21            <Tax>0…n
T.22                <TaxType><TaxTypeCode>1
T.23                <TaxTypeName>0…1
T.24                <TaxRateCode>0…1
T.25                <TaxRatePercent><Percent>0…1
T.26                <TaxableAmount><AmountTaxable>0…1
T.27                <TaxAmount>0…1
T.28                <TaxComponent>0…n
T.29                    <TaxComponentTypeCode>1
T.30                    <TaxComponentTypeName>0…1
T.31                    <TaxRateCode>0…1
T.32                    <TaxRatePercent><Percent>0…1
T.33                    <TaxableAmount><AmountTaxable>0…1
T.34                    <TaxAmount>0…1
T.35            <TaxExempt/>0…1
T.36        <TotalDueToPublisher>0…n
T.37            <MonetaryAmount>1
T.38            <CurrencyCode>0…1
T.39            <CountryCode>0…1
T.40            <RegionCode>New in v1.20…1
T.41            <Territory>New in v1.20…1
T.42                <CountriesIncluded>New in v1.20…1
T.43                <RegionsIncluded>New in v1.20…1
T.44                <CountriesExcluded>New in v1.20…1
T.45                <RegionsExcluded>New in v1.20…1
T.46        <TotalDueToSupplier>0…n
T.47            <MonetaryAmount>1
T.48            <CurrencyCode>0…1
T.49            <CountryCode>0…1
T.50            <RegionCode>New in v1.20…1
T.51            <Territory>New in v1.20…1
T.52                <CountriesIncluded>New in v1.20…1
T.53                <RegionsIncluded>New in v1.20…1
T.54                <CountriesExcluded>New in v1.20…1
T.55                <RegionsExcluded>New in v1.20…1

M.1 Message detail

Sales or Sales tax report

Mandatory top-level (‘root’) element of message, either <SalesReport> or <SalesTaxReport>. In this version, the top-level element must carry the attribute version="1.2"

SalesReport version="1.2"
SalesTaxReport version="1.2"
1
Header Header ItemDetail ItemDetail Summary Summary

Message header detail

H.1 Header

Mandatory message header, containing information about the message itself and the organizations party to the reported transactions.

The same party name should only appear once as a party in accordance with the role they have in the reported transactions.

The list of parties in the <Header> must include one or two parties to whom the report is sent. The options are:

  • Publisher
  • Supplier
  • Receiving party
  • Receiving party plus either Publisher or Supplier

The list of parties must also include at least one party responsible for the sales reported:

Options for reseller model:

  • Seller
  • Seller plus Reporting party
  • Seller plus one or more Buying parties
  • Seller plus Reporting party, plus one or more Buying parties

Options for agency model:

  • Reporting party
  • Reporting party plus one or more Selling agent parties

Note that this requires agency sales and reseller sales to be reported in separate reports.

Header
1
SalesTaxReportType SalesTaxReportType Deprecated here SalesReportNumber SalesReportNumber IssueDateTime IssueDateTime ReferenceCoded ReferenceCoded PurposeCode PurposeCode SalesTaxReportType SalesTaxReportType SalesReportTypeCode SalesReportTypeCode ReportPriceType ReportPriceType or ReportPriceQualifierCode CurrencyCode CurrencyCode Deprecated CountryCode CountryCode Deprecated FromDate FromDate Deprecated ToDate ToDate Deprecated DateCoded DateCoded ClassOfSaleCode ClassOfSaleCode TradingZone TradingZone Deprecated Territory Territory Continued below Must not include both Must not include both Use only in sales report Must use one in sales tax report; must omit both from sales report
Continued from above SellerParty SellerParty PublisherParty PublisherParty SupplierParty SupplierParty BuyerParty BuyerParty ReportingParty ReportingParty ReceivingParty ReceivingParty SellingAgentParty SellingAgentParty Two or more parties must be included, in the specified combinations
H.2 Sales tax report type

Deprecated in this position in version 1.2 – instead, prefer  Sales tax report type that follows Purpose code. Mandatory in one or other position if the top level element is <SalesTaxReport>, but must be omitted if the top level element is <SalesReport>.

SalesTaxReportType
Must contain one of:
ForInformationThe message reports sales tax remitted by an agent on behalf of the publisher or supplier. No specific action is required
ForActionThe message reports sale tax due to be remitted by the publisher or supplier. Action is therefore necessary to comply with tax remittance requirements, dependent on tax jurisdiction
0…1
<SalesTaxReportType>ForAction</SalesTaxReportType>
H.3 Sales report number

Mandatory ordinal number within a sequence of reports between the sender and recipient of the message. Should enable a recipient to identify when a message has been missed.

SalesReportNumber
Normally an ordinal integer, but alphanumeric codes incorporating an ordinal integer are permitted
1
<SalesReportNumber>3456789</SalesReportNumber>
H.4 Issue date and time

Mandatory date, or date and time, at which the report was generated.

IssueDateTime
Must be one of the following, where Y, M, D, h, m and s are digits specifying the date (Gregorian calendar) and time (24-hour clock), T and Z represent themselves, and ± represents either a + or a - as appropriate for the timezone:
YYYYMMDDDate only
YYYYMMDDThhmmDate and time (local time of report sender, not recommended)
YYYYMMDDThhmmZDate and time (UTC/GMT) †
YYYYMMDDThhmm±hhmmDate and time (with timezone offset) †
YYYYMMDDThhmmssDate and time with seconds (not recommended)
YYYYMMDDThhmmssZDate and time with seconds (UTC/GMT)
YYYYMMDDThhmmss±hhmmDate and time with seconds (with timezone offset)
† indicates the preferred formats
1
<IssueDateTime>20180215T1330-0500</IssueDateTime>    (1:30pm on 15 Feb 2018, EST)
H.5 Document References

Optional document reference applying to all lines in the sales or sales tax report, and repeatable if more than one document reference applies to all lines. May be included in the <Header> only if each Document reference applies to all items reported. Alternatively, individual Document references may be supplied for each line item in the body of the message.

Each repeat of the <ReferenceCoded> composite must include a Reference type, plus a Reference number and/or a Reference date.

ReferenceCoded
0…n
ReferenceTypeCode ReferenceTypeCode ReferenceTypeName ReferenceTypeName ReferenceNumber ReferenceNumber ReferenceDate ReferenceDate ReferenceDateTime ReferenceDateTime Deprecated Must be included if and only if <ReferenceTypeCode> is proprietary Must not omit all three Must not include both
<ReferenceCoded>
    <ReferenceTypeCode>ContractReference</ReferenceTypeCode>
    <ReferenceNumber>FSA1003521</ReferenceNumber>
    <ReferenceDate>20170205</ReferenceDate>
</ReferenceCoded>
H.6 Reference type

The type of reference for the document relating to the report, mandatory in every <ReferenceCoded> composite.

ReferenceTypeCode
must contain one of the following:
ProprietaryA name must be supplied in <ReferenceTypeName>
ContractReference
StandingOrderReference
1
<ReferenceTypeCode>ContractReference</ReferenceTypeCode>
H.7 Reference name

A consistent and distinctive name for the type of document reference. Optional, but must be included in a <ReferenceCoded> composite if and only if <ReferenceTypeCode> is proprietary.

ReferenceTypeName
Variable length text, suggested maximum length 50 characters
0…1
<ReferenceTypeName>Consignment agreement</ReferenceTypeName>
H.8 Reference number

The alphanumeric reference number of the document. Optional, but must be included in every <ReferenceCoded> composite if <ReferenceDate> is omitted.

ReferenceNumber
Alphanumeric characters, suggested maximum length 36 characters
0…1
<ReferenceNumber>CA23456</ReferenceNumber>
H.9 Reference date

The date, or date and time, of the reference document. Optional, but must be included in every <ReferenceCoded> composite if <ReferenceNumber> is omitted.

ReferenceDate
As for <IssueDateTime>
0…1
<ReferenceDate>20170423</ReferenceDate>
H.10 Reference date and time

May not be included if <ReferenceDate> is used.

This element has been deprecated, but is maintained for backwards compatibility. Prefer <ReferenceDate>.

ReferenceDateTime
YYYYMMDDThhmmss
0…1
<ReferenceDateTime>20180815T104500</ReferenceDateTime>
End of Document references composite
H.11 Message purpose code

Mandatory code describing the function of the message.

If a duplicate message is sent – perhaps in response to a retransmission request after the recipient has identified that a message has been missed – the <SalesReportNumber> should remain the same as the original message.

PurposeCode
Must contain one of:
OriginalNew message sent for the first time
DuplicateCopy of a previously sent message. Should have the same report number as original.
ReplacementMessage sent as a replacement for a previously sent message. It must carry the same Sales report number as the one it replaces
TestMessage sent for test purposes only
1
<PurposeCoder>Original</PurposeCoder>
H.12 Sales tax report type

In principle, every Sales report or Sales tax report must contain one of either <SalesTaxReportType> or <SalesReportTypeCode>, depending on whether the top level element is <SalesTaxReport> or <SalesReport> – although in practice, <SalesReportTypeCode> may occasionally be omitted from Sales reports.

<SalesTaxReportType> specifies whether the message reports tax remitted, or tax due to be remitted. It is mandatory in <Header> if the top level element is <SalesTaxReport> – but it may occur either here or at H.2. <SalesTaxReportType> must be omitted if the top level element is <SalesReport>.

SalesTaxReportType
Must contain one of:
ForInformationThe message reports sales tax remitted by an agent on behalf of the publisher or supplier. No specific action is required
ForActionThe message reports sale tax due to be remitted by the publisher or supplier. Action is therefore necessary to comply with tax remittance requirements, dependent on tax jurisdiction
0…1
<SalesTaxReportType>ForAction</SalesTaxReportType>
H.13 Sales report type

<SalesReportTypeCode> is normally included in Sales report messages, with the top level element <SalesReport>. It specifies whether the Sales report is organized one transaction per line or as transactions aggregated by product, one product per line.

in Sales reports, <SalesReportTypeCode> may be omitted by agreement between the parties. It is never used in Sales tax report messages with the top level element <SalesTaxReport>, which must be organized one transaction per line.

SalesReportTypeCode
Must contain one of:
ByTransactionFull detail, one transaction per line
ByProductModerate detail, one or more transactions per line, with transactions aggregated by product and optionally by price point, class of trade or other differentiators
0…1
<SalesReportTypeCode>ByTransaction</SalesReportTypeCode>
H.14 Report price type

Every price in the report must be qualified with a price type. If every line in the report has the same price type, it may be specified either here in the Header, or on each line. If the Price type varies on different lines of the report, it must be specified on each line and omitted from the Header.

Note that if used in the Header, this is not a ‘default’ that may be selectively overridden at line item level. The price type must be included either once, here, or on every line in the report – never both.

To avoid any ambiguity, it is good practice to include a Price type on every line of the report using Price Type and Price Qualifier , and to not send a Price type in the Header.

ReportPriceType
ReportPriceQualifierCode
Must contain one of:
SRPExcludingTaxSuggested retail price excluding tax – use when the buy price is calculated by discounting from a suggested or recommended retail price
SRPIncludingTaxSuggested retail price including tax
FixedRPExcludingTaxFixed retail price excluding tax – use when the buy price is calculated by discounting from a fixed retail price
FixedRPIncludingTaxFixed retail price including tax
UnitCostExcludingTaxUnit cost excluding tax – use when the buy price is a unit cost, net price or wholesale price, with or without further discount (eg based on volume)
UnitCostIncludingTaxUnit cost including tax
PublisherRPExcludingTaxPublisher’s retail price excluding – used when products are sold under the ‘agency model’
PublisherRPIncludingTaxPublisher’s retail price including tax
SoldAtPriceExcludingTaxActual price per unit, net of any discount to the buyer but excluding tax (ASP)
SoldAtPriceIncludingTaxActual price per unit, including tax and net of any discount to the buyer(ASP)
0…1
<ReportPriceType>FixedRPExcludingTax</ReportPriceType>
H.15 Default currency code

The default currency used for prices and other monetary amounts in the message, when the currency is not specified. Should be omitted if all prices are qualified with an individual <CurrencyCode>.

It is best practice to omit this element and to specify the currency within each <Price> composite and for each Monetary amount. Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format.

CurrencyCode
Fixed-length code consisting of three upper case letters from ONIX Codelist 96 (based on ISO 4217)
0…1
<CurrencyCode>EUR</CurrencyCode>Euros
H.16 Default country code

If the default currency in <CurrencyCode> is legal tender in more than one country, used to indicate the price details are by default specific to a particular country. Must be omitted if no default <CurrencyCode> is specified, or if prices denominated in the default currency apply wherever the that currency is legal tender.

It is best practice to omit this element and to specify the currency and country within each <Price> composite and for each Monetary amount. Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
0…1
H.17 Reporting period from date

The start of the period to which the report applies.

Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format. The preferred method for specifying the reporting period is to use <DateCoded>.

FromDate
See <IssueDateTime> for allowed formats
0…1
H.18 Reporting period to date

The end of the period to which the report applies. All dates are inclusive.

Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format. The preferred method for specifying the reporting period is to use <DateCoded>.

ToDate
See <IssueDateTime> for allowed formats
0…1
H.19 Sales report date

Every Sales report and Sales tax report must specify a reporting period. If – as would normally be the case – all <ItemDetail> composites (individual report lines) are based on the same reporting period, then the reporting period may be specified either here in the Header using <DateCoded> or by using <DateCoded> individually for every line item in the report (see Date and time of transaction). If for any reason the reporting period for individual report lines varies, then the reporting period must be specified individually within every <ItemDetail> composite, and <DateCoded> must be omitted from the Header.

If the reporting period is defined in the Header, it must contain either a single report date – ie one <DateCoded> composite with <DateQualifierCode> SalesDate – or a report period defined by two <DateCoded> composites using <DateQualifierCode> SalesPeriodStart and SalesPeriodEnd. <DateCoded> is thus repeatable up to two times.

Note that these are not ‘default’ dates that may be selectively overridden at line item level.

Note also that start and end dates can be simple dates, or can specify an exact time. Simple dates should be interpreted as ‘start of business day’ (for period start dates) or ‘end of business day’ (for period end dates or points in time).

DateCoded
0…2
Date Date DateQualifierCode DateQualifierCode
<DateCoded>
    <Date>20180621T1100Z</Date>
    <DateQualifierCode>SalesPeriodStart</DateCoded>
</DateCoded>
H.20 Date

A date, including an optional time, associated with the reporting period for the entire report, mandatory within each <DateCoded> composite.

Date
As for <IssueDateTime>
1
<Date>20170423</Date>    (23 April 2017)
H.21 Date qualifier

The nature of the date in <Date> element, mandatory within each <DateCoded> composite.

DateQualifierCode
Must contain one of the following:
SalesPeriodStartStart date of reporting period (should have a corresponding end date/time)
SalesPeriodEndEnd date of reporting period (all dates are inclusive)
SalesDateDate for which sales or sales tax are reported (where the reporting period is a single day). Use this value if reporting sales on a specific calendar day (ie 00:00:00 to 23:59:59 in the local timezone on a specific day).
1
<DateQualifierCode>SalesPeriodEnd</DateQualifierCode>
End of Sales report date composite
H.22 Report class of sale

Optional class of sale applying to all of the sales in the report, and repeatable if more than one class of sale applies to all sales in the report.

This can be included in the Header only if each class of sale applies to all sales in the message. If there are different types of class of sales applying to different transactions within the report, then use <ClassOfSale> within <ItemDetail> composite. Note that this is not a ‘default’ class of sale that can be selectively overridden at line item level.

Within the Header, this is used mainly to indicate whether the reported sales are under reseller (wholesale, retail, export etc) or agency terms.

ClassOfSaleCode
Must contain one of the following:
00Unspecified
01Agency
02Wholesale
03Retail
04Export
05Publisher-internal
06Review copies
07Printed
08Digital
20–99codes defined by trading partner agreement
0…n
<ClassOfSaleCode>03</ClassOfSaleCode>    (Retail)
H.23 Report trading zone

Every Sales report and Sales tax report must specify the market – the Trading zone or Trading territory – within which the reported sales were, or could have been, made. If all <ItemDetail> composites (individual report lines) are based on the same Trading zone or territory, then the Trading zone may be specified using <TradingZone> or <Territory> either here in the Header or individually for every line item in the report (see Line trading zone and  Line trading territory). If for any reason the Trading zone or territory for individual report lines varies, then the Trading zone or territory must be specified individually within every <ItemDetail> composite, and <TradingZone> and <Territory> must be omitted from the Header.

A trading zone or market comprises one or more countries and sub-national regions, or the entire world. Note that in <TradingZone>, only additive combination is allowed – sales in the ‘48 contiguous states’ must specify 48 individual Region codes, not ‘USA minus two states’. Use of <Territory> may be more succinct, as it enables both additive and subtractive combination. The preferred method for specifying the market covered by the report is to use <Territory> in the Header or <Territory> within the <ItemDetail> composite . Use of <TradingZone> element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format.

Note that this is not a ‘default’ Trading zone that may be selectively overridden at line item level.

TradingZone
One or more variable-length alphanumeric codes from List 91 (based on ISO 3166-1) or List 49 (based on ISO 3166-2). Successive codes are separated by a space
0…1
<TradingZone>FR-H</TradingZone>    (Corsica)
H.24 Report trading territory

Every Sales report and Sales tax report must specify the market – the Trading zone or Trading territory – within which the reported sales were, or could have been, made. This is the area that the report covers, even if no sales are reported on this occasion in some of the countries or regions specified in the market. This area may be the same as the country or region associated with each transaction or maybe a larger area of which each region or country or territory associated with a transaction is a sub-set. The market may be specified using either Trading zone or Trading territory, but the latter is preferred.

If all <ItemDetail> composites (individual report lines) are based on the same Trading territory, then the Trading territory may be specified using <Territory> either here in the Header or individually for every line item in the report. If for any reason the Trading territory for individual report lines varies, then the Trading territory must be specified individually within every <ItemDetail> composite, and therefore must be omitted from the Header.

Note that this is not a ‘default’ Trading territory that may be selectively overridden at line item level: it must be present either here or in each report line, but never in both.

A trading territory comprises one or more countries and sub-national regions, or the entire world. It can be the WORLD excluding certain countries and / or sub-national regions or countries excluding certain sub-national regions.

Territory
0…1
CountriesIncluded CountriesIncluded RegionsIncluded RegionsIncluded RegionsExcluded RegionsExcluded RegionsIncluded RegionsIncluded CountriesExcluded CountriesExcluded RegionsExcluded RegionsExcluded must be WORLD here. Other <Regions…> tags must NOT use WORLD
The territory covered by the report is the 48 contiguous states of the USA
<Territory>
    <CountriesIncluded>USA</CountriesIncluded>
    <RegionsExcluded>US-AK US-HI</RegionsExcluded>
</Territory>
The territory covered by the report is metropolitan France excluding Corsica
<Territory>
    <CountriesIncluded>FR</CountriesIncluded>
    <RegionsExcluded>FR-H</RegionsExcluded>
</Territory>
The territory covered by the report is all the countries using the Euro
<Territory>
    <CountriesIncluded>AD AT BE CY DE EE ES FI FR GR IE IT LT LU LV MC MT NL PT SI SK SM VA</CountriesIncluded>
</Territory>
Note the nesting of countries and sub-national regions within the <Territory> composite. Do not exclude smaller geographical areas that have not been included as part of a larger geographical unit. The trading territory specified apply within the shaded area. Supra-national regions that are included (WORLD) may have both countries and regions excluded: Supra-national Regions included Countries excluded Countries included Sub-national Regions excluded Sub-national Regions included The only supra-national region that may be used is WORLD.
H.25 Countries included

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesIncluded
One or more codes, each of two upper-case letters, from ONIX Codelist 91, successive codes being separated by a space
0…1
<CountriesIncluded>US CA</CountriesIncluded>    (USA and Canada)
H.26 Regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Arkansas, Brussels. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

RegionsIncluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
<RegionsIncluded0>GB-SCT GB-WLS</RegionsIncluded>    (Scotland and Wales)
H.27 Countries excluded

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesExcluded
One or more codes, each of two upper-case letters, from ONIX Codelist 91, successive codes being separated by a space
0…1
<CountriesExcluded>US CA</CountriesExcluded>    (excludes USA and Canada)
H.28 Regions excluded

One or more ONIX codes identifying regions excluded from the territory. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

RegionsExcluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
<RegionsExcluded>FR-H</RegionsExcluded>    (excludes Corsica)
End of Territory composite
H.29 Seller Party

Composite containing details of the organization that is reporting sales.

Mandatory if reporting sales under wholesale terms, in which case the Seller party is the reseller. Not used if reporting sales under agency terms, when Reporting party or Selling agent party should be used instead.

See Header for a full list of possible combinations of parties that may be used.

Within <SellerParty>, either <PartyIdentifier> or <PartyName> is mandatory. Either one is normally sufficient, though it is good practice to supply both, and a standard party identifier helps with disambiguation. All other elements are optional.

SellerParty
0…1
PartyIdentifier PartyIdentifier or PartyID AdditionalPartyIdentifier AdditionalPartyIdentifier or AdditionalPartyID PartyName PartyName PostalAddress PostalAddress CommunicationDetails CommunicationDetails ContactPerson ContactPerson CountryCode CountryCode RegionCode RegionCode tag name aliases <PartyID> and <AdditionalPartyID> can be used for compatibility with previous versions of the report Must not omit both Must not include both
All Party composites – <PublisherParty>, <ReportingParty> and so on – share the same structure as <SellerParty>
H.30 Party identifier

Composite element containing the primary standard identifier for the organization. It must contain both a <PartyIDType> and an <IDValue>.

Note that <PartyIdentifier> is not repeatable – if there is more than one identifier for the organization, then the second and subsequent identifiers must use <AdditionalPartyIdentifier>.

PartyIdentifier
PartyID
0…1
PartyIDType PartyIDType IDTypeName IDTypeName IDValue IDValue or Identifier Must be included if and only if <PartyIDType> is proprietary
H.31 Party identifier type

The type of the primary identifier used to identify the organization.

PartyIDType
Must contain one of:
A two-digit code fromONIX Codelist 44
ProprietaryProprietary identifier scheme, which must be given a scheme name in <IDTypeName>
GLNGlobal Location Number (13-digits)
SANBook trade Standard Address Number (7-digits)
VKNRBörsenverein Verkehrsnummer
NBSNNorwegian Bookstore Number
NNSRNorwegian National School Registry number
NONNorwegian Organization Number
BAGNRBuchhändler-Abrechnungs-Gesellschaft
PublishersAccountNumberPublisher’s account number for the seller
SellersAccountNumberThe account number with the organization receiving the report
TaxRegistrationNumberSales tax registration number
VATRegistrationNumberTwo-letter ISO 3166-1 alpha-2 country code from Codelist 91 followed by the 8–12 alphanumeric characters of the national VAT ID. Omit any spaces and hyphens
1
<PartyIDType>06</PartyIDType>    GLN
H.32 Identifier type name

A consistent and distinctive name for a proprietary identifier scheme. Must be used if, and only if, <PartyIDType> is proprietary.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
<IDTypeName>BigPublisher Customer ID</IDTypeName>
H.33 Identifier value

The primary identifier used to identify the party.

IDValue
Identifier
Alphanumeric characters according to the identifier type specified in <PartyIDType>
1
<IDValue>3012262710000</IDValue>
End of Party identifier composite
H.34 Additional party identifier

Composite element containing an alternative standard identifier for the organization. Optional, and repeatable where the organization is identifiable with more than two types of identifier. If used, it must contain both a <PartyIDType> and an <IDValue>.

AdditionalPartyIdentifier
AdditionalPartyID
0…n
Identical to <Party identifier>
H.35 Party identifier type

The type of the identifier used to identify the party.

PartyIDType
Must contain one of:
A two-digit code fromONIX Codelist 44
ProprietaryProprietary identifier scheme, which must be given a scheme name in <IDTypeName>
GLNGlobal Location Number (13-digits)
SANBook trade Standard Address Number (7-digits)
VKNRBörsenverein Verkehrsnummer
NBSNNorwegian Bookstore Number
NNSRNorwegian National School Registry number
NONNorwegian Organization Number
BAGNRBuchhändler-Abrechnungs-Gesellschaft
PublishersAccountNumberPublisher’s account number for the seller
SellersAccountNumberThe account number with the organization receiving the report
TaxRegistrationNumberSales tax registration number
VATRegistrationNumberTwo-letter ISO 3166-1 alpha-2 country code from Codelist 91 followed by the 8–12 alphanumeric characters of the national VAT ID. Omit any spaces and hyphens
1
<PartyIDType>Proprietary</PartyIDType>
H.36 Identifier type name

A consistent and distinctive name for a proprietary identifier scheme. Must be used when, and only when, <PartyIDType> is Proprietary.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
<IDTypeName>BigPublisher Customer ID</IDTypeName>
H.37 Identifier value

The identifier used to identify the party.

IDValue
Identifier
Alphanumeric characters according to the identifier type specified in <PartyIDType>
1
<IDValue>3012262710000</IDValue>
End of Additional party identifier composite
H.38 Party name

The organization name. Although optional, it is good practice to include a consistent name, which comprises one or more lines of text.

PartyName
0…1
NameLine NameLine
<PartyName>
    <NameLine>Main Street Bookstores Inc</NameLine>
    <NameLine>Narragansett Branch</NameLine
</PartyName>
H.39 Line of party name

Single line of the organization name. Every party name must include at least one <NameLine>.

NameLine
Variable length text, suggested maximum length 100 characters
1…n
<NameLine>Big Euro Bookshop</NameLine>
End of Party name composite
H.40 Postal address

The full postal address of the organization. Optional. When used, it must contain at least one <AddressLine>.

PostalAddress
0…1
NameLine AddressLine
<PostalAddress>
    <AddressLine>Main Street Bookstore</AddressLine>
    <AddressLine>60 Pier Market Place</AddressLine>
    <AddressLine>Narragansett, RI 02882</AddressLine>
</PostalAddress>
H.41 Address line

A single line of the street address of the organization. Repeatable where there are multiple lines in the address.

AddressLine
Variable length text, suggested maximum length 100 characters
1…n
<AddressLine>145 Main Road, Blandsville</AddressLine>
End of Postal address composite
H.42 Communication details

Optional contact details for the organization as a whole. Repeatable where different types of communication are specified.

CommunicationDetails
0…n
CommunicationTypeCode CommunicationTypeCode CommunicationLocator CommunicationLocator
<CommunicationDetails>
    <CommunicationTypeCode>Email</CommunicationTypeCode>
    <CommunicationLocator>info@mainstreetbookstores.com</CommunicationLocator>
</CommunicationDetails>
H.43 Communication type code

The type of communication method, mandatory within every instance of <CommunicationDetails>.

CommunicationTypeCode
Must contain one of:
FixedPhoneLandline
MobilePhoneCellphone
PhonePhone number, landline or cellphone
Fax
Email
URLEg of a web page with a contact form
1
<CommunicationTypeCode>Email</CommunicationTypeCode>
H.44 Communication locator

Free text giving details for the specified communication method, mandatory within every instance of <CommunicationDetails>.

CommunicationLocator
Alphanumeric characters according to the specified <CommuniationTypeCode>, for example:
+44 20 7503 6418Phone number (including the country prefix)
info@editeur.orgE-mail address
https://www.editeur.org/42/Contact/URL for web-based contact form
1
<CommunicationLocator>info@mainstreetbookstores.com</CommunicationLocator>
End of Communication details composite
H.45 Contact person

Optional contact details for an individual within the organization. When used, it must contain at least a <PersonName> element. Repeatable where different people are specified.

ContactPerson
0…n
ContactRoleCode ContactRoleCode PersonName PersonName CommunicationDetails CommunicationDetails
<ContactPerson>
    <ContactRoleCode>00</ContactRoleCode>
    <PersonName>Jackie Brown</PersonName>
    <CommunicationDetail>
        <CommunicationTypeCode>Email</CommunicationTypeCode>
        <CommunicationLocator>+44 20 7946 0921</CommunicationLocator>
    </CommunicationDetail>
</ContactPerson>
H.46 Contact role code

Optional job role of the person within the organization.

ContactRoleCode
two-digit code from ONIX Codelist 198
0…1
<ContactRoleCode>00</ContactRoleCode>    Metadata contact
H.47 Personal name

Mandatory name of a person within the organization.

PersonName
Variable length text, suggested maximum 100 characters
1
<PersonName>William Smith</PersonName>
H.48–H.50 Personal communication details

Optional contact details for the individual within the organization, as distinct from the contact details of the organization as a whole. The structure of the <CommunicationDetails> composite for a person is identical to that for an organization. Repeatable where different types of communication are specified.

CommunicationDetails
0…n
Identical to CommunicationDetails
End of Personal communication details composite
End of Contact person composite
H.51 Seller party country code

Country where the organization is located – optional, but one of either Country code or Region code must be specified when needed for tax purposes.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
0…1
<CountryCode>US</CountryCode>    USA
H.52 Seller party region code

Region where the organization is located – optional, but one of either Country code or Region code must be specified when needed for tax purposes.

RegionCode
Variable-length alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
<RegionCode>BE-VLG</RegionCode>    Flemish region of Belgium
End of Seller party composite
H.53–H.76 Publisher party

Composite containing details of the publisher or the content owner to whom the sales report is being made.

Either this element or Supplier Party or Receiving Party must be included in each sales report. See Header for use of different types of party.

The structure of the <PublisherParty> composite is identical to that of <SellerParty>.

PublisherParty
0…1
Identical to <SellerParty>.
End of Publisher party composite
H.77–H.100 Supplier party

Composite containing details of the supplier organization (other than the Publisher or content owner) to whom the report is being made.

Either this element or Publisher Party or Receiving Party must be included in each sales report. See Header for use of different types of party.

The structure of the <SupplierParty> composite is identical to that of <SellerParty>.

SupplierParty
0…1
Identical to <SellerParty>
End of Supplier party composite
H.101–H.124 Buyer party

Composite containing details of the wholesale buyer of the products whose sale is being reported. This maybe the same as the Seller Party.

This is only used when reporting sales under wholesale terms, see Header for use of different types of party.

The structure of the <BuyerParty> composite is identical to that of <SellerParty>.

BuyerParty
0…1
Identical to <SellerParty>
End of Buyer party composite
H.125–H.148 Reporting party

Composite containing details of the reporting organization of the Sales report. When reporting sales under wholesale terms this element may be the same as either the seller party or buyer party.

When reporting sales under agency terms this element should be present.

When reporting other class of sale types or a mixture of these then one of Seller Party, Buyer Party, Reporting Party or Selling Agent Party must be present, see Header for use of different types of party.

The structure of the <ReportingParty> composite is identical to that of <SellerParty>.

ReportingParty
0…1
Identical to <SellerParty>
End of Reporting party composite
H.149–H.172 Receiving party

Composite containing details of the party receiving the report. Used when reporting sales under agency terms, especially when reporting sales of products sold on behalf of several publishers or suppliers, see Header for use of different types of party.

The structure of the <ReceivingParty> composite is identical to that of <SellerParty>.

ReceivingParty
0…1
Identical to <SellerParty>
End of Receiving party composite
H.173–H.196 Selling agent party

Composite containing details of the selling agent or sub-agent organization. Used when an intermediary is reporting sales under agency terms by specific sub-agents.

This composite is repeatable if the sales report concerns more than one sub-agent, see Header for use of different types of party.

The structure of the <SellingAgentParty> composite is identical to that of <SellerParty>.

SellingAgentParty
0…n
Identical to <SellerParty>
End of Selling agent party composite

End of Header

Message body detail

B.1 Item detail

Messages must contain one <ItemDetail> composite for each product or transaction reported on.

The <ItemDetail> composite consists of a mandatory ordinal Line Number within the report followed by the other relevant elements.

ItemDetail
1…n
ItemNumber ItemNumber ProductIdentifier ProductIdentifier or ProductID ItemDescription ItemDescription PublisherDetail PublisherDetail ImprintDetail ImprintDetail ProductFormat ProductFormat EpubTechnicalProtection EpubTechnicalProtection EpubUsageConstraint EpubUsageConstraint EpubLicense EpubLicense PriceCondition PriceCondition DeviceType DeviceType Deprecated Quantity Quantity GrossSoldQuantity GrossSoldQuantity RefundedQuantity RefundedQuantity NetSoldQuantity NetSoldQuantity NonSaleDisposal NonSaleDisposal ReferenceCoded ReferenceCoded Continued below Omit only when reporting Sales tax by Product format Use only for reseller model Use only for agency model
Continued from above ShipToParty ShipToParty ShipTolocation ShipToLocation BillToParty BillToParty BillTolocation BillToLocation DateCoded DateCoded Deprecated Date Date PricingDetail PricingDetail LineSalesAmounts LineSalesAmounts SellingAgentParty SellingAgentParty RetailerParty RetailerParty TradingZone TradingZone Territory Territory Must not use both Must not use both
B.2 Line item number

A mandatory sequence number starting at 1 in each message.

LineNumber
Positive integer
1
<LineNumber>1</LineNumber>
B.3 Product identifier

One or more identifiers for the product. Mandatory in Sales reports. It may be omitted from Sales Tax report if reporting tax on transactions by format and not by individual product. Repeatable if the product may be identified by two or more identifiers.

Each <ProductIdentifier> composite must contain one identifier type and one identifier. In addition, it must contain an <IDTypeName> when (and only when) the Product identifier type is proprietary.

ProductIdentifier
ProductID
1…n in Sales reports, 0…n in Sales tax reports
ProductIDType ProductIDType IDTypeName IDTypeName IDValue IDValue or Identifier Must be included if and only if <ProductIDType> is proprietary
<ProductIdentifier>
    <ProductIDType>15</ProductIDType>
    <IDValue>9780001234567</IDValue>
</ProductIdentifier>
B.4 Product identifier type

Specifies the type of identifier used for the product.

ProductIDType
Must contain one of:
A value from List 5Two-digit code from ONIX Codelist 5
Proprietaryuse for a third-party proprietary ID scheme, which must be named in <IDTypeName>
ISBNuse only for a 10-character ISBN
EAN13use for a 13-digit ISBN, ISMN or any other GTIN-13
UPCuse for an item-specific UPC-12
ISMNuse only for a 10-character ISMN
GTIN14use only for a 14-digit GTIN
SKUStock Keeping Unit – a number assigned to a product by the company for stock-keeping purposes and internal operations
Selleruse for a supplier-defined product ID
Buyeruse for a customer-defined product ID
1
<ProductIDType>EAN13</ProductIDType>
B.5 Identifier type name

A distinctive and consistent name for a proprietary product identifier. Mandatory if <ProductIDType> is proprietary, and omitted for any other value of <ProductIDType>.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
<IDTypeName>Online Bookstore Item no</IDTypeName>
B.6 Identifier

An identifier of the type specified in <ProductIDType>.

IDValue
Identifier
Alphanumeric characters according to the identifier type specified in <ProductIDType>.
1
<Identifier>9780300117264</Identifier>
Spaces and hyphens are omitted from ISBNs, ISMNs, EANs, UPCs, GTINs
End of Product identifier composite
B.7 Item description

Optional basic bibliographic description of the product. If provided, this is intended primarily for confirmation of the identity of a product.

<ItemDescription> must include a title for the product, either in the <TitleDetail> or the <Title> element.

ItemDescription
0…1
TitleDetail TitleDetail Title Title Contributor Contributor or Author OtherDetail OtherDetail ProductClassification ProductClassification or ClassificationCoded
<ItemDescription>
    <Title>Anne of Green Gables</Title>
    <Contributor>Lucy Maud Montgomery</Contributor>
    <OtherDetail>Illustrated edition</OtherDetail>
</ItemDescription>
B.8 Title detail

Text combining title and other elements such as a collection or series title, subtitle, edition or binding into a single element. This is the equivalent of a Distributor’s title in ONIX for Books, and for legacy (and system dependent) reasons is often limited to a very small number of characters (for example 32, to ensure the title fits on a single line of printed invoices). Optional within <ItemDescription>, but must be included when <Title> is omitted.

TitleDetail
Variable length text, suggested maximum length 50 characters
0…1
<TitleDetail>Gd Metadata Bgnnrs JE Smith PBK</TitleDetail>
B.9 Title

The main distinctive Title of the book. Optional within <ItemDescription>, but must be included when <TitleDetail> is omitted. Do not include other elements such as subtitle, edition or binding, and only include text from a collection or series title if necessary to ensure the title is distinctive enough for clear identification.

Title
Variable length text, suggested maximum length 100 characters
0…1
<Title>Good Metadata for Beginners</Title>
B.10 Contributor

Name for an author or other contributor to the product. Optional within <ItemDetail>, and may only be used if <Title> is present. Repeatable in order to name multiple contributors.

Contributor
Author
Variable length text, suggested maximum length 100 characters
0…n
<Contributor>Joseph E. Smith</Contributor>
B.11 Other detail

Optional further details such as edition information, that might be useful to confirm the identity of the product.

OtherDetail
Variable length text, suggested maximum length 100 characters
0…1
<OtherDetail>Red cover version</OtherDetail>
B.12 Product classification

A repeatable group of data elements which together define a product classification (not to be confused with a subject classification). The intended use is to enable national or international trade classifications (also known as commodity codes) to be carried in an EDItX record. Optional, and repeatable if the product consists of multiple components with different commodity codes.

ProductClassification
ClassificationCoded
0…n
ProductClassificationType ProductClassificationType or ClassificationCodeType ProductClassificationCode ProductClassificationCode or ClassificationCode Percent Percent Omit unless the product consists of multiple components with differing commodity codes
B.13 Product classification type

A code identifying the scheme from which the identifier in <ClassificationCode> is taken. Mandatory in each occurrence of the <ClassificationCoded> composite, and non-repeating.

ProductClassificationType
ClassificationCodeType
Fixed-length two-digit code from ONIX Codelist 9
1
<ClassificationCodeType>05</ClassificationCodeType>    EU TARIC code
B.14 Product classification code

A classification code from the scheme specified in <ClassificationCodeType>. Mandatory in each occurrence of the <ClassificationCoded> composite, and non-repeating.

ProductClassificationCode
ClassificationCode
Alphanumeric according to the identifier type specified in <ClassificationCodeType>
1
<ClassificationCode>49019900</ClassificationCode>    EU TARIC code for printed books
B.15 Percentage

The percentage of the unit value of the whole product that is assignable to a designated product classification. Optional and non-repeating. Used when a mixed product (eg book and CD) belongs partly to two or more product classifications. If omitted, the product classification code applies to 100% of the product.

Percent
Real number between zero and 100 (inclusive), with explicit decimal point when required, suggested maximum length 7 characters
0…1
<Percent>66.67</Percent>
End of Product classification composite
End of Item description composite
B.16 Publisher detail

Optional information about the publisher, which may be included when reporting sales of products from more than one publisher.

When used, the <PublisherDetail> composite must contain either <PublisherIdentifier> for the publisher, or <PublisherName> of the publishing organization, or both. It is good practice to include a standard identifier for the publisher to make it easier to correctly identify the publisher even if there is a variation in spelling of the name.

PublisherDetail
0…1
PublisherIdentifier PublisherIdentifier or PublisherID PublisherName PublisherName Must not omit both
B.17 Publisher identifier

Composite containing an identifier for the publisher. Repeatable if there is more than one identifier for the publisher.

PublisherIdentifier
PublisherID
0…n
PublisherIDType PublisherIDType IDTypeName IDTypeName IDValue IDValue or Identifier Must be included if and only if <PublisherIDType> is proprietary
B.18 Publisher identifier type

A code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <PublisherIdentifier> composite.

PublisherIDType
Alphanumeric code
Must contain one of:
Value from Two-digit code from ONIX Codelist 44
GLNGlobal Location Number (13-digits)
SANBook trade Standard Address Number (7-digits)
Proprietaryuse for a third-party ID scheme, which must be named in the <IDTypeName>
1
<PublisherIDType>16</PublisherIDType> ISNI
B.19 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <PublisherIDType> element indicates a proprietary scheme. Optional and non-repeating.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
B.20 Identifier value

A code value taken from the scheme specified in the <PublisherIDType>.> element. Mandatory in each occurrence of the <PublisherIdentifier> composite, and non-repeating.

IDValue
Identifier
Alphanumeric characters according to the identifier type specified <PublisherIDType>
1
<IDValue>0000000110880337</IDValue>
End of Publisher identifier composite
B.21 Publisher name

The name of an entity associated with the publishing of a product referenced in the sales report <ItemDetail>. Mandatory if there is no publisher identifier in an occurrence of the <PublisherDetail> composite, and optional if a publisher identifier is included. Non-repeating.

PublisherName
Variable length text, suggested maximum length 100 characters
0…1
<PublisherName>Cambridge University Press</PublisherName>
End of Publisher detail composite
B.22 Imprint detail

Optional information about the imprint or brand used by the publisher, which may be included when reporting sales of products from more than one imprint.

When used, the <ImprintDetail> composite must contain either <ImprintIdentifier> for the imprint, or <ImprintName> of the imprint or brand, or both.

ImprintDetail
0…1
ImprintIdentifier ImprintIdentifier or ImprintID ImprintName ImprintName Must not omit both
B.23 Imprint identifier

Composite containing an identifier for the imprint or brand. Repeatable if there is more than one identifier for the imprint or brand.

ImprintIdentifier
ImprintID
0…n
ImprintIDType ImprintIDType IDTypeName IDTypeName IDValue IDValue or Identifier Must be included if and only if <ImprintIDType> is proprietary
B.24 Imprint identifier type

A code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <ImprintIdentifier> composite.

ImprintIDType
two-digit numeric code from ONIX Codelist 44
1
<ImprintIDType>16</ImprintIDType>ISNI
B.25 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <ImprintIDType> element indicates a proprietary scheme. Optional and non-repeating.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
B.26 Identifier value

A code value taken from the scheme specified in the <ImprintIDType> element. Mandatory in each occurrence of the <ImprintIdentifier> composite, and non-repeating.

IDValue
Identifier
Alphanumeric characters according to the identifier type specified in <ImprintIDType>
1
<IDValue>0000000110880337</IDValue>
End of Imprint identifier composite
B.27 Imprint name

The name of an imprint or brand under which the product is issued, as it appears on the product. Mandatory if there is no imprint identifier in an occurrence of the <ImprintDetail> composite, and optional if an imprint identifier is included. Non-repeating.

ImprintName
Variable length text, suggested maximum length 100 characters
0…1
<ImprintName>Michael Joseph</ImprintName>
End of Imprint detail composite
B.28 Product format

One or more codes specifying the physical or digital nature of the product, used primarily to confirm the identity of the product. Optional, but should be treated as mandatory if a single product identifier applies to multiple digital formats (which is not viewed as good practice). In this case, the line item must relate to the transaction of the product in a single format only.

Repeatable in order to deliver both a Product form code and one or more Product form detail.

FormatCode
Two letter code from ONIX Codelist 150 or
Alphanumeric code from ONIX Codelist 175
0…n
<FormatCode>ED</FormatCode>
<FormatCode>E101</FormatCode>
    (EPUB)
B.29 Digital product technical protection

A code specifying whether a digital product has DRM or other technical protection features that form or enforce part of the commercial offer for a product. Optional, and repeatable if a product has two or more kinds of protection.

Use when indicating the transaction or product in the <ItemDetail> refers to a product with a particular DRM and there is a need to distinguish between the same product sold with different DRM.

EpubTechnicalProtection
two-digit numeric code from ONIX Codelist 144
0…n
<EpubTechnicalProtection>03</EpubTechnicalProtection>    (Has digital watermarking)
‘Epub’ (‘e-publication’) here and in other element names below refers to any digital product, and has no necessary link with the .epub file format originally developed by the IDPF
B.30 Usage constraint composite (digital products)

An optional and repeatable group of data elements which together describe a contractual term or constraint (or the absence of such a constraint) that forms part of the commercial offer for a product.

The EDItX Epub usage constraint composite has the same structure as both <EpubUsageConstraint> and <PriceConstraint> in ONIX for Books, and is used where a single product is available under multiple terms and conditions (ie multiple commercial offers for the same product which differ in their Price constraints, and whether or not those constraints are enforced by DRM). In effect, in EDItX, <EpubUsageConstraint> combines both sets of ONIX constraints into a single set of effective constraints, and product sales which share the same ONIX constraints at product level but differ in their ONIX constraints at price level are necessarily reported on separate Sales report lines. Use when indicating the transaction or product in the <ItemDetail> refers to a product with a particular set of constraints.

EpubUsageConstraint
0…n
EpubUsageType EpubUsageType EpubUsageStatus EpubUsageStatus EpubUsageLimit EpubUsageLimit
multi-user educational software
<EpubUsageConstraint>
    <EpubUsageType>09</EpubUsageType>
    <EpubUsageStatus>02</EpubUsageStatus>
    <EpubUsageLimit>
        <Quantity>30</Quantity>
        <EpubUsageUnit>07</EpubUsageUnit>
    </EpubUsageLimit>
</EpubUsageConstraint>
B.31 Usage type (digital products)

A code specifying a type of commercial term or constraint forming part of the commercial offer for a digital product. Mandatory in each occurrence of the <EpubUsageConstraint> composite, and non-repeating.

EpubUsageType
two-digit numeric code from ONIX Codelist 230
1
<EpubUsageType>06</EpubUsageType>    (lend to library patrons)
B.32 Usage status (digital products)

A code specifying the status of a contractual term or constraint, eg permitted without limit, permitted with limit, prohibited. Mandatory in each occurrence of the <EpubUsageConstraint> composite, and non-repeating.

EpubUsageStatus
two-digit numeric code from ONIX Codelist 146
1
<EpubUsageStatus>02</EpubUsageStatus>    (Allowed with limits)
B.33 Usage limit composite (digital products)

An optional and repeatable group of data elements which together specify a quantitative limit on a particular type of contractual term or constraint.

EpubUsageLimit
0…n
Quantity Quantity EpubUsageUnit EpubUsageUnit
B.34 Usage quantity (digital products)

A numeric value representing the maximum permitted quantity or limit of a particular type of constraint. Mandatory in each occurrence of the <EpubUsageLimit> composite, and non-repeating.

Positive real number, with explicit decimal point when required, or zero, as appropriate for the units specified in <EpubUsageUnit>
Quantity
1
<Quantity>2</Quantity>
B.35 Usage unit (digital products)

A code for a unit in which a maximum permitted quantity or limit is stated. Mandatory in each occurrence of the <EpubUsageLimit> composite, and non-repeating.

EpubUsageUnit
two-digit numeric code from ONIX Codelist 147
1
<EpubUsageUnit>07</EpubUsageUnit>    (Concurrent users)
End of usage limit composite
End of usage composite
B.36 Digital product license composite

An optional and non-repeatable composite carrying the name or title of the usage license forming part of the commercial offer for the product, and a link to the license terms in eye-readable or machine-readable form.

Use when indicating the transaction or product in the <ItemDetail> refers to a product with a particular digital product license and there is a need to clearly indicate which license is associated with the product in the line of report.

EpubLicense
0…1
EpubLicenseName EpubLicenseName EpubLicenseExpression EpubLicenseExpression
<EpubLicense>
    <EpubLicenseName>New Street Publishers EULA v2</EpubLicenseName>
    <EpubLicenseExpression>
        <EpubLicenseExpressionType>01​</EpubLicenseExpressionType>
        <EpubLicenseExpressionLink>http://www.NewStreetPublishers.com/​licenses/EULA_v2<EpubLicenseExpressionLink>
    </EpubLicenseExpression>
</EpubLicense>
B.37 Digital product license name

The name or title of the license. Mandatory in any <EpubLicense> composite.

EpubLicenseName
Variable length text, suggested maximum length 100 character
1
<EpubLicenseName>Elsevier e-book EULA v5</EpubLicenseName>
B.38 Digital product license expression

An optional and repeatable composite that carries details of a link to an expression of the license terms, which may be in human-readable or machine-readable form. Repeatable when there is more than one expression of the license.

EpubLicenseExpression
0…n
EpubLicenseExpressionType EpubLicenseExpressionType EpubLicenseExpressionTypeName EpubLicenseExpressionTypeName EpubLicenseExpressionLink EpubLicenseExpressionLink Must be included if and only if <EpubLicenseExpressionType> is proprietary
B.39 License expression type

A code identifying the nature or format of the license expression specified in the <EpubLicenseExpressionLink> element. Mandatory within the <EpubLicenseExpression> composite, and non-repeating.

EpubLicenseExpressionType
two-digit numeric code from ONIX Codelist 218
1
<EpubLicenseExpressionType>10</EpubLicenseExpressionType>    (ONIX-PL license expression)
B.40 License expression type name

A short free-text name for a license expression type, when the code in <EpubLicenseExpressionType> provides insufficient detail – for example when a machine-readable license is expressed using a particular proprietary encoding scheme. Optional and non-repeating, and must be included when (and only when) the <EpubLicenseExpressionType> element indicates the expression is encoded in a proprietary way.

EpubLicenseExpressionTypeName
Variable length text, suggested maximum length 50 characters
0…1
<EpubLicenseExpressionTypeName>ABC-XML</E pubLicenseExpressionTypeName>
End of digital product license expression composite
End of digital product license composite
B.42 Price condition composite

The <PriceCondition> composite is primarily used to indicate things like rental price extensions – time period extensions for pre-existing time-limited licenses – for e-publications, certain kinds of subscriptions.

A repeatable group of data elements which together specify a condition relating to a price. Repeatable in order to express multiple conditions associated with the price.

Use when indicating the transaction or product in the <ItemDetail> refers to a product with a particular set of price conditions and there is a need to clearly indicate what conditions are associated with the product in the line of report.

PriceCondition
0…n
PriceConditionType PriceConditionType PriceConditionQuantity PriceConditionQuantity
Product was sold as a 3 month extension to a rental
<PriceCondition>
    <PriceConditionType>12</PriceConditionType>
    <PriceConditionQuantity>
        <PriceConditionQuantityType>01</PriceConditionQuantityType>
        <Quantity>03</Quantity>
        <QuantityUnit>09</QuantityUnit>
    </PriceConditionQuantity>
</PriceCondition>
B.43 Price condition type

A code identifying a type of price condition. Mandatory in each occurrence of the <PriceCondition> composite, and non-repeating.

PriceConditionType
two-digit numeric code from ONIX Codelist 167
1
<PriceConditionType>02</PriceConditionType>    (Must also purchase updates)
B.44 Price condition quantity composite

An optional and repeatable group of data elements which together specify a price condition quantity, for example a minimum number of copies, or a period of time for which updates are supplied or must be purchased.

PriceConditionQuantity
0…n
PriceConditionQuantityType PriceConditionQuantityType Quantity Quantity QuantityUnit QuantityUnit
B.45 Price condition quantity type

An ONIX code identifying a type of price condition quantity. Mandatory in each occurrence of the <PriceConditionQuantity> composite, and non-repeating.

PriceConditionQuantityType
two-digit numeric code from ONIX Codelist 168
1
<PriceConditionQuantityType>01</PriceConditionQuantityType>    (Time period)
B.46 Quantity

A quantity associated with a price condition. Mandatory in each occurrence of the <PriceConditionQuantity> composite, and non-repeating.

Positive real number, here normally but not necessarily an integer, or zero, as appropriate for the units specified in <QuantityUnit>
Quantity
1
<Quantity>12</Quantity>
B.47 Quantity unit code

An ONIX code value specifying the unit in which a price condition quantity is stated. Mandatory in each occurrence of the <PriceConditionQuantity> composite, and non-repeating.

QuantityUnit
two-digit numeric code from ONIX Codelist 169
1
<QuantityUnit>09</QuantityUnit>    (Months)
End of price condition quantity composite
End of price condition composite
B.48 Device type

The specific type of device on which a digital product is designed to be readable. Optional.

This element was not used as no codelist was defined and has now been deprecated.

DeviceType
B.49 Quantity sold

Optional number of copies sold. The total number of copies dispatched and paid for by the end purchaser.

Use when reporting sales under the reseller model (wholesale, retail etc).

Do not use for sales under the agency model.

Quantity
Integer
0…1
<Quantity>45</Quantity>
B.50 Gross quantity sold

Optional gross number of copies sold, prior to any adjustment for returns and refunds.

Use only when reporting sales under the agency model along with <RefundedQuantity> and <NetSoldQuantity>.

GrossSoldQuantity
Integer
0…1
<GrossSoldQuantity>345</GrossSoldQuantity>
B.51 Returned / refunded quantity

Optional number of copies returned or sales refunded.

Use only when reporting sales under the agency model along with <GrossSoldQuantity>and <NetSoldQuantity>.

RefundedQuantity
Integer
0…1
<RefundedQuantity>3</RefundedQuantity>
B.52 Net quantity sold

Optional net number of copies sold, after adjustments for returns and refunds.

Use only when reporting sales under the agency model along with <RefundedQuantity> and <GrossSoldQuantity>.

NetSoldQuantity
Integer
0…1
<NetSoldQuantity>42</NetSoldQuantity>
B.53 Non-sale disposal

For non-sale disposals both the type and quantity of disposals must be specified.

These quantities have come out of stock but do not affect the sales figure.

NonSaleDisposal
0…n
DisposalType DisposalType DisposalQuantity DisposalQuantity
B.54 Disposal type

Code specifying the nature of a non-sale disposal, mandatory within the <NonSaleDisposal> composite.

DisposalType
Must be one of the following:
Unspecified
Promotion
Review
20–99two-digit numeric code for agreed use between trading partners
1
<DisposalType>Review</DisposalType>
B.55 Disposal quantity

Number of copies disposed of in the manner specified in <DisposalType>.

DisposalQuantity
Integer
1
<DisposalQuantity>2</DisposalQuantity>
End of Non-sale disposals composite
B.56 Line item document references

Optional document reference for the line item and repeatable if more than one document reference applies. A document reference can apply to multiple lines.

If included on a line level should not be used in the header.

Each repeat of the <ReferenceCoded> composite must include a Reference type code, plus a Reference number and/or a Reference date.

  • a reference number
  • a reference date or date and time
  • a number plus a date or date and time
ReferenceCoded
0…n
ReferenceTypeCode ReferenceTypeCode ReferenceTypeName ReferenceTypeName ReferenceNumber ReferenceNumber ReferenceDate ReferenceDate ReferenceDateTime ReferenceDateTime Deprecated Must be included if and only if <ReferenceTypeCode> is proprietary Must not omit all three Must not include both
<ReferenceCoded>
    <ReferenceTypeCode>InvoiceReference</ReferenceTypeCode>
    <ReferenceNumber>FSA1003521</ReferenceNumber>
    <ReferenceDate<20170205</ReferenceDate>
</ReferenceCoded>
B.57 Reference type code

The type of reference for the document relating to the line item, mandatory in every <ReferenceCoded> composite.

ReferenceTypeCode
Must be one of the following:
ReportItemReferenceNumberunique reference number assigned by the sender. If the <SalesReportTypeCode> in the message header is ByTransaction, this is the transaction reference
InvoiceReference
CreditNoteReference
DespatchNoteReference
InvoiceLineReference
CreditNoteLineReference
DespatchNoteLineReference
ReportingPartyReferenceunique reference number assigned by the reporting party
SellingAgentPartyReferenceunique reference number assigned by the selling agent
Proprietarymust be named in <ReferenceTypeName>
1
<ReferenceTypeCode>InvoiceReference</ReferenceTypeCode>
B.58 Reference type name

A distinctive and consistent name for a proprietary reference. Mandatory if <ReferenceTypeCode> is Proprietary, but omitted for any other value of <ReferenceTypeName>.

ReferenceTypeName
Text, suggested maximum length 50 characters
0…1
B.59 Reference number

The alphanumeric reference number of the document. Optional, but must be included in every <ReferenceCoded> composite if <ReferenceDate> is omitted.

ReferenceNumber
Alphanumeric characters, suggested maximum length 16 characters
0…1
<ReferenceNumber>2456XCVB345TY677</ReferenceNumber>
B.60 Reference date

The date, or date and time, of the reference document. Optional, but must be included in every <ReferenceCoded> composite if < ReferenceNumber> is omitted.

ReferenceDate
See <IssueDateTime> for allowed formats
0…1
<ReferenceDate>20180815T1045Z</ReferenceDate>
B.61 Reference date and time

May not be included if <ReferenceDate> is used.

This element has been deprecated, but is maintained for backwards compatibility. Prefer <ReferenceDate>.

ReferenceDateTime
YYYYMMDDThhmmss
0…1
<ReferenceDateTime>20180815T104500</ReferenceDateTime>
End of Line item reference composite
B.62–85 Ship to party

Composite containing details of the party to whom the sold units have been shipped. Normally only included if required for tax reporting purposes. If this is a business-to-business or institutional transaction, then a <PartyIdentifier> should be sent in addition to a <CountryCode> or <RegionCode>. If the transaction was to an individual, then, depending on the tax jurisdiction, one or more of <CountryCode>, <RegionCode> or <LocationIdentifier> composite should be sent. In some tax jurisdictions a <ShipToLocation> is all that is required for non-business / institutional transactions.

The structure of the <ShipToParty> composite is identical to that of <SellerParty> .

Some tax jurisdictions also require <BillToParty> to be sent along with <ShipToParty>.

ShipToParty
0…1
 
Transaction was to a company in France
<ShipToParty>
    <PartyIdentifier>
        <PartyIDType>06</PartyIDType>
        <IDValue>3012262710000</IDValue
    </PartyIdentifier>
    <CountryCode>FR</CountryCode>
</ShipToParty>
End of Ship to party composite
B.86 Ship to location

Optional composite containing one or more identifiers for the location to which the units have been shipped.

This is normally included only if required for tax reporting purposes. For example, in North American usage, it is mandatory to report the zip code, county and state to which the units have been shipped. When reporting digital sales for tax purposes in certain tax jurisdictions, for example the European Union, then the country or region – if the region has a different tax rate from the country – of the purchaser has to be reported.

Some tax jurisdictions also require <BillToLocation> to be sent along with <ShipToLocation>.

ShipToLocation
0…1
LocationIdentifier LocationIdentifier
Transaction was to an individual in Detroit, Michigan. (For Sales Tax report)
<ShipToLocation>
    <LocationIdentifier>
        <LocationIDType>RegionCode</LocationIDType>
        <IDValue>US-MI</IDValue
    </LocationIdentifier>
</ShipToLocation>
<ShipToLocation>
    <LocationIdentifier>
        <LocationIDType>CountyName</LocationIDType>
        <IDValue>Wade County</IDValue
    </LocationIdentifier>
</ShipToLocation>
<ShipToLocation>
    <LocationIdentifier>
        <LocationIDType>CityName</LocationIDType>
        <IDValue>Detroit</IDValue
    </LocationIdentifier>
</ShipToLocation>
B.87 Location identifier

Composite containing an identifier for the location to which the units have been shipped. Repeatable if the location is identified with more than one type of identifier.

LocationIdentifier
LocationID
1…n
LocationIDType LocationIDType IDTypeName IDTypeName IDValue IDValue Must be included if and only if <LocationIDType> is proprietary
B.88 Location identifier type

Mandatory code for the identifier scheme used.

LocationIDType
Must be one of the following:
GLNGlobal location number (13 digits)
SANStandard address number (7 digits)
PostalCodeZIP or other postal code for the address to which the item(s) were shipped. Should be sent along with a Country Code in a repeat of the <LocationIdentifer> composite for clarity.
CountryCodeTwo letter code from ONIX Codelist 91
ONIXRegionCodeAlphanumeric code from ONIX Codelist 49
RegionCodeUnited States Postal Service (USPS) abbreviation
CountyNameVariable length text, suggested maximum length 50 characters
CityNameVariable length text, suggested maximum length 50 characters
DistrictNameVariable length text, suggested maximum length 50 characters
GeoCodeVertex™ GeoCode
Proprietary
1
<LocationIDType>GLN</LocationIDType>
B.89 Identifier type name

A distinctive and consistent name for a proprietary location identifier type, which must be included if and only if <LocationIDType> is proprietary.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
<IDTypeName>Big Bookstore branch code</IDTypeName>
B.90 Identifier

Mandatory identifier of the type specified in <LocationIDType>.

IDValue
Identifier
Alphanumeric characters according to the identifier type specified <LocationIDType>
1
<IDValue>3012262710000</IDValue>
End of Location identifier composite
End of Ship to location composite
B.91–114 Bill to party

Details of the party to which the bill or invoice for the item(s) was sent, or in which the party paying for the item(s) was located. This is a requirement in certain tax jurisdictions.

The structure of the <BillToParty> composite is identical to that of <SellerParty>.

BillToParty
0…1
End of Bill to party composite
B.115–119 Bill to location

Composite containing one or more identifiers for the location to which the bill or invoice for the item(s) was sent. This is a requirement in certain tax jurisdictions.

The structure of the <BillToLocation> is identical to that of <ShipToLocation>.

BillToLocation
0…1
End of Bill to location composite
B.120 Transaction date

Optional, but one of either Transaction date or Date and time of transaction is required if no report period is specified in the message header. Transaction date is deprecated in favour of Date and time of transaction.

If used, the <DateCoded> composite must include both a date and a date qualifier.

DateCoded
0…1
Date Date Deprecated DateQualifierCode DateQualifierCode Deprecated
B.121 Date

The date or date and time of transaction reported in line.

Date
See <IssueDateTime> for allowed formats.
1
B.122 Date qualifier

A code indicting whether the preceding <Date> element contains a simple date or a date and time.

DateQualifierCode
Must be one of the following:
TransactionDate
TransactionDateTime
1
End of Transaction date composite
B.123 Date and time of transaction

The date or date and time of transaction reported in line. Use in preference to <DateCoded>.

Date
see <IssueDateTime> for allowed formats
B.124 Pricing detail

Composite containing details of the product price and the sales terms on offer to the buyer or the sales terms of the transaction. Mandatory in Sales reports, but optional in Sales tax reports.

When included, <PricingDetail> is repeatable, but is normally only repeated in circumstances where there is a need to report both the suggested retail price and the unit cost. For sales under agency terms, only the publisher’s retail price is reported.

Each <PricingDetail> composite must normally include a <Price> and may contain optional discount details.

PricingDetail
1…n in Sales reports, 0…n in Sales tax reports
ClassOfSaleCode ClassOfSaleCode Price Price DiscountPercentage DiscountPercentage Deprecated CommissionDiscountPercentage CommissionDiscountPercentage Deprecated CurrencyConversionRate CurrencyConversionRate SellerCharge SellerCharge UnitAmountDueToPublisher UnitAmountDueToPublisher or LineAmountDueToPublisher UnitAmountDueToSupplier UnitAmountDueToSupplier or LineAmountDueToSupplier Mandatory for Sales report, but optional in Sales tax report
B.125 Class of sale

Optional class of sale applying to the line item, and repeatable if more than one class of sale applies to the line item. Must be included here if not included in the message header.

ClassOfSaleCode
Fixed-length two-digit code
Must contain one of the following:
00Unspecified
01Agency
02Wholesale
03Retail
04Export
05Publisher-internal
06Review copies
07Printed
08Digital
20–99codes defined by trading partner agreement
0…n
<ClassOfSaleCode>03</ClassOfSaleCode> (Retail)
B.126 Price

The price for the product, for example the publisher’s list price, as a monetary amount, with an optional tax breakdown. The <Price> composite must include at least <PriceType> – unless <ReportPriceType> is specified in the header – plus <PriceAmount> and <CurrencyCode>.

The <Price> composite is mandatory in Sales reports, but may be omitted in Sales tax reports when only aggregated sales values for the line item are reported.

Price
0…1
PriceIdentifier PriceIdentifier PriceType PriceType PriceQualifier PriceQualifier DiscountCoded DiscountCoded Discount Discount PriceAmount PriceAmount or MonetaryAmount CurrencyCode CurrencyCode CountryCode CountryCode RegionCode RegionCode Territory Territory PriceQualifierCode PriceQualifierCode Deprecated Tax Tax TaxExempt TaxExempt Use only one of three Must only be used if <PriceType> omitted Must not omit both Tax and TaxExempt in Sales Tax Reports
B.127 Price identifier composite

An optional and repeatable group of elements that provide an identifier for a particular price. For products that may be available at potentially many different prices, to different groups of purchasers or under different terms and conditions.

Note that the price identifier will always be proprietary and must be unique across multiple pricing options for one product, but need not be unique across all products, nor need it be the same across all products offered at the same price point or under the same terms.

The composite is repeatable in order to provide multiple identifiers for the same price.

PriceIdentifier
0…n
PriceIDType PriceIDType IDTypeName IDTypeName IDValue IDValue Must be included if and only if <PriceIDType> is proprietary
<PriceIdentifier>
    <PriceIDType>01</PriceIDType>
    <IDTypeName>PRHG PUUID</IDTypeName>
    <IDValue>f47ac10b-58cc-4372-a567-0e02b2c3d479</IDValue>
</PriceIdentifier>
B.128 Price identifier type code

A code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <PriceIdentifier> composite, and non-repeating.

There is no particular public ‘standard’ for price identifiers, so at present only proprietary identifiers may be specified.

PriceIDType
Fixed-length two-digit code from ONIX Codelist 217
1
<PriceIDType>01<PriceIDType>    (Proprietary)
B.129 Identifier type name

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <PriceIDType> element indicates a proprietary scheme, eg a publisher’s own identifier scheme. Optional and non-repeating.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
<IDTypeName>PRHG PUUID</IDTypeName>
B.130 Identifier value

An identifier of the type specified in the <PriceIDType> element. Mandatory in each occurrence of the <PriceIdentifier> composite, and non-repeating.

IDValue
Alphanumeric characters according to the identifier type specified in <PriceIDType>
1
<IDValue>f47ac10b-58cc-4372-a567-0e02b2c3d479</IDValue>    (from a scheme using a UUID)
End of price identifier composite
B.131 Price type code

A code indicating the type of the price in the <PriceAmount> field within the <Price> composite. Although optional, it is recommended that <PriceType> is treated as mandatory. It uses the same code list as in ONIX for Books, with two extra codes for indicating Actual Selling Price (ASP).

If Price type is omitted, then either <PriceQualifierCode> or <ReportPriceType> – which can specify similar price types – must be included. The latter is deprecated, and only one of <PriceType> or <PriceQualifierCode> or <ReportPriceType> may be included.

PriceType
Must contain a fixed-length two-digit code from one of:
A value from ONIX Codelist 58
51Actual selling price per unit sold (ASP), excluding any sales tax or VAT
52Actual selling price per unit sold (ASP), including any sales tax or VAT
0…1
<PriceType>51</PriceType>    (Actual sold at price, excluding tax)
B.132 Price type qualifier

A code which further specifies the type of price, eg member price, reduced price when purchased as part of a set, library price etc. Optional and non-repeating, and may only be used if preceded by <PriceType>.

This should be included when reporting on sales for specific types of prices, for example a school or library price.

PriceQualifier
Fixed-length two-digit code from ONIX Codelist 59
0…1
<PriceQualifier>13</PriceQualifier>    (Subscription service price)
B.133 Discount code composite

A repeatable group of data elements which together define a discount code from a specified scheme, and allowing different discount code schemes to be supported without defining additional data elements. Optional. A discount code is generally used when the exact percentage discount (or commission, in an agency business model) that a code represents may vary from reseller to reseller (or from agent to agent), or if terms must be kept confidential. If the discount (or commission) is the same for all resellers (or agents) and need not be kept confidential, use <Discount> and <DiscountPercent> instead.

DiscountCoded
0…n
DiscountCodeType DiscountCodeType DiscountCodeTypeName DiscountCodeTypeName DiscountCode DiscountCode Must be included if and only if <DiscountCodeType> is proprietary
<DiscountCoded>
    <DiscountCodeType>01 </DiscountCodeType>
    <DiscountCodeTypeName>IngramDC</DiscountCodeTypeName>
    <IDValue>AHACP033</IDValue>
</DiscountCoded>
B.134 Discount code type code

A code identifying the scheme from which the value in the <DiscountCode> element is taken. Mandatory in each occurrence of the <DiscountCoded> composite, and non-repeating.

DiscountCodeType
Fixed-length two-digit code from ONIX Codelist 100
1
<DiscountCodeType>02</DiscountCodeType>    (Proprietary)
B.135 Discount code type name

A name which identifies a proprietary discount code. Must be used when, and only when the code in the <DiscountCodeType> element indicates a proprietary scheme, eg a wholesaler’s own code. Optional and non-repeating.

DiscountCodeTypeName
Variable length text, suggested maximum length 50 characters
0…1
<DiscountCodeTypeName>IngramDC</DiscountCodeTypeName>
B.136 Discount code value

A discount code from the scheme specified in the <DiscountCodeType> element. Mandatory in each occurrence of the <DiscountCoded> composite, and non-repeating.

DiscountCode
According to the scheme specified in <DiscountCodeType>
1
<DiscountCode>AHACP033</DiscountCode>
End of discount code composite
B.137 Discount composite

A repeatable group of data elements which together define a discount (or a commission) either as a percentage or as an absolute amount. Optional.

Discount
0…n
DiscountType DiscountType Quantity Quantity ToQuantity ToQuantity DiscountPercent DiscountPercent DiscountAmount DiscountAmount Must not omit both
<Discount>
    <DiscountType>01</DiscountType>
    <DiscountPercent>37.5</DiscountPercent>
    <DiscountAmount>4.59</DiscountAmount>
</Discount>
B.138 Discount type

An ONIX code identifying a discount or commission type. Optional, and non-repeating. The default is a simple or rising discount (the discount / commission is applied to all units in a qualifying order).

DiscountType
Fixed-length two-digit code from ONIX Codelist 170
0…1
 
B.139 Quantity

A minimum order quantity that was required to qualify for a specified discount. Use here if needed to clarify the discount / commission rate associated with the reported transaction.

Quantity
Positive number, here necessarily an integer, or zero. Suggested maximum length 7 digits
0…1
<Quantity>12</Quantity>
B.140 To Quantity

A maximum order quantity eligible for a specified discount, used only in the case of ‘progressive’ discounts. Optional, but where used, must be preceded by a minimum qualifying order quantity (even if that minimum is 1). For the special case where there is no maximum (ie in the repeat of the <Discount> composite that specifies the highest progressive discount), use zero. Use here if needed to clarify the discount / commission rate associated with the reported transaction.

ToQuantity
Positive number, here necessarily an integer, or zero. Suggested maximum length 7 digits
0…1
<ToQuantity>25</ToQuantity>
B.141 Discount percentage

A discount or commission percentage applicable to the price carried in an occurrence of the <Price> composite. Optional and non-repeating; but either <DiscountPercent> or <DiscountAmount> or both must be present in each occurrence of the <Discount> composite.

DiscountPercent
Real number between zero and 100 (inclusive), including explicit decimal point when required, suggested maximum length 6 characters
0…1
<DiscountPercent>37.5</DiscountPercent>
B.142 Discount amount

A discount or commission expressed as an absolute amount per copy. Optional and non-repeating; but either <DiscountPercent> or <DiscountAmount> or both must be present in each occurrence of the <Discount> composite. Note that when both are present, they represent two different expressions of the same discount – the discounts are not cumulative.

DiscountAmount
Positive real number, with explicit decimal point when required, or zero, suggested maximum length 12 characters
0…1
<DiscountAmount>4.59</DiscountAmount>
End of discount composite
B.143 Price amount

The amount of a price associated with the reported transaction. Optional and non-repeating, but it is recommended that each occurrence of the <Price> composite contains <PriceAmount>.

May be reported as 0.00 if the item sold was free of charge, for example an open access publication.

PriceAmount
MonetaryAmount
Zero or positive real number, with explicit decimal point when required, suggested maximum length 12 characters
0…1
<PriceAmount>18.99</PriceAmount>
B.144 Price amount currency code

The currency associated with the price. Should always be included with all occurrences of <PriceAmount> for clarity.

CurrencyCode
Fixed-length code consisting of three upper case letters from ONIX Codelist 96
<CurrencyCode>EUR</CurrencyCode> (Euros)
B.145 Price amount country code

If the currency in <CurrencyCode> is legal tender in in more than one country, used to indicate the price details are specific to a particular country.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
<CountryCode>FR</CountryCode> (France)
B.146 Price amount region code

If the price and currency in <CurrencyCode> and <Tax> apply to a particular region of a country, use this instead of <CountryCode> as the ISO 2 letter country code is part of the structure of the Region code.

RegionCode
Variable-length alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
<RegionCode>FR-H</RegionCode> (Corsica)
B.147 Price amount territory

The trading territory associated with the price, currency and tax. Where the price and currency are associated with a more complex territory than one country or region. Can be used to express, for example, that the price applies to USA excluding Alaska and Hawaii, or that it applies to France excluding Corsica or applies to all the countries using the Euro.

Territory
Structure of the composite is the same as Report Trading <Territory>
0…1
<Territory>
    <CountriesIncluded>USA</CountriesIncluded>
    <RegionsExcluded>US-AK US-HI</RegionsExcluded>
</Territory>
<Territory>
    <CountriesIncluded>FR</CountriesIncluded>
    <RegionsExcluded>FR-H</RegionsExcluded>
</Territory>
<Territory>
    <CountriesIncluded>AD AT BE CY DE EE ES FI FR GR IE IT LT LU LV MC MT NL PT SI SK SM VA</CountriesIncluded>
</Territory>
B.148 Countries included

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesIncluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesIncluded>US CA</CountriesIncluded>    (USA and Canada)
B.149 Regions included

One or more codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Arkansas, Brussels. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

RegionsIncluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
<RegionsIncluded>CA-QC</RegionsIncluded> (Quebec)
B.150 Countries excluded

One or more standard codes from ISO 3166-1 identifying countries excluded in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesExcluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesExcluded>US CA</CountriesExcluded>    (USA and Canada)
B.151 Regions excluded

One or more codes identifying regions excluded from the territory. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code of ‘World’.

RegionsExcluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
<RegionsExcluded>CA-QC</RegionsExcluded> (Quebec)
End of Territory composite
B.152 Price qualifier code

Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format. Prefer <PriceType> and <PriceQualifier> instead. If <PriceQualifierCode> is included, <PriceType> and <PriceQualifier> must be omitted.

PriceQualifierCode
Must contain one of the following:
SRPExcludingTaxSuggested retail price excluding tax – use when the buy price is calculated by discounting from a suggested or recommended retail price
SRPIncludingTaxSuggested retail price including tax
FixedRPExcludingTaxFixed retail price excluding tax – use when the buy price is calculated by discounting from a fixed retail price
FixedRPIncludingTaxFixed retail price including tax
UnitCostExcludingTaxUnit cost excluding tax – use when the buy price is a unit cost, net price or wholesale price, with or without further discount (eg based on volume)
UnitCostIncludingTaxUnit cost including tax
PublisherRPExcludingTaxPublisher’s retail price excluding – used when products are sold under the ‘agency model’
PublisherRPIncludingTaxPublisher’s retail price including tax
SoldAtPriceExcludingTaxActual price per unit, net of any discount to the buyer but excluding tax (ASP)
SoldAtPriceIncludingTaxActual price per unit, including tax and net of any discount to the buyer(ASP)
0…1
<PriceQualifierCode>PublisherRPExcludingTax</PriceQualifierCode>
B.153 Tax

Optional tax breakdown for the quoted price. One of either <Tax> or <TaxExempt/> is mandatory in Sales tax reports. Both may be omitted in Sales reports, but including one or other is recommended when a Sales report reports sales under agency terms (where the report functions as a combined sales and tax report).

Note that tax exempt status is rare and applies in only a very few countries. Tax exempt items are different from zero-rated articles. In both cases no tax amount is added to the selling price, but zero-rated goods or services are taxable at 0% and should always be reported as such in the sales tax report using the <Tax> composite and with zero-rated goods there is usually a possibility of claiming input VAT and including these products in tax reporting. Exempt from tax usually means there is no possibility of claiming input VAT or including the product in tax reports. This varies in different tax jurisdictions and you should always check what the regulations are for the jurisdiction you are reporting in.

The whole <Tax> composite may be repeated if a product contains components which may be taxed differently, such as a pack with a book, an audio cd and a toy. Each <Tax> composite must contain a <TaxTypeCode> element, and at least one of <TaxAmount> or <TaxRatePercent plus <TaxableAmount>. Best practice is to include all of these for clarity. <TaxableAmount> must be present if <Tax> is repeated or <TaxComponent> is used.

Tax
0…n
ProductIdentifier ProductIdentifier PricePartDescription PricePartDescription TaxType TaxType or TaxTypeCode TaxTypeName TaxTypeName TaxRateCode TaxRateCode TaxRatePercent TaxRatePercent or Percent TaxableAmount TaxableAmount or AmountTaxable TaxAmount TaxAmount TaxComponent TaxComponent Must not omit both Must not omit if <Tax> is repeated
When the euro price is 50.00 including VAT
<Tax>
    <TaxType>EUVAT</TaxType>
    <TaxRateCode>R</TaxRateCode>
    <TaxRatePercent>2.1</TaxRatePercent>
    <TaxableAmount>48.97</TaxableAmount>
    <TaxAmount>1.03</TaxAmount>
</Tax>
B.154 Product identifier composite (product part)

Optional and repeatable group of data elements which together define an identifier of a product part in accordance with a specified scheme, used here only when it is necessary to link a particular tax rate or amount with a particular product part contained within a multiple-item product or a trade pack.

There will usually be at least one repeat of <Tax> composite if <ProductIdentifier> is included.

ProductIdentifier
0…n
ProductIDType ProductIDType IDTypeName IDTypeName IDValue IDValue or Identifier Must be included if and only if <ProductIDType> is proprietary
<ProductIdentifier>
    <ProductIDType>15</ProductIDType>
    <IDValue>9780001234567</IDValue>
</ProductIdentifier>
B.155 Product identifier type

Specifies the type of identifier used for the product.

ProductIDType
Must contain one of:
A value from Two-digit code from ONIX Codelist 5
Proprietaryuse for a third-party proprietary ID scheme, which must be named in <IDTypeName>
ISBNuse only for a 10-character ISBN
EAN13use for a 13-digit ISBN, ISMN or any other GTIN-13
UPCuse for an item-specific UPC-12
ISMNuse only for a 10-character ISMN
GTIN14use only for a 14-digit GTIN
SKUStock Keeping Unit – a number assigned to a product by the company for stock-keeping purposes and internal operations
Selleruse for a supplier-defined product ID
Buyeruse for a customer-defined product ID
1
<ProductIDType>EAN13</ProductIDType>
B.156 Identifier type name

A distinctive and consistent name for a proprietary product identifier. Mandatory if <ProductIDType> is proprietary, and omitted for any other value of <ProductIDType>.

IDTypeName
Variable length text, suggested maximum length 50 characters
0…1
<IDTypeName>Online Bookstore Item no</IDTypeName>
B.157 Identifier

An identifier of the type specified in <ProductIDType>.

IDValue
Identifier
Alphanumeric characters according to the identifier type specified in <ProductIDType>.
1
<Identifier>9780300117264</Identifier>
Spaces and hyphens are omitted from ISBNs, ISMNs, EANs, UPCs, GTINs
End of Product identifier composite
B.158 Price part description

A name or description which identifies a part of the product price that is subject to the relevant tax, for example a product part that may be taxed with a particular tax rate or amount (separately from other components), or a levy added to a product price that is itself subject to tax. Optional.

Variable length text, suggested maximum length 100 characters
PricePartDescription
0…1
<PricePartDescription>Eco-mobilier France</PricePartDescription>
B.159 Tax type

Mandatory indicator of the type of tax levied on the product. If using the values from list 171 the <Price> <CountryCode>, <RegionCode> or <Territory> composite indicate which zone the tax is applicable to. Use a value from list 171 if there is no separate code for the tax type and jurisdiction you are reporting on.

TaxType
TaxTypeCode
must contain one of the following:
Two-digit code from ONIX Codelist 171
CAGSTCanadian Goods and Services Tax
CAHSTCanadian Harmonized Sales Tax
USSTUS Sales and Use Tax
AUGSTAustralian Goods and Services Tax
NZGSTNew Zealand Goods and Services Tax
EUVATEuropean Union VAT. The country should be identified by the ShipTo or BillTo party or location
ISVATIcelandic VAT
NOVATNorwegian VAT
CHVATSwiss VAT
INVATIndian VAT
KRVATKorean VAT
JPCTJapanese Consumption Tax
Proprietarymust be identified in <TaxTypeName>
1
<TaxType>EUVAT</TaxType>
<TaxType>01</TaxType> (Value Added Tax)
B.160 Tax type name

The name of the type of tax. Mandatory when <TaxTypeCode> is Proprietary, and omitted for any other value of <TaxTypeCode>.

TaxTypeName
Variable length text, suggested maximum length 50 characters
0…1
B.161 Tax rate code

A code which specifies into which tax rate type (standard, reduced, zero rate etc) the product being reported on is classified.

For example a printed book sold in Denmark would be classified as S – Standard, whereas a book sold in France would be in R – Reduced, and book in Ireland in Z – Zero rated.

This is optional but is recommended for clarity.

TaxRateCode
Fixed format, one letter from ONIX Codelist 62
0…1
<TaxRateCode>R</TaxRateCode> (Reduced Rate)
B.162 Tax rate percentage

The actual rate at which the tax is levied on the taxable part of the price.

This is optional but must be included if <TaxableAmount> sent or no <TaxAmount> sent.

TaxRatePercent
Percent
Percentage as a real number. A tax levied at 17.5% would be 17.5
0…1
<TaxRatePercent>2.1</TaxRatePercent>
B.163 Taxable amount

The amount of the price excluding tax which is taxable at the rate specified, as a monetary amount. The tax is calculated on this amount and then added to the price to give a total price including tax.

This is optional but must be included if <TaxRatePercent sent or no <TaxAmount> sent.

TaxableAmount
AmountTaxable
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxableAmount>48.97</TaxableAmount
B.164 Tax amount

The amount of tax chargeable on the taxable part of the price at the rate specified, as a monetary amount. This will be the amount added to the Taxable Amount to give the total price including any taxes.

This is optional but must be included if no <TaxRatePercent sent.

TaxAmount
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxAmount>1.03</TaxAmount>
B.165 Tax component

Where the tax levied consists of a number of separate taxes, each tax component can be detailed separately in an optional <TaxComponent> composite.

The total tax levied is sent in <Tax> and this allows for a breakdown of that tax amount, typically used in the USA or Canada for reporting different sales taxes in different jurisdictions.

Repeatable to allow for usage such as State, county and district or city tax detail in the USA and Federal and Provincial GST/HST details in Canada or other tax jurisdictions with similar tax systems.

Only should be sent if it is repeated as a single occurrence of <TaxComponent> will be the same as <Tax>. The <TaxAmount> of each <TaxComponent> should add up to the sum in <TaxAmount> in the <Tax> composite. The <TaxableAmount> in <TaxComponent> will always be the same value as the <TaxableAmount> in the <Tax> composite.

TaxComponent
0…n
TaxComponentTypeCode TaxComponentTypeCode TaxComponentTypeName TaxComponentTypeName TaxRateCode TaxRateCode TaxRatePercent TaxRatePercent or Percent TaxableAmount TaxableAmount or AmountTaxable TaxAmount TaxAmount Must not omit both Should always be the same as <TaxableAmount> in parent <Tax> composite. May be omitted
The breakdown of a total sales tax amount of $1.44 which was added to a $9.00 price
<Tax>
    <TaxType>USST</TaxType>
    <TaxRateCode>S</TaxRateCode>
    <TaxRatePercent>16</TaxRatePercent>
    <TaxableAmount>9.00</TaxableAmount>
    <TaxAmount>1.44</TaxAmount>
    <TaxComponent>
        <TaxComponentTypeCode>USState</TaxComponentTypeCode>
        <TaxRatePercent>9</TaxRatePercent>
        <TaxableAmount>9.00</TaxableAmount>
        <TaxAmount>0.81</TaxAmount>
    </TaxComponent>
    <TaxComponent>
        <TaxComponentTypeCode>USCounty</TaxComponentTypeCode>
        <TaxRatePercent>5</TaxRatePercent>
        <TaxableAmount>9.00</TaxableAmount>
        <TaxAmount>0.45</TaxAmount>
    </TaxComponent>
    <TaxComponent>
        <TaxComponentTypeCode>USDistrict</TaxComponentTypeCode>
        <TaxRatePercent>2</TaxRatePercent>
        <TaxableAmount>9.00</TaxableAmount>
        <TaxAmount>0.18</TaxAmount>
    </TaxComponent>
</Tax>
B.166 Tax component type

A code indicating what type of tax is being detailed, mandatory for each tax component.

TaxComponentTypeCode
must be one of the following:
GSTFederalCanadian GST, federal component
GSTProvincialCanadian GST, provincial component
USStateUS State sales tax
USCountyUS County sales tax
USCityUS City sales tax
USDistrictUS District sales tax
Proprietarymust be named in <TaxComponentTypeName>
1
<TaxComponentTypeCode>USState</TaxComponentTypeCode>
B.167 Tax component type name

A name for a tax component must be included when <TaxComponentTypeCode> is Proprietary and omitted for all other values of <TaxComponentTypeCode.

TaxComponentTypeName
Variable length text, suggested maximum length 50 characters
0…1
B.168 TaxRateCode

Optional and dependent on the tax component type.

TaxRateCode
Fixed format, one letter from ONIX Codelist 62
0…1
<TaxRateCode>S</TaxRateCode>    (Standard Rate)
B.169 Tax rate percentage

The actual rate at which the tax is levied on the taxable part of the price.

This is optional but is recommended for clarity.

TaxRatePercent
Percent
Percentage as a real number. A tax levied at 17.5% would be 17.5
0…1
<TaxRatePercent>9</TaxRatePercent>
B.170 Taxable amount

The amount of the price excluding tax which is taxable at the rate specified, as a monetary amount. The tax is calculated on this amount and then added to the price to give a total price including tax.

This is optional but is recommended for clarity.

TaxableAmount
AmountTaxable
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxableAmount>9.00</TaxableAmount
B.171 Tax amount

The amount of tax chargeable on the taxable part of the price at the rate specified, as a monetary amount. This will be the amount added to the Taxable Amount to give the total price including any taxes.

This is optional but is recommended for clarity.

TaxAmount
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxAmount>0.81</TaxAmount>
End of Tax component composite
End of Tax composite
B.172 Tax exempt flag

An empty element that identifies that a product price has a statutory exemption from tax in a particular tax jurisdiction or a reported transaction has been specifically exempted from tax. Optional, and used only when <PriceType> indicates an exc-tax price.

<TaxExempt/> must not be sent if it is immediately preceded by an instance of the <Tax> composite.

If the transaction was tax exempt than the necessary details of the purchaser should be included in <ShipToParty> and <BillToParty> to comply with the relevant tax jurisdiction regulations.

Note that tax exempt status is rare and applies in only a very few countries. Tax exempt items are different from zero-rated articles. In both cases no tax amount is added to the selling price, but zero-rated goods or services are taxable at 0% and should always be reported as such in the sales tax report using the <Tax> composite and with zero-rated goods there is usually a possibility of claiming input VAT and including these products in tax reporting. Exempt from tax usually means there is no possibility of claiming input VAT or including the product in tax reports. This varies in different tax jurisdictions and you should always check what the regulations are for the jurisdiction you are reporting in.

TaxExempt/
XML empty element
0…1
<TaxExempt/>
End of Price composite
B.173 Discount percentage

Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format. Prefer Discount composite.

Discount terms applying to the specified price. Optional, and only used in the wholesale model. The specified discount is applied to the supplier’s suggested or fixed retail price to arrive at a net price per unit to the reseller. May be zero (or omitted) if the price type in <PriceQualifierCode> indicates a net cost which is not subject to further discount.

DiscountPercentage
Percentage as a real number. A discount of 37.5% would be 37.5
0…1
B.174 Commission percentage

Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format. Prefer Discount composite.

Commission terms applying to the specified publisher’s retail price. Optional and only used in the agency model.

CommissionDiscountPercentage
Percentage as a real number. A discount of 37.5% would be 37.5
0…1
B.175 Currency conversion rate

When the unit price and the selling price are in different currencies, the exchange rate at which the unit price is converted to determine the selling price. Omitted when all prices are quoted in the same currency.

CurrencyConversionRate
Real number, variable number of decimal places. For example, if the unit price is in USD and the selling price in JPY, 81.234
0…1
<CurrencyConversionRate>81.2341</CurrencyConversionRate>
B.176 Seller charges

Optional and repeatable for different types of charges and detail of fees charged by the seller per unit.

Included for information only to show how the final amount due to a publisher or supplier was arrived at. It is not included in trailer totals.

SellerCharge
0…n
ChargeTypeCode ChargeTypeCode ChargeTypeDescription ChargeTypeDescription ChargeSourceCode ChargeSourceCode MonetaryAmount MonetaryAmount CurrencyCode CurrencyCode CountryCode CountryCode RegionCode RegionCode Territory Territory ChargeQualifierCode ChargeQualifierCode Tax Tax TaxExempt TaxExempt Use only one of three Must not omit both Tax and TaxExempt in Sales tax reports
A packaging charge applied in GB Pound Sterling by the selling agent
<SellerCharge>
    <ChargeTypeCode>Packaging</ChargeTypeCode>
    <ChargeSourceCode>SellingAgentParty</ChargeSourceCode>
    <MonetaryAmount>1.25</MonetaryAmount>
    <CurrencyCode>GBP</CurrencyCode>
    <CountryCode>GB</CountryCode>
</SellerCharge>
B.177 Seller charge type

Type of charge levied.

ChargeTypeCode
must be one of the following:
Printing
Handling
GiftWrapping
Packaging
Shipping
Commission
Other
20–99two-digit numeric code for agreed use between trading partners
0…1
<ChargeTypeCode>Commission</ChargeTypeCode>
B.178 Seller charge type description

A description of the charge, mandatory if the value of <ChargeTypeCode> is Other, but omitted for other values of <ChargeTypeCode>.

ChargeTypeDescription
Text, suggested maximum length 50 characters
0…1
<ChargeTypeDescription>xxx</ChargeTypeDescription>
B.179 Seller charge source

Code indicating the party that levies the charge (the reporting party may simply be passing on charges levied by other parties).

ChargeSourceCode
must be one of the following
ReportingParty
SellingAgentParty
FulfilmentAgentParty
20–99two-digit numeric code for agreed use between trading partners
0…1
<ChargeSourceCode>SellingAgentParty</ChargeSourceCode>
B.180 Seller charge amount

The amount of any charge.

MonetaryAmount
Decimal number, usually two decimal places (for most currencies but see list 96 below for exceptions.)
0…1
<MonetaryAmount>1.25</MonetaryAmount>
B.181 Seller charge currency code

The currency in which the charge is specified.

CurrencyCode
Fixed-length code consisting of three upper case letters from ONIX Codelist 96 (based on ISO 4217)
0…1
<CurrencyCode>GBP</CurrencyCode>
B.182 Seller charge country code

Used to indicate the charge details are specific to a particular country associated with the <CurrencyCode>.Optional but recommended for clarity.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
0…1
<CountryCode>GB</CountryCode>(United Kingdom)
B.183 Seller charge region code

Used to indicate the charge details are specific to a particular region of a country associated with the <CurrencyCode> . Optional but recommended for clarity.

RegionCode
Variable-length alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
<RegionCode>GB-NIR</RegionCode> (Northern Ireland)
B.184 Seller charge trading territory

The trading territory associated with the fees. Use if the zone is more than just one country or region. See <Territory> for structure and examples.

Territory
0…1
B.185 Seller charge countries included

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesIncluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesIncluded>US CA</CountriesIncluded>    (USA and Canada)
B.186 Seller charge regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Arkansas, Brussels. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

RegionsIncluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
B.187 Seller charge countries excluded

One or more standard codes from ISO 3166-1 identifying countries excluded in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesExcluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesExcluded>US CA</CountriesExcluded>    (USA and Canada)
B.188 Seller charge regions excluded

One or more ONIX codes identifying regions excluded from the territory. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

RegionsExcluded
One or more variable-length alphanumeric codes, successive codes separated by a space
List 49 based on ISO 3166-2
0…1
End of Seller charge territory composite
B.189 Seller charge qualifier

Mandatory code specifying whether the charge applies per unit or per line item.

Prefer the simpler Charge including / excluding tax as other codes have been deprecated but are retained for backward compatibility.

ChargeQualifierCode
must be one of the following:
UnitChargeIncludingTaxDeprecated – Per-unit charge including tax where applicable. Only valid in Pricing detail
UnitChargeExcludingTaxDeprecated – Per-unit charge excluding tax where applicable. Only valid in Pricing detail
LineChargeIncludingTaxDeprecated – Per-line item charge including tax where applicable. Only valid in Line Sales Amount
LineChargeExcludingTaxDeprecated – Per-line item charge excluding tax where applicable. Only valid in Line Sales Amount
ChargeIncludingTaxCharge including tax valid for pricing detail and line sales amount
ChargeExcludingTaxCharge excluding tax valid for pricing detail and line sales amount
1
<ChargeQualifierCode>UnitChargeIncludingTax</ChargeQualifierCode>
B.190–203 Seller charge tax

Optional tax breakdown for the quoted charges.

The structure of the <Tax> composite is identical to that in <Price> except that <ProductIdentifier> and <PricePartDescription> are not used in seller charge tax.

End of Seller charge tax composite
B.204 Seller charge tax exempt flag

An empty element that identifies that a service included as a seller charge is specifically exempted from any tax in a particular tax jurisdiction. Optional.

<TaxExempt/> must not be sent if it is immediately preceded by an instance of the <Tax> composite.

Note that tax exempt status is rare and applies in only a very few countries. Tax exempt items are different from zero-rated articles. In both cases no tax amount is added to the selling price, but zero-rated goods or services are taxable at 0% and should always be reported as such in the sales tax report using the <Tax> composite and with zero-rated goods there is usually a possibility of claiming input VAT and including these products in tax reporting. Exempt from tax usually means there is no possibility of claiming input VAT or including the product in tax reports. This varies in different tax jurisdictions and you should always check what the regulations are for the jurisdiction you are reporting in.

TaxExempt/
XML empty element
0…1
<TaxExempt/>
End of Seller charges composite
B.205 Revenue due to publisher per unit

The revenue per unit due to the publisher named in the header in <PublisherParty>. Included for information purposes only, and not included in trailer totals as only the line sales amounts are totalled.

This is the monetary value to be paid to the publisher per unit after all the charges, discounts, commission, refunds and taxes have been deducted from the original price in <PriceAmount>.

UnitAmountDueToPublisher
LineAmountDueToPublisher
0…1
MonetaryAmount MonetaryAmount CurrencyCode CurrencyCode CountryCode CountryCode
<UnitAmountDueToPublisher>
    <MonetaryAmount>23.67</MonetaryAmount>
    <CurrencyCode>GBP</CurrencyCode>
</UnitAmountDueToPublisher>
B.206 Revenue amount

Revenue as a monetary value, mandatory within the <LineAmountDueToPublisher> composite.

MonetaryAmount
Decimal value, two decimal places
1
<MonetaryAmount>23.67</MonetaryAmount>
B.207 Currency code

Optional currency of the revenue due to the publisher.

CurrencyCode
Fixed-length code consisting of three upper case letters from ONIX Codelist 96 (based on ISO 4217)
0…1
<CurrencyCode>GBP</CurrencyCode>
B.208 Country code

Use of this element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format.

The zone associated with this amount is the same as any geographical zone expressed for this line in <Price>.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
End of Revenue due to publisher per unit composite
B.209–212 Revenue due to supplier per unit

The revenue per unit due to the supplier, if reporting to a supplier other than the publisher or content owner. The supplier is named in the header in <SupplierParty>. Included for information purposes only, and not included in trailer totals as only the line sales amounts are totalled.

The structure of the composite is identical to that of <UnitAmountDueToPublisher>.

UnitAmountDueToSupplier
LineAmountDueToSupplier
0…1
End of Revenue due to supplier per unit composite
End of Pricing detail composite
B.213 Total line sales amounts

The total amounts being reported for this line. The amounts will be a multiple of the reported sales quantities for a line.

LineSalesAmount
0…1
GrossSalesAmountBeforeDiscounts GrossSalesAmountBeforeDiscounts DiscountsAmount DiscountsAmount GrossSalesAmount> GrossSalesAmount> RefundedAmount RefundedAmount NetSalesAmount NetSalesAmount SellerCharge SellerCharge LineAmountDueToPublisher LineAmountDueToPublisher LineAmountDueToSupplier LineAmountDueToSupplier CurrencyCode CurrencyCode CountryCode CountryCode RegionCode RegionCode Territory Territory Tax Tax TaxExempt TaxExempt Use only one of three Must not omit both Tax and TaxExempt in Sales tax reports
B.214 Total line gross sales amount before discounts

The gross value of sales for this line item, excluding discounts, commissions, returns, refunds and fees or charges.

This can be used for both agency and reseller models.

GrossSalesAmountBeforeDiscounts
Positive integer
0…1
B.215 Total line sales discounts amount

Discounts or commissions applied to the gross sales quantity of the line item as a whole, including both per unit discount amounts expressed as a percentage of the unit price and any line discount amounts. Only use when reporting sales by transaction.

This can be used for both agency and reseller models.

DiscountsAmount
Real number between zero and 100 (inclusive), including explicit decimal point when required, suggested maximum length 6 characters
0…1
B.216 Total line gross sales amount

Gross value of sales for this line item, including all discounts or commissions but excluding returns, refunds and fees. Mandatory in sales reports but optional in sales tax reports.

This can be used for both agency and reseller models.

GrossSalesAmount
Positive integer
0…1
B.217 Total line refunded Amount

Value to be deducted for quantity sold previously and returned / refunded and reported in Returned / refunded quantity.

This is used in agency models when reporting a refunded quantity.

RefundedAmount
Positive integer or zero
0…1
B.218 Total line net sales amount

The amount of revenue due before any fees are deducted but after deduction of the refunded or returned amount.

NetSalesAmount
Positive or negative integer
0…1
B.219–247 Total line amount seller charges

Line total fees charged by seller, including per unit charges. Optional and repeatable for different types of charges. This has the same structures as <SellerCharge>.

Only the line total fees are included in the trailer summary <TotalSellerChargeAmount>.

SellerCharge
Positive or negative integer
0…1
End of Total line amount seller charge composite
B.248–251 Total revenue due to publisher per line

The total line amount due to the publisher named in the header <PublisherParty> after all deductions. This has the same structures as <UnitAmountDueToPublisher>.

When included line amounts must be shown with sufficient decimal places to ensure that when totalled they match the figure in the message summary <TotalDueToPublisher>.

LineAmountDueToPublisher
0…1
End of Total revenue due to publisher per line composite
B.252–B.255 Total revenue due to supplier per line

Line total amount due to supplier after all the deductions, if reporting to a supplier other than the publisher or content owner. The supplier as named in the header <SupplierParty>. This has the same structures as <UnitAmountDueToPublisher>.

When included line amounts must be shown with sufficient decimal places to ensure that when totalled they match the figure in the message summary <TotalDueToSupplier>.

LineAmountDueToSupplier
0…1
End of Total revenue due to supplier per line composite
B.256 Total line amount currency code

The currency code associated with the amounts reported in <LineSalesAmount>.

CurrencyCode
Fixed-length code consisting of three upper case letters from ONIX Codelist 96 (based on ISO 4217)
0…1
<CurrencyCode>GBP</CurrencyCode>
B.257 Total line amount country code

The country associated with the currency code used for reporting the amounts in <LineSalesAmount>.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
B.258 Total line amount region code

The region associated with the currency code used for reporting the amounts in <LineSalesAmount>.

RegionCode
Variable-length alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
<RegionCode>GB-NIR</RegionCode> (Northern Ireland)
B.259 Total line amount territory

The territory associated with the currency code used for reporting the amounts in <LineSalesAmount>. Use if the zone is more than just one country or region. See <Territory> for structure and examples.

Territory
0…1
B.260 Countries included

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesIncluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesIncluded>US CA</CountriesIncluded>    (USA and Canada)
B.261 Regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Arkansas, Brussels. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

RegionsIncluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
B.262 Countries excluded

One or more standard codes from ISO 3166-1 identifying countries excluded in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesExcluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesExcluded>US CA</CountriesExcluded>    (USA and Canada)
B.263 Regions excluded

One or more ONIX codes identifying regions excluded from the territory. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

RegionsExcluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
End of Total line amount territory composite
B.264–B.281 Total line amount tax

The total tax breakdown for the line. One of either <Tax> or <TaxExempt> is mandatory in Sales tax reports. Both may be omitted in Sales reports, but including one or other is recommended when a Sales report reports sales under agency terms (where the report functions as a combined sales and tax report).

The structure of the <Tax> composite is identical to that in <Price>.

Tax
0…n
End of Total line amount tax composite
B.282 Tax Exempt

An empty element that identifies that the reported total applies to products or transactions that have a statutory exemption from tax in a particular tax jurisdiction. Optional.

<TaxExempt/> must not be sent if it is immediately preceded by an instance of the <Tax> composite.

Note that tax exempt status is rare and applies in only a very few countries. Tax exempt items are different from zero-rated articles. In both cases no tax amount is added to the selling price, but zero-rated goods or services are taxable at 0% and should always be reported as such in the sales tax report using the <Tax> composite and with zero-rated goods there is usually a possibility of claiming input VAT and including these products in tax reporting. Exempt from tax usually means there is no possibility of claiming input VAT or including the product in tax reports. This varies in different tax jurisdictions and you should always check what the regulations are for the jurisdiction you are reporting in.

TaxExempt/
XML empty element
0…1
<TaxExempt/>
End of Total line sales amounts composite
B.283–B.306 Selling agent party

The selling agent should be specified only when the report as a whole list individual transactions or aggregated sales through a number of retailers or resellers, and the line item is specific to a single retail outlet.

The more flexible <SellingAgentParty> composite is preferred to the use of the simple <RetailOutlet> composite.

The structure of the <SellingAgentParty> composite is identical to that of <SellingAgentParty> in the message header.

SellingAgentParty
0…1
End of Selling agent party composite
B.307 Retailer party

The retailer party should be specified only when the report as a whole list individual transactions or aggregated sales through a number of retailers, and the line item is specific to a single retail outlet.

The more flexible <SellingAgentParty> composite is preferred to the use of the simple <RetailParty> composite. This is the only party composite that does not use the full party structure.

RetailerParty
0…1
PartyName PartyName
<PartyName>
    <NameLine>Main Street Bookstores Inc</NameLine>
    <NameLine>Narragansett Branch</NameLine
</PartyName>
B.308 Retailer name

The name of the retail outlet, mandatory within <RetailerParty>.

PartyName
Text, suggested maximum length 50 characters
1
NameLine NameLine
B.309 Name line

The name of the retail outlet, mandatory within <RetailerParty>. Repeatable if address is more than one line.

NameLine
Variable length text, suggested maximum length 100 characters
1…n
End of Retailer party composite
B.310 Line trading zone

Every Sales report and Sales tax report must specify the market – the Trading zone or Trading territory – within which the reported sales were, or could have been, made. If all <ItemDetail> composites (individual report lines) are based on the same Trading zone or territory, then the Trading zone may be specified using <TradingZone> or <Territory> either in the Header or individually for every line item in the report. If for any reason the Trading zone or territory for individual report lines varies, then the Trading zone or territory must be specified individually within every <ItemDetail> composite, and <TradingZone> and <Territory> must be omitted from the Header.

A trading zone or market comprises one or more countries and sub-national regions, or the entire world. Note that in <TradingZone>, only additive combination is allowed – sales in the ‘48 contiguous states’ must specify 48 individual Region codes, not ‘USA minus two states’. Use of <Territory> may be more succinct, as it enables both additive and subtractive combination. The preferred method for specifying the market covered by the report is to use <Territory> in the Header or <Territory> within the <ItemDetail> composite . Use of <TradingZone> element is deprecated, but it is retained to maintain backwards compatibility with previous releases of this format.

TradingZone
One or more variable-length alphanumeric codes from List 91 (based on ISO 3166-1) or List 49 (based on ISO 3166-2). Successive codes are separated by a space
0…1
B.311 Line trading territory

The trading territory that applies to this line. This is the trading territory where the reported line sales were made or could have been made. Even if no sales were reported on this occasion in some of the countries or regions specified in the line trading territory the complete line trading territory associated with this line in this report should always be given for consistency and clarity.

This area may be the same as the country or region associated with the transaction reported in the line or maybe a larger area of which the region or country or territory associated with a transaction is a sub-set.

Only use on line level if this was not reported in the header <Territory> and the territory varies from line to line, for example if reporting for individual selling agent parties.

Territory
0…1
B.312 Countries included

One or more ISO standard codes identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesIncluded
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
0…1
B.313 Regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Arkansas, Brussels. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

RegionsIncluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
B.314 Countries excluded

One or more ISO standard codes identifying countries excluded from the territory. Optional and non-repeating, and can only occur if the <RegionsIncluded> element is also present and includes a supra-national region code (such as ‘World’).

CountriesExcluded
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
0…1
B.315 Regions excluded

One or more ONIX codes identifying regions excluded from the territory. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

RegionsExcluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
End of Territory composite
End of Item detail

Message trailer

T.1 Summary

A summary of the amounts in the report.

Summary
1
NumberOfLines NumberOfLines NumberOfUnits NumberOfUnits NumberOfGrossSalesUnits NumberOfGrossSalesUnits NumberOfRefundedUnits NumberOfRefundedUnits NumberOfNetSalesUnits NumberOfNetSalesUnits NumberOfNonSaleUnits NumberOfNonSaleUnits TotalSalesAmounts TotalSalesAmounts TotalDueToPublisher TotalDueToPublisher TotalDueToSupplier TotalDueToSupplier Use only for reseller model unit totals Use only for agency model unit totals One or both of these must always be included in totals
T.2 Total number of line items

The total number of lines reported.

NumberOfLines
Integer number
1
<NumberOfLines>568</NumberOfLines>
T.3 Total number of units

The sum of all reported quantities reported in <Quantity> sold.

Used only when reporting total sales units made under the wholesale or reseller model. When reporting totals for agency model sales, use the elements from <NumberOfGrossSalesUnits> to <TotalSalesAmounts> instead.

NumberOfUnits
Integer number
0…1
<NumberOfUnits>3068</NumberOfUnits>
T.4 Total number of gross sales units

The sum of all gross sales quantities sold, excluding any adjustment for returns or refunds, reported in <GrossSoldQuantity>.

Used only when reporting total sales under the agency model. Must be used along with <NumberOfRefundedUnits> and <NumberOfNetSalesUnits>.

NumberOfGrossSalesUnits
Integer number
0…1
<NumberOfGrossSalesUnits>78</NumberOfGrossSalesUnits>
T.5 Total number of refunded units

The sum of refunded quantities reported in <RefundedQuantity>.

Used only when reporting total sales under the agency model. Must be used along with <NumberOfGrossSalesUnits> and <NumberOfNetSalesUnits>. If no Refunded Quantities were reported this should be zero when reporting agency sales.

NumberOfRefundedUnits
Integer number
0…1
<NumberOfRefundedUnits>23</NumberOfRefundedUnits>
T.6 Total number of net sales units

The sum of quantities reported in <NetSoldQuantity>.

Used only when reporting total sales under the agency model. Must be used along with <NumberOfGrossSalesUnits> and <NumberOfRefundedUnits>.

NumberOfNetSalesUnits
Integer number
0…1
<NumberOfNetSalesUnits>233</NumberOfNetSalesUnits>
T.7 Total number of non sale units

The sum of quantities reported in <NonSaleDisposal> composite.

NumberOfNonSaleUnits
Integer number
0…1
<NumberOfNonSaleUnits>47</NumberOfNonSaleUnits>
T.8 Total sales amounts

The sum of all the currency amounts reported for all lines in <LineSalesAmount>.

Repeatable if reporting totals in different currencies and/or different territories within the report trading territory, and specifically for Sales Tax Report for tax totals for different tax jurisdictions.

TotalSalesAmounts
0…n
TotalGrossSalesAmount TotalGrossSalesAmount TotalRefundedSalesAmount TotalRefundedSalesAmount TotalNetSalesAmount TotalNetSalesAmount TotalSellerChargeAmount TotalSellerChargeAmount CurrencyCode CurrencyCode CountryCode CountryCode RegionCode RegionCode Territory Territory Tax Tax TaxExempt TaxExempt Use only one of three Must not omit both Tax and TaxExempt in Sales tax reports
T.9 Total gross sales amounts

The total gross sales value (so including discounts but excluding returns, refunds and fees) for all lines as reported in <GrossSalesAmount> .

TotalGrossSalesAmount
Integer number
0…1
T.10 Total refunded sales amount

The total returned / refunded sales value for all lines as reported in <RefundedAmount>.

TotalRefundedSalesAmount
Integer number
0…1
T.11 Total net sales amount

The total net sales values before fees for all lines as reported in <NetSalesAmount> .

TotalNetSalesAmount
Integer number
0…1
T.12 Total seller charge amount

The total value of charges / fees for all lines as reported in <SellerCharge>.

TotalSellerChargeAmounts
Integer number
0…1
T.13 Total sales amount currency code

The currency associated with the total amounts reported, optional but recommended for clarity. Mandatory if more than one currency is being reported.

CurrencyCode
Fixed-length code consisting of three upper case letters from ONIX Codelist 96 (based on ISO 4217)
0…1
<CurrencyCode>GBP</CurrencyCode>
T.14 Total sales amount country code

The country associated with the currency code used for reporting the total amounts in <TotalSalesAmounts>.

Optional but recommended for clarity if <RegionCode> or <Territory> not present. Mandatory especially if reporting different total tax amounts in the same currency for more than one country.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
T.15 Total sales amount region code

The region associated with the currency code used for reporting the total amounts in <TotalSalesAmounts>.

Optional but recommended for clarity if <Territory> or <CountryCode> not present. Mandatory especially if reporting different total tax amounts in the same currency for more than one region in a country.

RegionCode
Variable-length alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
T.16 Total sales amount territory

The territory associated with the currency code used for reporting the total amounts in <TotalSalesAmounts>.

Optional but recommended for clarity if <RegionCode> or <CountryCode> not present. Mandatory especially if reporting different total tax amounts in the same currency for more than one territory.

Territory
0…1
T.17 Countries included

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesIncluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesIncluded>US CA</CountriesIncluded>    (USA and Canada)
T.18 Regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Arkansas, Brussels. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

RegionsIncluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
T.19 Countries excluded

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesExcluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesExcluded>US CA</CountriesExcluded>    (USA and Canada)
T.20 Regions excluded

One or more ONIX codes identifying regions excluded from the territory. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

RegionsExcluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
End of Total sales amount territory composite
T.21 Total tax

The sum of all the tax values being reported in total line amount tax <Tax>.

If reporting total tax amounts, for different tax rates or types, in different currencies or for different zones then <TotalSalesAmount> composite should be repeated. Each <Tax> composite must contain a <TaxTypeCode> element, and at least one of <TaxAmount> or <TaxRatePercent plus <TaxableAmount>. Best practice is to include all of these for clarity. <TaxableAmount> must be present if <Tax> is repeated or <TaxComponent> is used.

Tax
0…1
TaxType TaxType or TaxTypeCode TaxTypeName TaxTypeName TaxRateCode TaxRateCode TaxRatePercent TaxRatePercent or Percent TaxableAmount TaxableAmount or AmountTaxable TaxAmount TaxAmount TaxComponent TaxComponent Must not omit both Must not omit if <Tax> is repeated
T.22 Tax type

Mandatory indicator of the type of tax being reported in this total.

If using the values from list 171 the <Price> <CountryCode>, <RegionCode> or <Territory> composite indicate which zone the tax is applicable to. Use a value from list 171 if there is no separate code for the tax type and jurisdiction you are reporting on.

TaxType
must contain one of the following:
Two-digit code from ONIX Codelist 171
CAGSTCanadian Goods and Services Tax
CAHSTCanadian Harmonized Sales Tax
USSTUS Sales and Use Tax
AUGSTAustralian Goods and Services Tax
NZGSTNew Zealand Goods and Services Tax
EUVATEuropean Union VAT. The country should be identified by the ShipTo or BillTo party or location
ISVATIcelandic VAT
NOVATNorwegian VAT
CHVATSwiss VAT
INVATIndian VAT
KRVATKorean VAT
JPCTJapanese Consumption Tax
Proprietarymust be identified in <TaxTypeName>
1
T.23 Tax type name

The name of the type of tax. Mandatory when <TaxTypeCode> is Proprietary, and omitted for any other value of <TaxTypeCode>.

TaxTypeName
Text, suggested maximum length 50 characters
0…1
T.24 Tax rate code

A code which specifies into which tax rate type (standard, reduced, zero rate etc) the product being reported on is classified.

For example a printed book sold in Denmark would be classified as S – Standard, whereas a book sold in France would be in R – Reduced, and book in Ireland in Z – Zero rated.

This is optional but is recommended for clarity.

TaxRateCode
Fixed format, one letter from ONIX Codelist 62
0…1
<TaxRateCode>R</TaxRateCode> (Reduced Rate)
T.25 Tax rate percentage

The actual tax rate percentage applicable to this reported amount.

TaxRatePercent
Percent
Percentage as a real number. A tax levied at 17.5% would be 17.5
0…1
<TaxRatePercent>2.1</TaxRatePercent>
T.26 Total taxable amount

The total amount subject to tax for all lines reported in <LineSalesAmount> – <TaxableAmount>.

TaxableAmount
AmountTaxable
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxableAmount>48.97</TaxableAmount
T.27 Total tax amount

The total amount of tax for all lines at this rate, percentage and territory reported in <LineSalesAmount> – <TaxAmount> .

TaxAmount
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxAmount>1.03</TaxAmount>
T.28 total tax components

Where the tax levied consists of a number of separate taxes, each tax component total can be detailed separately in an optional <TaxComponent> composite.

These are the total components, as reported in <LineSalesAmount> – <TaxComponent> for each total tax sums reported here.

TaxComponent
0…1
TaxComponentTypeCode TaxComponentTypeCode TaxComponentTypeName TaxComponentTypeName TaxRateCode TaxRateCode TaxRatePercent TaxRatePercent or Percent TaxableAmount TaxableAmount or AmountTaxable TaxAmount TaxAmount Must not omit both Must not omit if <Tax> is repeated
T.29 Total tax component type

Mandatory type of each tax component.

TaxComponentTypeCode
must be one of the following:
GSTFederalCanadian GST federal component
GSTProvincialCanadian GST provincial component
USStateUS State sales tax
USCountyUS County sales tax
USCityUS City sales tax
USDistrictUS District sales tax
Proprietarymust be named in <TaxComponentTypeName>
1
<TaxComponentTypeCode>USState</TaxComponentTypeCode> (Reduced Rate)
T.30 Total tax component type name

A name for a tax component must be included when <TaxComponentTypeCode> is Proprietary and omitted for all other values of <TaxComponentTypeCode.

TaxComponentTypeName
Variable length text, suggested maximum length 50 characters
0…1
T.31 Total tax rate code

Dependent on the tax component type.

TaxRateCode
Fixed format, one letter from ONIX Codelist 62
0…1
<TaxRateCode>S</TaxRateCode> (Standard Rate)
T.32 Total tax rate percentage

The actual rate at which the tax is levied on the taxable part of the price.

This is optional but is recommended for clarity.

TaxRatePercent
Percent
Percentage as a real number. A tax levied at 17.5% would be 17.5
0…1
<TaxRatePercent>9</TaxRatePercent>
T.33 Total taxable amount

The amount of the price excluding tax which is taxable at the rate specified, as a monetary amount. The tax is calculated on this amount and then added to the price to give a total price including tax.

The total amount subject to tax for all lines reported in <TaxComponent> – <TaxableAmount> for each type of tax type and rate.

TaxableAmount
AmountTaxable
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxableAmount>9.00</TaxableAmount
T.34 Total tax amount

The amount of tax chargeable on the taxable part of the price at the rate specified, as a monetary amount. This will be the amount added to the Taxable Amount to give the total price including any taxes.

The total amount of tax for all lines at this rate, type percentage and territory reported in <TaxComponent> – <TaxAmount> .

TaxAmount
Decimal number, usually two decimal places (for most currencies)
0…1
<TaxAmount>0.81</TaxAmount>
End of Tax component composite
End of Tax composite
T.35 Total tax exempt flag

An empty element that identifies that the reported total applies to products or transactions that have a statutory exemption from tax in a particular tax jurisdiction. Optional.

<TaxExempt/> must not be sent if it is immediately preceded by an instance of the <Tax> composite.

Note that tax exempt status is rare and applies in only a very few countries. Tax exempt items are different from zero-rated articles. In both cases no tax amount is added to the selling price, but zero-rated goods or services are taxable at 0% and should always be reported as such in the sales tax report using the <Tax> composite and with zero-rated goods there is usually a possibility of claiming input VAT and including these products in tax reporting. Exempt from tax usually means there is no possibility of claiming input VAT or including the product in tax reports. This varies in different tax jurisdictions and you should always check what the regulations are for the jurisdiction you are reporting in.

TaxExempt/
XML empty element
0…1
<TaxExempt/>
End of Total sales amounts composite
T.36 Total amount due to publisher

The total revenue due to the publisher which must match any payment. Either this or <TotalDueToSupplier> or both must be included in the Trailer of each message. Repeatable if reporting sales in multiple currencies.

If <LineAmountDueToPublisher> are stated in the message, this total must match the sum of those amounts without rounding discrepancies.

TotalDueToPublisher
0…1
MonetaryAmount MonetaryAmount CurrencyCode CurrencyCode CountryCode CountryCode RegionCode RegionCode Territory Territory Use only one of three
T.37 Total monetary amount due to publisher

The total amount due to the publisher.

MonetaryAmount
Decimal number, usually two decimal places (for most currencies)
1
<MonetaryAmount>756.98</MonetaryAmount>
T.38 Total amount due to publisher currency code

The currency associated with the total revenue amount due to the publisher, optional but recommended for clarity. Mandatory if more than one currency is being reported.

CurrencyCode
Fixed-length code consisting of three upper case letters from ONIX Codelist 96 (based on ISO 4217)
0…1
<CurrencyCode>GBP</CurrencyCode>
T.39 Total amount due to publisher country code

The country associated with the currency code used for reporting the total revenue due to the publisher.

Optional but recommended for clarity if <RegionCode> or <Territory> not present. Mandatory especially if reporting different totals in the same currency for more than one country.

CountryCode
Two upper-case letters from ONIX Codelist 91 (based on ISO 3166-1)
<CountryCode>GB</CountryCode>
T.40 Total amount due to publisher region code

The region associated with the currency code used for reporting the total revenue due to the publisher.

Optional but recommended for clarity if <Territory> or <CountryCode> not present. Mandatory especially if reporting different totals in the same currency for more than one region.

RegionCode
Variable-length alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
T.41 Total amount due to publisher territory

The territory associated with the currency code used for reporting the total revenue due to the publisher.

Optional but recommended for clarity if <RegionCode> or <CountryCode> not present. Mandatory especially if reporting different totals in the same currency for more than one territory.

Territory
0…1
T.42 Countries included

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesIncluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesIncluded>US CA</CountriesIncluded>    (USA and Canada)
T.43 Regions included

One or more ONIX codes identifying regions included in the territory. A region is an area which is not a country, but which is precisely defined in geographical terms, eg World, Arkansas, Brussels. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

RegionsIncluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
T.44 Countries excluded

One or more standard codes from ISO 3166-1 identifying countries included in the territory. Optional and non-repeating, but either <CountriesIncluded> or <RegionsIncluded> is mandatory in each occurrence of the <Territory> composite.

CountriesExcluded
One or more codes, each of two upper-case letters from ONIX Codelist 91 successive codes being separated by a space
0…1
<CountriesExcluded>US CA</CountriesExcluded>    (USA and Canada)
T.45 Regions excluded

One or more ONIX codes identifying regions excluded from the territory. Optional and non-repeating, and can only occur if the <CountriesIncluded> element is also present (and specifies countries of which the excluded regions are a part), or if <RegionsIncluded> is present and includes a supra-national region code (such as ‘World’).

RegionsExcluded
Alphanumeric code from ONIX Codelist 49 (based on ISO 3166-2)
0…1
End of Total sales amount territory composite
End of Total amount due to publisher composite
T.46–55 Total amount due to supplier

The total revenue due to the supplier which must match any payment. Either this or <TotalDueToPublisher> or both must be included in the Trailer of each message. Repeatable if reporting sales in multiple currencies.

If <LineAmountDueToSupplier> are stated in the message, this total must match the sum of those amounts without rounding discrepancies.

The structure of the <TotalDueToSupplier> composite is identical to that of <TotalDueToPublisher> .

TotalDueToSupplier
0…1
End of Total amount due to supplier composite

End of Summary

End of Sales or Sales tax report

Appendices

Appendix 1: SalesReport and SalesTaxReport – Differences

  • in <Header>
    • <SalesReport> or <SalesTaxReport> top level element
    • <SalesTaxReportType> is only used in <SalesTaxReport>
    • <SalesReportTypeCode> is only used in <SalesReport>
  • in <ItemDetail>
    • <ProductIdentifier> is mandatory in <SalesReport> but optional in <SalesTaxReport>
    • <PricingDetail> is mandatory in <SalesReport> but optional in <SalesTaxReport>
    • Both <Tax> and <TaxExempt> may be omitted from <SalesReport>, but one or other is mandatory in <SalesTaxReport>
  • in <Summary>
    • Both <Tax> and <TaxExempt> may be omitted from <SalesReport>, but one or other is mandatory in <SalesTaxReport> within <TotalSalesAmounts>

Appendix 2: Glossary

Agency model
Business model based on the idea that a publisher sells to the end customer, and is wholly responsible for setting the price. The retailer (or Selling agent) acts as an intermediary or agent to facilitate the sale, and takes a fixed commission from the publisher.
Alias
Informal term used in EDItX documentation to refer to an alternative tag name for a particular XML data element. For example, the alias <Identifier> can be used in place of the <IDValue> tag. Aliases are used to maintain some level of compatibility with older versions of the Sales and Sales Tax report format, but those using aliases in reports are encouraged to update to the newer tag name as soon as practicable.
ASP
Actual selling price, the price collected by a retailer in a sale to the end customer (occasionally termed the Street price). This may be lower (or, very occasionally, higher) than the RRP. This is the only price type that can be reported in EDItX but not sent in ONIX for Books.
Bill To Location
The location of the billing address of the party that has purchased the goods reported. Required in some tax jurisdictions along with the ship to location. Usually used for individuals who have purchased something as only mentions a location and no personal details.
Bill To Party
The details of the billing address of the party that has purchased the goods reported. Required in some tax jurisdictions along with the ship to location. Usually used for companies or institutions who have purchased something as a tax registration number or equivalent can be sent.
Codelist
Informal term used in ONIX and EDItX documentation for a controlled vocabulary or authority file, for example a list of different types of price RRP, FRP, Net, Agency and so on. Some EDItX codelists consist of English words, and some define a language-independent notation – the code – for each term in the vocabulary.
Composite
Informal term used in ONIX and EDItX documentation to refer to an XML element or tag that contains only other XML tags (and contains no data of its own). A composite acts as a wrapper around a set of closely-related data elements, largely to enable them to be repeated in a neatly structured way. eg the repeatable <ProductIdentifier> composite contains three data elements, <ProductIDType>, <IDTypeName>, and <IDValue>.
Consignment
Consignment terms mean the product is still owned by the upstream party (publisher, distributor or wholesaler), even though it is physically stocked by the downstream party (wholesaler or retailer). Conceptually, the downstream party ‘buys’ the goods only after selling them on to another party – typically the end purchaser. cf Sale or return.
FRP
Fixed retail price, a price chosen by the publisher for retail sales to the consumer. In contrast to the RRP, legal restrictions in certain countries prevent retailers selling books significantly below the price set by the publisher (or occasionally, by the importer).
GST
Goods and Services Tax – a form of indirect tax similar to Value added tax used in countries like Canada, Australia, New Zealand and India.
Net price
Generally, a price after tax, trade discounts and other adjustments are made – in effect, a business-to-business price.
Publisher Party
The organization responsible for making the product available, and generally the one taking the financial risk. The publisher will often be a recipient of the sales or sales tax report.
Receiving Party
The organization responsible for receiving the sales or sales tax report, when different from the Publisher and Supplier.
Reporting Party
The organization responsible for creating the sales or sales tax report, when different from the Seller or Selling agent.
Reseller model
Business model based on the idea that the publisher sells to a chain of distributors, wholesalers and retailers. The business-to-business transactions are based on RRP minus a trade discount, or on wholesale terms, and the retailer is responsible for setting the price for the sale to the end customer.
RRP
Recommended retail price, a price chosen and recommended by the publisher for retail sales to the consumer (occasionally termed SRP – the Suggested retail price). The retailer may choose to sell the book to the end customer at this price, or may choose a different price point.
Seller Party
A stockholding organization, usually the one creating the sales or sales tax report, or at least the organization responsible for the sales being reported on. For purely digital products, the Seller party is the organization that fulfills the product to the end purchaser (and therefore is not necessarily the retailer). For products sold on agency terms, a Selling agent may report on (e-book) sales or sales tax instead.
Selling Agent Party
Organization responsible for facilitating the sale (by the Publisher) to the end purchaser under an agency agreement. Similar to the Seller, but works on a commission for each sale rather than purchasing products and then reselling them at a higher price.
Ship To Location
The location of the address where the purchased goods being reported were shipped. Required in some tax jurisdictions along with the bill to location. Usually used for individuals who have purchased something as it only mentions a location and no personal details.
Ship To Party
The details of the shipping address of the party that has purchased the goods reported. Required in some tax jurisdictions along with the bill to location. Usually used for companies or institutions who have purchased something as a tax registration number or equivalent can be sent.
Supplier Party
The organization that supplied the products that are being reported on but that is neither the publisher nor the content owner.
SUT
Sales and Use Tax – forms of indirect tax used in the USA. A Sales Tax is generally a tax applied to the retail sale of tangible personal property and certain specifically enumerated services. Although the form of the tax may vary, it usually is imposed either directly upon the retail sale of the taxable item, the gross receipts from the sales of taxable items, or the person engaged in the business of making retail sales of taxable items. The Use tax complements the Sales Tax; it typically is assessed on purchases made out of State and brought into the jurisdiction for use, storage, or consumption in the State. It is also levied when a supplier fails to collect a Consumer Sales Tax.
VAT
Value Added Tax – a type of tax that is assessed incrementally, based on the increase in value of a product or service at each stage of production or distribution. A turnover tax levied on the supply of goods and services when performed in a business environment, as well as on the importation of goods and services. VAT incurred on purchases or levied on importation can in principle be offset against the VAT due on sales. This credit/debit system has features within each jurisdiction arising from specific needs and circumstances.
VAT – Input
VAT that is paid by a business to other businesses on the supplies that it receives is known as ‘input VAT’ (that is, VAT on its input supplies). A business is generally able to recover input VAT to the extent that the input VAT is attributable to (that is, used to make) its taxable outputs. Input VAT is recovered by setting it against the output VAT for which the business is required to account to the government, or, if there is an excess, by claiming a repayment from the government. Private people are generally allowed to buy goods in any member country and bring it home and pay only the VAT to the seller. Input VAT that is attributable to VAT-exempt supplies is not recoverable.
VAT – Output
VAT that is charged by a business and paid by its customers is known as ‘output VAT’ (that is, VAT on its output supplies).
Wholesale price
Business-to-business prices in the book trade in many countries are often based on the RRP (or FRP) minus a trade discount. An alternative is a net or wholesale price – set lower than the RRP, but not ordinarily subject to a further trade discount.
XML schema
An XML schema formally defines the set of XML tags that can be used in a particular document format, and the order in which they must occur. It defines how tags are nested within other tags (composites), and whether they are optional, mandatory, repeatable (their cardinality). To some degree, a schema also defines the type of data allowed within each tag – whether it is free text, a real number or integer, a date etc, or a term from a controlled vocabulary (a codelist). Note only XSD schemas are available for EDItX messages.