Data Cat

Utilities Data Type Catalog - Definitions of Utilities Data Types and Core Data Types

2012 SAP AGDietmar-Hopp-Allee 16D-69190 Walldorf

Intellectual Property Rights and Copyright protectedPage 1

Author:

SAP for Utilities

Utilities Data TypeCatalog

HistoryVersion Status Date

1.1 18.07.2013




Contents1 Introduction .......................................................................................... 91.0 BillingRateCode .......................................................................................... 101.1 BillingRateGroupDeterminationCode ........................................................ 131.2 BillingRateGroupingCode ........................................................................... 161.3 BusinessDocumentMessageHeader .......................................................... 191.4 BusinessPartnerID ...................................................................................... 241.5 CalorificValue .............................................................................................. 261.6 CashDepositRequestWaiverReasonCode ................................................. 281.7 CLOSED_LOCAL_DateTimePeriod ............................................................ 311.8 CLOSED_UNBOUNDED_TimePointPeriod ................................................ 331.9 Code ............................................................................................................. 351.10 ContractAccountID...................................................................................... 401.11 ContractAccountsReceivablesPayablesPostingDocumentTypeCode .... 421.12 ContractAccountsReceivablesPayablesSettlementProcedureCode ....... 451.13 CorrespondenceCommunicationProfileCode ........................................... 501.14 CorrespondenceTypeGroupCode .............................................................. 531.15 CountyCode ................................................................................................. 561.16 CreditRiskClassCode .................................................................................. 601.17 CustomerContractGroupCode ................................................................... 631.18 Date .............................................................................................................. 661.19 DecimalValue ............................................................................................... 691.20 DecimalValuePrecision ............................................................................... 751.21 Description .................................................................................................. 771.22 IncomingPaymentProcedureCode ........................................................... 114




1.23 Indicator ..................................................................................................... 1171.24 InvoiceLegallyRequiredID ......................................................................... 2241.25 MeasureUnitCode ...................................................................................... 2271.26 MeterReaderNoteCode .............................................................................. 2441.27 MeterReadingCategoryCode .................................................................... 2471.28 MeterReadingDocumentID ........................................................................ 2491.29 MeterReadingDocumentResultStatusCode ............................................. 2521.30 MeterReadingDocumentStatusCode........................................................ 2541.31 MeterReadingReasonCode ....................................................................... 2561.32 MeterReadingResultAdjustmentFactorValue .......................................... 2591.33 MeterReadingResultValue ........................................................................ 2611.34 MeterReadingTypeCode ........................................................................... 2631.35 NumberValue ............................................................................................. 2661.36 OutgoingPaymentProcedureCode ........................................................... 2761.37 PartyRoleCategoryCode ........................................................................... 2791.38 PartyRoleCode .......................................................................................... 2961.39 Percent ....................................................................................................... 3011.40 PeriodQuantitySpecification .................................................................... 3231.41 PoliticalRegionalStructureElementCode ................................................. 3251.42 ProcessComponentCode .......................................................................... 3281.43 ProductInternalID ...................................................................................... 3581.44 ProductStandardID.................................................................................... 3611.45 ProductTaxAccountDeterminationCode .................................................. 3641.46 ProductTaxationCharacteristicsCode ...................................................... 3671.47 Quantity ..................................................................................................... 4191.48 SerialID....................................................................................................... 447




1.49 ServiceIndustriesBusinessAgreementCategoryCode ............................ 4491.50 ServiceIndustriesBusinessAgreementDataOriginTypeCode ................. 4511.51 ServiceIndustriesBusinessAgreementID ................................................. 4541.52 ServiceIndustriesBusinessAgreementTaxAccountDeterminationMethodCode 4561.53 TaxJurisdictionCode ................................................................................. 4591.54 Text ............................................................................................................ 4711.55 Time ........................................................................................................... 4871.56 TimeZoneCode .......................................................................................... 4911.57 UtilitiesAdvancedMeterCapabilityCode ................................................... 4971.58 UtilitiesAdvancedMeteringDataOriginTypeCode .................................... 5001.59 UtilitiesAdvancedMeteringSystemID ....................................................... 5021.60 UtilitiesAmountStatisticsGroupCode ....................................................... 5041.61 UtilitiesBilledResultTypeCode.................................................................. 5071.62 UtilitiesBillingScheduleContractGroupCode ........................................... 5091.63 UtilitiesBillingTermsCode ......................................................................... 5111.64 UtilitiesBillingTermsGroupCode .............................................................. 5141.65 UtilitiesConnectionStatusChangeRequestActivityCategoryCode ......... 5171.66 UtilitiesConnectionStatusChangeRequestActivityID .............................. 5191.67 UtilitiesConnectionStatusChangeRequestCategoryCode ...................... 5211.68 UtilitiesConnectionStatusChangeRequestID .......................................... 5241.69 UtilitiesConnectionStatusChangeRequestReasonCode ........................ 5261.70 UtilitiesConnectionStatusChangeResultCode ........................................ 5281.71 UtilitiesContractBillingBlockingReasonCode ......................................... 5301.72 UtilitiesContractBillingUnblockingReasonCode ..................................... 5321.73 UtilitiesDeviceCategoryCode.................................................................... 5341.74 UtilitiesDeviceID ........................................................................................ 536




1.75 UtilitiesDeviceLogicalID ............................................................................ 5381.76 UtilitiesDeviceOperationalStateCategoryCode ....................................... 5401.77 UtilitiesDeviceOperationalStateTypeCode .............................................. 5421.78 UtilitiesDeviceRegisterGroupID ............................................................... 5451.79 UtilitiesDeviceRegisterID .......................................................................... 5471.80 UtilitiesDeviceRelationshipRoleCode ...................................................... 5491.81 UtilitiesDivisionCategoryCode ................................................................. 5511.82 UtilitiesDivisionCode ................................................................................ 5531.83 UtilitiesEnergySettlementCategoryCode ................................................. 5561.84 UtilitiesEnergySettlementMethodCode .................................................... 5591.85 UtilitiesEnergySettlementUnitID ............................................................... 5621.86 UtilitiesEnergySettlementUnitPartyID ...................................................... 5641.87 UtilitiesGridID ............................................................................................ 5661.88 UtilitiesGridLevelCode .............................................................................. 5681.89 UtilitiesGridLevelTypeCode ...................................................................... 5711.90 UtilitiesGridPartyID ................................................................................... 5741.91 UtilitiesGridUsageDocumentID ................................................................ 5761.92 UtilitiesGridUsageEnrollmentReasonCode ............................................. 5781.93 UtilitiesGridUsageRequestID .................................................................... 5801.94 UtilitiesGridUsageRequestPartyID ........................................................... 5821.95 UtilitiesGridUsageTerminationReasonCode ........................................... 5841.96 UtilitiesGridVoltageLevelCode ................................................................. 5861.97 UtilitiesInvoiceCancellationReasonCode ................................................ 5881.98 UtilitiesInvoiceID ....................................................................................... 5911.99 UtilitiesInvoiceItemID ................................................................................ 5931.100 UtilitiesInvoiceItemTypeCode................................................................... 595




1.101 UtilitiesInvoiceReasonCode ..................................................................... 6061.102 UtilitiesInvoiceReleaseHistoryID .............................................................. 6081.103 UtilitiesInvoiceRequestBillingPeriodAllocationText ............................... 6101.104 UtilitiesInvoiceRequestDiscountCode ..................................................... 6121.105 UtilitiesInvoiceRequestID ......................................................................... 6151.106 UtilitiesInvoiceRequestItemGroupCode .................................................. 6171.107 UtilitiesInvoiceRequestItemID .................................................................. 6201.108 UtilitiesInvoiceRequestItemProcessingTypeCode .................................. 6221.109 UtilitiesInvoiceRequestItemTypeCode ..................................................... 6241.110 UtilitiesInvoiceRequestReasonCode ....................................................... 6331.111 UtilitiesInvoiceRequestReleaseHistoryID ................................................ 6351.112 UtilitiesInvoiceRequestRevisionReasonCode ......................................... 6371.113 UtilitiesInvoiceRequestSimulationReasonCode ..................................... 6401.114 UtilitiesInvoiceRequestSimulationScenarioCode ................................... 6421.115 UtilitiesInvoiceRequestValidationTypeCode ........................................... 6451.116 UtilitiesInvoiceRevisionReasonCode....................................................... 6481.117 UtilitiesInvoiceValidationTypeCode ......................................................... 6501.118 UtilitiesLoadShapeFactorDeterminationCode ......................................... 6531.119 UtilitiesLoadShapeFactorSpecification ................................................... 6551.120 UtilitiesLoadShapeFactorValue ................................................................ 6571.121 UtilitiesManualBillingBusinessTransactionTypeCode ........................... 6591.122 UtilitiesMeasurementRecurrenceCode .................................................... 6621.123 UtilitiesMeasurementTaskCategoryCode ................................................ 6651.124 UtilitiesMeasurementTaskDeviceAssignmentTypeCode ........................ 6671.125 UtilitiesMeasurementTaskID ..................................................................... 6691.126 UtilitiesMeasurementTaskKindCode........................................................ 671




1.127 UtilitiesMeasurementTaskRelationshipRoleCode ................................... 6741.128 UtilitiesMeasurementTaskRelationshipTypeCode .................................. 6771.129 UtilitiesMeasurementTaskValidationProfileCode .................................... 6801.130 UtilitiesObjectIdentificationSystemCodeText ......................................... 6821.131 UtilitiesOnSiteBillingCustomerContractGroupCode .............................. 6841.132 UtilitiesPointOfDeliveryCategoryCode .................................................... 6871.133 UtilitiesPointOfDeliveryIdentifierPatternCode ......................................... 6891.134 UtilitiesPointOfDeliveryInternalID ............................................................ 6921.135 UtilitiesPointOfDeliveryPartyID ................................................................ 6941.136 UtilitiesPointOfDeliveryPremiseDataTypeCode ...................................... 6961.137 UtilitiesPointOfDeliverySupplyScenarioCategoryCode .......................... 6981.138 UtilitiesPointOfDeliverySupplyScenarioCode ......................................... 7011.139 UtilitiesPointOfDeliveryTypeCode ........................................................... 7041.140 UtilitiesPrice .............................................................................................. 7061.141 UtilitiesPriceAmount ................................................................................. 7081.142 UtilitiesPriceSpecificationCategoryCode ................................................ 7101.143 UtilitiesPriceSpecificationLevelCode....................................................... 7121.144 UtilitiesPriceSpecificationScaleItemID .................................................... 7151.145 UtilitiesQuantityAdjustmentFactorValue ................................................. 7171.146 UtilitiesQuantityStatisticsGroupCode ...................................................... 7191.147 UtilitiesServiceDisconnectionReasonCode ............................................. 7211.148 UtilitiesServiceProviderID ......................................................................... 7231.149 UtilitiesServiceProviderPartyID ................................................................ 7251.150 UtilitiesServiceProviderRoleCategoryCode ............................................ 7271.151 UtilitiesServiceProviderRoleCode ............................................................ 7291.152 UtilitiesSmartMeterEventCategoryCode .................................................. 731




1.153 UtilitiesSmartMeterEventID ...................................................................... 7331.154 UtilitiesSmartMeterEventOriginTypeCode............................................... 7351.155 UtilitiesSmartMeterEventPropertyCode ................................................... 7381.156 UtilitiesSmartMeterEventSeverityCode ................................................... 7411.157 UtilitiesSmartMeterEventTypeCode ......................................................... 7441.158 UtilitiesSyntheticLoadShapeCode ........................................................... 7461.159 UtilitiesTimeOfUseCode............................................................................ 7481.160 UtilitiesTimeSeriesAssignmentRoleCategoryCode ................................ 7511.161 UtilitiesTimeSeriesAssignmentRoleCode................................................ 7531.162 UtilitiesTimeSeriesCalculationID .............................................................. 7551.163 UtilitiesTimeSeriesCalculationInputParameterCategoryCode ............... 7571.164 UtilitiesTimeSeriesCalculationItemID ...................................................... 7601.165 UtilitiesTimeSeriesCalculationMethodCode ............................................ 7631.166 UtilitiesTimeSeriesCalculationParameterID ............................................ 7661.167 UtilitiesTimeSeriesCalculationResultCategoryCode .............................. 7681.168 UtilitiesTimeSeriesCategoryCode ............................................................ 7701.169 UtilitiesTimeSeriesID ................................................................................. 7721.170 UtilitiesTimeSeriesItemTypeCode ............................................................ 7741.171 UtilitiesTimeSeriesTypeCode ................................................................... 7771.172 UtilitiesTrackedBusinessTransactionID .................................................. 7791.173 UtilitiesTrackedBusinessTransactionPartyID ......................................... 7811.174 UtilitiesWeightingCode ............................................................................. 7831.175 UtilityContractID ........................................................................................ 7861.176 Value .......................................................................................................... 788




1 IntroductionSAP data types are unified data types that describe business-related content built according to the UN/CEFACT Core ComponentTechnical Specification (CCTS). All elements of SOA services are described by data types. Data types are the basis for the harmonizingof the SAP Enterprise Services.

All data types are either a restriction (based on) or an aggregation of other data types. You can use the information contained in thiscatalog to familiarize yourself with the attributes of the data types that are used as building blocks for enterprise services.

The data types contained in this catalog are listed in alphabetical order. The catalog lists both core data types and utilities-specific datatypes.

Core Data TypesCore data types (CDT) are internationally standardized data types, based on W3C data types without any business semantic,such as Date, Time, Decimal Value, etc. They can contain attributes. The CDTs implemented at SAP may have structuralrestrictions (for example number of digits for the quantity and amount).

Utilities-Specific Data TypesBusiness objects and service operations always have a specific business semantic and are built for a specific a usage. Data typesare used to describe elements in business objects and service operations. This means that data types are used in businessobjects and service operations in a specific context. Within a specific context, the semantic and structure of a data type may berestricted as described in the relevant catalog entry.




1.0 BillingRateCode

DefinitionA coded representation of a billing rate.

CommentA billing rate is a rule for rating consumption or a service. It can consist of multiple steps that are executed during billing taking forexample rates per unit, surcharges or discounts into account.

Dictionary Entry NameBilling Rate. Code

Example1

StructureGDT Cat. Object Class Property Representation Type Type Name Length Card. Remarks

BillingRateCode Billing Rate Code CDT Code 1..10 restricted

listID A Code List Identification Identifier XSD token 1..60 0..1

listVersionID A Code List Version Identifier XSD token 1..15 0..1

listAgencyID A Code List Agency Identification Identifier XSD token 1..60 0..1

Detailed Description and Value RangesA user-specific code list is assigned to the code. A user of this code determines the codes in the code list during configuration.




Semantic examples of customer-specific codes are provided in the Use section.

Detailed Description of Attributes and ElementsAttribute / Element Detailed Description

listID Identifies a list of codes that belong together. listID is only unique within the agency that manages this code list.

listVersionID Identifies the version of a code list.

listAgencyID Identifies the agency that manages the code list. The agencies from UN/EDIFACT data element 3055 (DE 3055) are used as thedefault, however, the roles defined in DE 3055 cannot be used. If the agency is not listed in DE 3055 it can be identified by usingits web URI.

Integrity ConditionsNone specified.

UseThis data type is used to specify the billing rate that can be used during billing of the consumption of a service.

Examples for user-specific code semantics:- Toll Usage - Billing Rate for billing toll usage in Electronic Toll Collection- Electricity Rate On-Peak - Billing Rate for billing consumption of electricity at peak times in Utilities

NotesNone specified.

Appendix - Code Lists

BillingRateCodelistID = 70309




No codes are specified. Examples are given in the "Use" section. A user of this data type specifies the codes during configuration.

Restricted Data Type NOSC_BillingRateCode

DefinitionA coded representation of a billing rate.

Example1


NOSC_BillingRateCode NOSC_ Billing Rate Code GDT BillingRateCode 1..10 restricted

Detailed DescriptionFor usage in SAP Business Suite Level 1 and 2 Services which don't need Supplementary Components.




1.1 BillingRateGroupDeterminationCode

DefinitionA coded representation of the determination of a group of billing rates.

CommentA billing rate group is a grouping together of rates. For example in Utilities it can be used to define the order in which the billing programsof these rates are executed.

Dictionary Entry NameBilling Rate Group. Determination. Code

Example123


BillingRateGroupDeterminationCode

Billing Rate Group Determination Code CDT Code 1..10 restricted














UseThis data type is used to specify the billing rate group which can be used in combination with the BillingRateGroupingCode to determinethe billing rate.

Examples for user-specific code semantics: - Toll Collection - Determines billing rate group for Electronic Toll Collection - Electricity - Determines billing rate group for billing the consumption of electricity in Utilities



BillingRateGroupDeterminationCode




listID = 70310


Restricted Data Type NOSC_BillingRateGroupDeterminationCode

DefinitionA coded representation of the determination of a group of billing rates.


NOSC_BillingRateGroupDeterminationCode NOSC_ Billing RateGroup

Determination Code GDT BillingRateGroupDeterminationCode

1..10 restricted





1.2 BillingRateGroupingCode

DefinitionA coded representation of a grouping of billing rates.

CommentThe grouping is a dividing up of billing rates of a billing rate group according to customer specific criteria.

Dictionary Entry NameBilling Rate. Grouping. Code

Example1


BillingRateGroupingCode Billing Rate Grouping Code CDT Code 1..10 restricted




Detailed Description and Value RangesA user-specific code list is assigned to the code. A user of this code determines the codes in the code list during configuration.Semantic examples of customer-specific codes are provided in the Use section.









UseThis data type is used to divide up the billing rates and can be used in combination with the BillingRateGroupDeterminationCode todetermine the billing rate.

Examples for user-specific code semantics: - Toll Use Highway - For billing for highway usage in Electronic Toll Collection - On-Peak - For billing consumption on peak in Utilities - Off-Peak - For billing consumption off peak in Utilities



BillingRateGroupingCodelistID = 70311





Restricted Data Type NOSC_BillingRateGroupingCode

DefinitionA coded representation of a grouping of billing rates.


NOSC_BillingRateGroupingCode NOSC_ Billing Rate Grouping Code GDT BillingRateGroupingCode

1..10 restricted





1.3 BusinessDocumentMessageHeader

DefinitionA BusinessDocumentMessageHeader comprises business information from the perspective of the sender application for identifying andprocessing of a business document (instance) within a (technical) message (if applicable, with a reference to a previous instance of abusiness document within a previous (technical) message), information about the sender, and any information about the receiver.

Dictionary Entry NameBusiness Document. Message Header. Details

Example< PurchaseOrderRequest > < MessageHeader > < ID schemeID =" INVOIC "> 00000000123456 < ReferenceID schemeID =" ORDER "> 00000000123455 < CreationDateTime > 2003-10-21T12:21Z < SenderParty > < StandardID schemeAgencyID="016" >4711 < ContactPerson > < InternalID schemeID="PartyID" schemeAgencyID="MPL_002" >820 < Adress >? < RecipientParty > < InternalID schemeID="PartyID" schemeAgencyID="BPL_300" >747< /InternalID > < ContactPerson > < InternalID schemeID="PartyID" schemeAgencyID="BPL_300" >737< /InternalID >




< Adress >' < BusinessScopeBusinessProcess > < TypeCode >1 < InstanceID schemeID="ClientTransactionUUID" >42d3cfca-5996-57b0-e100-00000a44201b ?.


BusinessDocumentMessageHeader

Business Document Message Header Details

ID E Business DocumentMessage Header

Identification Identifier GDT BusinessDocumentMessageID

1..35 0..1

UUID E Business DocumentMessage Header

Universally UniqueIdentification

Identifier GDT UUID 0..1

ReferenceID E Business DocumentMessage Header

Reference Identification Identifier GDT BusinessDocumentMessageID

1..35 0..1

ReferenceUUID E Business DocumentMessage Header

Reference Identification Identifier GDT UUID 0..1

CreationDateTime E Business DocumentMessage Header

Creation Date Time DateTime CDT GLOBAL_DateTime 1

TestDataIndicator E Business DocumentMessage Header

Test Data Indicator CDT Indicator 0..1

ReconciliationIndicator E Business DocumentMessage Header

Reconciliation Indicator CDT Indicator 0..1

SenderBusinessSystemID E Business Document Sender Business Identifier GDT BusinessSystemID 0..1




Message Header System Identification

RecipientBusinessSystemID E Business DocumentMessage Header

Recipient BusinessSystem Identification

Identifier GDT BusinessSystemID 0..1

SenderParty E Business DocumentMessage Header

Sender Details BusinessDocumentMessageHeaderParty

0..1

RecipientParty E Business DocumentMessage Header

Recipient Details BusinessDocumentMessageHeaderParty

0..n

BusinessScope E Business DocumentMessage Header

Business Scope Details GDT BusinessScope 0..n

Detailed Description and Value RangesAttribute / Element Detailed Description

ID Identifier for the instance of the business document within a (technical) message that is generated by the business application levelat the sender.

UUID Universally unique identifier for the instance of the business document within a (technical) message that is generated by thebusiness application level at the sender.If this element is filled, the contents of element ID can be ignored by the receiver.

ReferenceID Identifier of another instance of a business document in another (technical) message that the BusinessDocument references (aBusinessDocument can link to another BusinessDocumentMessage to represent a business interrelation or a dependency).

ReferenceUUID Universally unique identifier of another instance of a business document in another (technical) message that theBusinessDocument references (a BusinessDocument can link to another BusinessDocumentMessage to represent a businessinterrelation or a dependency).If a referenced message was identified by element UUID, ReferenceUUID must be used.

CreationDateTime An exact date and time stamp (to the second) for when a message is created for the business document within the businessapplication.

TestDataIndicator Indicates if the business data contained in the message is test data or not. This element is optional and if omitted its default is"false".

ReconciliationIndicator Indicates if the message is a reconciliation message or not. This element is optional and if omitted its default is "false".




SenderBusinessSystemID ID of the business system that send a Business Document.

RecipientBusinessSystemID ID of the business system that receives a Business Document.

SenderParty "SenderParty" is the party that creates and sends the BusinessDocument at business application level. SenderParty contains aunique sender identification. The identifiers contained in SenderParty can also be used for internal forwarding at application level.The contact person in it contains the necessary direct contact information in case there are problems or errors during processing ofthe respective BusinessDocument.

RecipientParty "RecipientParty" is the party that receives and processes the BusinessDocument at business application level. RecipientPartycontains a unique receiver identification. The identifiers contained in RecipientParty can also be used for internal forwarding atapplication level. The contact person in it contains the necessary direct contact information in case there are problems or errorsduring processing of the respective BusinessDocument.

BusinessScope An environment from which a message is sent. The BusinessScope can include a business description of the business process aswell as technical aspects of the message environment such as transaction protocols (e.g UN/CEFACT Transaction Pattern).

Integrity ConditionsAll BusinessDocuments used for B2B scenarios must use the GDT BusinessDocumentMessageHeader. If required,BusinessDocumentMessageHeader can also be used in BusinessDocuments only intended for A2A scenarios.The GDT BusinessDocumentMessageHeader must be part of all Business Documents used in the Business Application Platform.If ID and UUID is given, they must identify the same message.If ReferenceID and ReferenceUUID is given, they must identify the same message.

UseIn detail, BusinessDocumentMessageHeader can be used for the following:- For forwarding to the relevant position or target person within a business application.- For administration and error handling. The unique identification can be used for referencing and in the case of errors at businessapplication level, the contact person in SenderParty or RecipientParty can be contacted directly. The name, telephone number, e-mailaddress, fax number, and so on can be transmitted by the BusinessDocumentMessageHeader for this purpose.- For tracing and monitoring of a BusinessDocument and its processing status at business application level.- For managing and monitoring business processes.




- For converting general information to other standards such as for example, IDoc, UN/CEFACT, ANSI X.12, ODETTE, TRADACOMMS,xCBL, OAG BODs, RosettaNet-PIPs, and so on These are standards that represent only reference data for the business application levelaccording to predefined conventions. This can only be guaranteed if the general header information of a BusinessDocument is identicalto the envelope or header information of the respective default message.The ReferenceID is used to represent references that originate from the succession of BusinessDocuments in the BusinessDocumentchoreography (these can be, for example, query/response or request/confirmation messages).The respective interface document must identify the previous BusinessDocument to which the ReferenceID refers, i.e., what thereference specified by the BusinessDocument reference means.

NotesComparing BusinessDocumentMessageHeader to the header information from the usual message transfer protocols "ReliableMessaging", "OASIS ebXML MSG", "OASIS ebXML CPP/CPA", "Rosetta Net RNIF 2.0", and so on, demonstrates that theBusinessDocumentMessageHeader contains redundant information compared to these technical transfer protocols. However, theBusinessDocumentMessageHeader is only used at business application level and not at such a technical level. The information in thiscase is information that can be sent, received, and processed at this level.BusinessDocumentMessageHeader is based on the following convention: "UN/CEFACT Standard BusinessDocumentMessage HeaderTechnical Specification - Working Draft - Revision 2.2.5" dated 26 November 2003.The ID (BusinessDocumentMessageID) of the BusinessDocumentMessageHeader is clearly distinguishable from the technicalMessaged (the XI message):- The ID (BusinessDocumentMessageID) is issued by the business application and is stable over the entire lifetime of theBusinessDocument. It also remains unchanged even when the message is sent via multiple, successive middleware systems("messaging systems").- The technical MessageID is issued at the level of the technical middleware system and generally changes as follows:- Each time the BusinessDocument is resent or forwarded by a middleware system- When the BusinessDocument is split into multiple technical messages by a middleware system




1.4 BusinessPartnerID

DefinitionAn identifier for a business partner.

CommentA business party is a person, organization, or group of people / organizations in which a company has a business interest.

Dictionary Entry NameBusiness Partner. Identification. Identifier

Example 065055766


BusinessPartnerID Business Partner Identification Identifier CDT Identifier 1..60 restricted

Detailed Description and Value RangesLetters have to be in uppercase.





UseThe GDT BusinessPartnerID is used to represent an alternative business partner number.This GDT may not be used in messages; use the GDT PartyID instead. When mapping from BusinessPartnerID to PartyID the attributesare transferred 1:1. The contents of the scheme attributes are determined by the type of alternative business partner number (see GDTPartyIDTypeCode). If, for example, the alternative business partner number is a DUNS, the values would be as follows: SchemeID "DUNS" SchemeAgencyID "16"

NotesThe following dictionary objects are assigned to this GDT in mySAP systems:Data element: BU_PARTNER

Appendix - List of QualifiersQualifier Definition

Additional An identifier of an additional business partner.

LowerBoundary Lower boundary of an interval of identifiers for business partners.

UpperBoundary Upper boundary of an interval of identifiers for business partners.




1.5 CalorificValue

DefinitionThe calorific value (energy value) of a substance is the measured quantity of heat released during the combustion of a specified quantityof it.

CommentThe calorific value is a characteristic for each substance. It is measured in units of thermal energy per unit of the substance, usuallymass, such as: kJ/kg, kJ/mol, kcal/kg, Btu/m.

Dictionary Entry NameCalorific Value. Measure

Example11.469200


CalorificValue Calorific Value Measure CDT Measure 2.6 restricted

unitCode A Measure Unit Code GDT MeasureUnitCode 1..3 1

Detailed Description and Value RangesNone specified

Detailed Description of Attributes and Elements




Attribute / Element Detailed DescriptionunitCode Specifies the unit of measure of a measure.

Integrity ConditionsNone specified

UseThe calorific value can be used to calculate the amount of therminal energy of a substance

NotesIn SAP Business Suite the CalorificValue is represented by BRENNWTA




1.6 CashDepositRequestWaiverReasonCode

DefinitionA coded representation of a reason for waiving a cash deposit request.

CommentA cash deposit is an administration object for cash deposit requests and payments posted to the same contract account and contract.

Dictionary Entry NameCash Deposit Request. Waiver Reason. Code

Example1


CashDepositRequestWaiverReasonCode

Cash Deposit Request Waiver Reason Code CDT Code 1..4 restricted




Detailed Description and Value RangesA customer-specific code list is assigned to the code CashDepositRequestWaiverReasonCode.




Semantic examples of customer-specific codes are provided in the "Use" section.






UseA CashDepositRequestWaiverReasonCode is used in cash deposit request documents to specify the reason for waiving a cash depositrequest.

Examples of possible codes:Letter Of Recommendation - Due to a letter of recommendation the utilities company waivers to request a cash deposit.Low Consumption - Due to the low consumption of the end customer the utilities company waivers to request a cash deposit.Special Licence - Due to a special licence the utilities company waivers to request a cash deposit.

NotesThe CashDepositRequestWaiverReasonCode is represented by SECWAIVEREAS in SAP Business Suite.





CashDepositRequestWaiverReasonCodelistID = 11476





1.7 CLOSED_LOCAL_DateTimePeriod

DefinitionCLOSED_LOCAL_DateTimePeriod is a period that is defined by two points in time. These points in time are expressed byLOCAL_DateTime.CLOSED_LOCAL_DateTimePeriod includes the start time-point and includes the end time-point.

Dictionary Entry Name

Example

2009-01-01T00:00:00 2009-01-01T23:59:59


CLOSED_LOCAL_DateTimePeriod

CLOSED_ LOCAL__Date Time Period

Details GDT DateTimePeriod

StartDateTime E Date Time Period Start Date Time DateTime CDT LOCAL_DateTime 1

EndDateTime E Date Time Period End Date Time DateTime CDT LOCAL_DateTime 1

Detailed Description and Value RangesNo entry.





StartDateTime Accurate-to-the-second start time on a calendar day in accordance with the extended representation ISO 8601.

EndDateTime Accurate-to-the-second end time on a calendar day in accordance with the extended representation ISO 8601.

Integrity ConditionsThe time zone of start and end time-point may be different.

Use

NotesFor the definition of time-points of type LOCAL_DateTime, please refer to GDT LOCAL_DateTime.The CLOSED_LOCAL_DateTimePeriod is a restriction on GDT DateTimePeriod. CLOSED_LOCAL_DateTimePeriod contains thevariable "CLOSED_LOCAL_", which gets replaced by one (or more) qualifier. For the possible qualifiers ofCLOSED_LOCAL_DateTimePeriod refer to GDT PeriodRoleCode.




1.8 CLOSED_UNBOUNDED_TimePointPeriod

DefinitionCLOSED_UNBOUNDED_TimePointPeriod is a period that is defined by two points in time.It includes the start time-point and includes the end time-point.

Dictionary Entry Name

Example

6 2009-01-01T00:00:0 6 2009-01-01T23:59:59


CLOSED_UNBOUNDED_TimePointPeriod

CLOSED_UNBOUNDED__ Time Point Period

Details GDT TimePointPeriod restricted




StartTimePoint E Timepoint Period Start Timepoint Details GDT TimePoint 0..1

EndTimePoint E Timepoint Period End Timepoint Details GDT TimePoint 0..1

Detailed Description and Value RangesNone specified.


StartTimePoint Time-Point specifying the start of the period.

EndTimePoint Time-Point specifying the end of the period.

Integrity ConditionsThe sub-elements for start and end are set to optional. In case of using only one sub-element an infinite time period can be defined.

UseNone specified.

NotesFor the definition of time-points of type TimePoint, please refer to GDT TimePoint.The CLOSED_UNBOUNDED_TimePointPeriod is a restriction on GDT TimePointPeriod. CLOSED_UNBOUNDED_TimePointPeriodcontains the variable "CLOSED_UNBOUNDED_", which gets replaced by one (or more) qualifier. For the possible qualifiers ofCLOSED_UNBOUNDED_TimePointPeriod refer to GDT TimePointPeriod.




1.9 Code

DefinitionCode is a character string of letters, numbers, special characters (except escape sequences), and symbols. It represents a definitivevalue, a method, or a property description in an abbreviated or language-independent form.

Dictionary Entry NameCode. Type

Examplea) Standard Code/Standard Agency:4b) Proprietary Code/Standard Agency:ANSc) Proprietary Code/Proprietary Agency:ER05


Code Code Type XSD token




listAgencySchemeID A Code List AgencyScheme

Identification Identifier XSD token 1..60 0..1




listAgencySchemeAgencyID A Code List AgencyScheme Agency

Identification Identifier GDT AgencyIdentificationCode

0..1





listAgencySchemeID Deprecated!This Supplementary Component is not supported any longer!

listAgencySchemeAgencyID Deprecated!This Supplementary Component is not supported any longer!

UseThe "Code" data type is used for all elements that are used in the communication between partners or systems to enable a commoncoded value representation in place of texts, methods, or properties . This code list should be relatively stable, and not subject tofrequent or significant changes (for example, CountryCode, LanguageCode, and so on).If the agency that manages the code list is not named explicitly, but is specified by using a role, this is done in the tag name.The following types of code can be represented:a) Standardized codes, whose code lists are managed by an agency from the DE 3055 code list.

Code, StandardlistID, Code list for the standard codelistVersionID, Version of the code listlistAgencyID, Agency from DE 3055 (excluding roles)




b.) Proprietary codes, whose code lists are managed by an agency that is identified using a standard.

Code, ProprietarylistID, Code list for the proprietary codelistVersionID, Version of the code listlistAgencyID, Standardized ID for the agency (normally the company that manages the proprietary code list)

c.) Proprietary codes, whose code lists are managed by an agency that is identified without the use of a standard.

Code, ProprietarylistID, Code list for the proprietary codelistVersionID, Version of the code listlistAgencyID, Proprietary ID for the agency (normally the company that manages the proprietary code list)

d.) Proprietary codes, whose code lists are managed by an agency that is specified using a role or not at all.The role is specified as a prefix in the tag name. If there is more than one code list, listID and listVersionID can be used as attributes. Noattributes are required if there is only one code list.

Code, ProprietarylistID, Identification scheme for the proprietary identifierlistVersionID, Version of the identification schemelistAgencyID, -

The representation term for the CDT "Code" is Code.




Application of CDT Code Attributes (Supplementary Components) to a GDT:If the CDT code is used as a basis to define a specific code GDT that combines (parts of) standard code lists of different standardizationorganizations, and the complied lists are not disjunctive, the following attributes of the CDT code must be included in the GDT: listID listVersionID listAgencyID

Exception: The compiled lists are not disjunctive, but in each interface that uses the GDT, the lists supported by the interface aredisjunctive. In this case, the attributes are not required in the GDT.

NotesTo be able to represent values, methods, and property descriptions as code, the corresponding code list must be consistent and, unlikeidentifier lists, subject to very few changes to its content.As a rule, "Code" cannot be used to uniquely identify any logical or real objects.

In some cases it is not possible to differentiate clearly between "Identifier" and "Code" for coded values. This is particularly applicable if acoded value is used to uniquely identify an object and, at the same time, this coded value is used to replace a longer text. For example,this includes the coded values for "Country", "Currency", "Organization", "Region", and so on If the list of coded values in this case isconsistent, then the GDT "Code" can be used for the individual coded values.

Examples:A passport number (PassportId) is clearly an "Identifier", because a) it identifies a (real) object, namely, a natural person, and b) the listof passport numbers is constantly growing as new passport numbers are issued.

A country code (CountryCode or CountryId) can be either an "Identifier" or a "Code". The country code uniquely identifies a real object,namely, the country. However, the country code itself is also a replacement for the respective (unique) country name. Therefore, it is alsoa "Code". Since the code list is relatively consistent, the country name should be represented as a "Code". Changes are caused only bypolitical events and such changes are few in comparison to those relating to natural persons.




A process code (ProcessCode) is clearly a "Code", because a) it describes a method type and not an object, and b) the list of processcodes seldom changes.


Local Code in a local business system.Comment:In a communication between two business systems, the local system is the local communication partner.Use:

LocalCode may be used, for example, in a mapping between local and remote codes to denote the codes usedin the local business system.

LowerBoundary Lower boundary of an interval of codes.

Remote Code in a remote business system.Comment:In a communication between two business systems, the remote system is the remote communication partner.Use:

RemoteCode may be used, for example, in a mapping between local and remote codes to denote the codesused in the remote business system.

UpperBoundary Upper boundary of an interval of codes.




1.10 ContractAccountID

DefinitionA ContractAccountID is a unique identifier for a contract account.

CommentA contract account belongs to one or more business partners and contains guidelines and service terms that are considered inreceivables and payables processing.

Dictionary Entry NameContract Account. Identification. Identifier

Example123456789012


ContractAccountID Contract Account Identification Identifier CDT Identifier 1..12

Detailed Description and Value RangesNo entry.

Integrity ConditionsNo entry.




UseA ContractAccountID is used to represent a contract account.

NotesNo entry.


ClearingDetails Contract account providing details required for the clearing of items by payment or debit. Examples for such details arepayment method, bank details, lock reason, alternative payer.

Collective A contract account which has several single contract accounts assigned. It manages the postings of these accounts whichare bundled in a collective invoice.

Transfer Contract account used to clear receivables or payables items by transfer postings (for example, the account for a depositcontract).




1.11 ContractAccountsReceivablesPayablesPostingDocumentTypeCode

DefinitionA coded representation of the type of a contract accounts receivables payables posting document.

Dictionary Entry NameContract Accounts Receivables Payables Posting Document. Type. Code

Example1


ContractAccountsReceivablesPayablesPostingDocumentTypeCode

Contract AccountsReceivables PayablesPosting Document

Type Code CDT Code 1..2 restricted




Detailed Description and Value RangesA user-specific code list is assigned to the code. A user of this code determines the codes in the code list during configuration.Semantic examples of customer-specific codes are provided in the Use section.









UseThis data type is used to specify the type of a contract accounts receivables payables posting document. Examples for user-specific codesemantics:

Interest Document - Classifies an interest document Charges Document - Classifies a charges document

NotesIn mySAP Business Suite the ContractAccountsReceivablesPayablesPostingDocumentTypeCode is represented by BLART_KK.


ContractAccountsReceivablesPayablesPostingDocumentTypeCodelistID = 70307





Restricted Data Type NOSC_ContractAccountsReceivablesPayablesPostingDocumentTypeCode

DefinitionA coded representation of the type of a contract accounts receivables payables posting document.


NOSC_ContractAccountsReceivablesPayablesPostingDocumentTypeCode

NOSC_ ContractAccounts ReceivablesPayables PostingDocument

Type Code GDT ContractAccountsReceivablesPayablesPostingDocumentTypeCode

1..12 restricted





1.12 ContractAccountsReceivablesPayablesSettlementProcedureCode

DefinitionA coded representation of the settlement procedure in contract accounts receivables payables.

CommentThe settlement procedure represents the business transaction in contract accounts receivables and payables which executes settlement.

Dictionary Entry NameContract Accounts Receivables Payables. Settlement Procedure. Code

ExampleR41


ContractAccountsReceivablesPayablesSettlementProcedureCode

Contract AccountsReceivables Payables

Settlement Procedure Code CDT Code 1..3 restricted







Detailed Description and Value RangesAn extensible SAP code list is assigned to the code. A user of this code can replace this SAP code list with another one. The SAP codelist and its values are provided in Appendix Code List.






UseThis data type is used to specify the settlement procedure in contract accounts receivables payables. The settlement procedure is usedto determine the payment assignment or clearing rules.

NotesIn mySAP Business Suite the ContractAccountsReceivablesPayablesSettlemenProcedureCode is represented by VERART_KK.


ContractAccountsReceivablesPayablesSettlementProcedureCodelistID = 70308listAgencyID = 310




Code Name Description1 Manual Posting Procedure for manual posting.

2 Account Maintenance Procedure for account maintenance.

3 Automatic Clearing Procedure for automatic clearing.

4 Payment Lot Procedure for handling a payment lot. A payment lot represents the payments that are combined to beprocessed together.

5 Payment Run Procedure for a payment run.

6 Payment At Cash Desk Procedure for a payment at cash desk.

7 External Cash Payment Procedure for an external cash payment.

8 External Card Payment Procedure for an external card payment.

9 External Check Payment Procedure for an external check payment.

10 External Postal Order Procedure for an external postal order.

11 External Payment Procedure for an external payment.

12 Payment By Card At Cash Desk Procedure for a payment by card at cash desk.

13 Distribution Of Payment ToPayment Advice Note

Procedure for distribution of payment to a payment advice note.

14 Distribution Of Payment ToLoan Repayment Plan

Procedure for distribution of payment to a loan repayment plan.

15 Distribution Of Payment ToInstallment Plan

Procedure for distribution of payment to a loan installment plan.

16 Distribution Of Payment ToCollective Bill

Procedure for distribution of payment to a collective bill.




17 Check Payment At Cash Desk Procedure for check payment at cash desk.

18 Postal Order At Cash Desk Procedure for postal order at cash desk.

19 Check Lot Procedure for handling a check lot.

20 Distribution Of Payment ToSummarization Group

Procedure for payment to summarization group.

21 Payment Order Lot Procedure for handling a payment order lot.

22 Payment Of Electronic Bill Procedure for payment of an electronic bill.

23 Credit Card Lot Procedure for handling a credit card lot.

24 Payment In Financial CustomerAnd Care

Procedure for payment in financial customer and care.

25 Migration Procedure for migration.

26 Migration Payment Procedure for migration payment.

27 Invoicing Procedure for creating an invoice.

28 Periodic Billing Procedure for creating a periodic bill.

29 Final Billing Of Contract Procedure for the final billing of a contract.

30 Final Billing Of A ContractAccount

Procedure for the final billing of a contract account.

31 Collective Billing Procedure for creating a collective Bill.

32 Partial Billing Procedure for creating a partial bill.

33 Requesting Budget Billing Procedure for creating a budget billing request.

34 Aggregated Billing Procedure for creating an aggregated bill.

35 Incoming Aggregated Billing Procedure for creating an incoming bill.




Restricted Data Type NOSC_ContractAccountsReceivablesPayablesSettlementProcedureCode

DefinitionA coded representation of the settlement procedure in contract accounts receivables payables.


NOSC_ContractAccountsReceivablesPayablesSettlementProcedureCode

NOSC_ ContractAccounts ReceivablesPayables

Settlement Procedure Code GDT ContractAccountsReceivablesPayablesSettlementProcedureCode

1..3 restricted





1.13 CorrespondenceCommunicationProfileCode

DefinitionA coded representation of a profile which controls how the correspondence is communicated.

CommentProvides flexible control in batch processing and means that a document can be sent in various ways and on more than one occasion.

The following information is defined within this code:- Send type (for example, fax, e-mail, SMS)- Number of copies- Archiving mode- Output device

Dictionary Entry NameCorrespondence Communication Profile. Code

Example1


CorrespondenceCommunicationProfileCode

CorrespondenceCommunication Profile

Code CDT Code 1..4 restricted







Detailed Description and Value RangesA user-specific code list is assigned to the CorrespondenceCommunicationProfileCode.A user of this code determines the codes in the code list during configuration.

Semantic examples of user-specific codes are provided in the Use section.






UseA CorrespondenceCommunicationProfileCode is used to define a profile which controls how the correspondence is communicated.

Examples of possible codes:Fax - Send the correspondence twice by fax.Print & Mail - One printed copy (standard printer) and one e-mail.None - Do not use any profile.




NotesThe CorrespondenceCommunicationProfileCode is represented by SENDCONTROL and CRMT_BUAG_SNDCTRL in SAP BusinessSuite.


CorrespondenceCommunicationProfileCodelistID = 11497





1.14 CorrespondenceTypeGroupCode

DefinitionA coded representation of a group of correspondence types having similar control parameters and being sent with the same frequency.

CommentA correspondence type characterizes the correspondence itself (such as a return notification or an account statement) and can be usedto determine the accompanying communication profile.

Dictionary Entry NameCorrespondence Type Group. Code

Example1


CorrespondenceTypeGroupCode

Correspondence TypeGroup





Detailed Description and Value RangesAn user-specific code list is assigned to the CorrespondenceTypeGroupCode.




A user of this code determines the codes in the code list during configuration.

Semantic examples of user-specific codes are provided in the Use section.






UseA CorrespondenceTypeGroupCode is used to group the correspondence types used to control periodic correspondence. Allcorrespondence types which are grouped together have similar control parameters and are being sent with the same frequency.

Examples of possible codes:Account Information - Send Account Statement and Contract Account Balance Notification monthly.Quarterly Notification - Send Commission Documentation and Interest Notification quarterly.

NotesThe CorrespondenceTypeGroupCode is represented by COPRC and CRMT_BUAG_CORRESPONDENCE_VAR in SAP BusinessSuite.





CorrespondenceTypeGroupCodelistID = 11498



Default A default designation of a correspondence type group code.




1.15 CountyCode

DefinitionA coded representation of a county within a region of a country defined by either national or administrative/political borders.

Dictionary Entry NameCounty. Code

Example219


CountyCode County Code CDT Code 1..3 restricted














UseCountyCode is used to identify a county defined by national or administrative/political borders in a physical address.

Example of possible codes for the country of "Denmark" and the region of "Sjaelland":215 Helsinge217 Helsingr219 Hillerd221 Hundested223 Hrsholm225 Jgerspris227 Karlebo

NotesThe CountyCode is represented by COUNC in SAP Business Suite.


CountyCode




listID = 70346


Appendix - Context

DefinitionThe CountyCodeContextElements defines a dependency or an environment in which the CountyCode appears. The environment isdescribed by context categories.

CommentWith the context categories in CountyCodeContextElements the valid number of code values of CountyCode is restricted according to anenvironment during use.


CountyCodeContextElements County Code ContextElements

Details

CountryCode E County Code ContextElements

Country Code GDT CountryCode 1

RegionCode E County Code ContextElements

Region Code GDT RegionCode 1


CountryCode This context category defines the purpose of a Country. This determines the valid code values for this purpose.

RegionCode This context category defines the purpose of a Region. This determines the valid code values for this purpose.




Restricted Data Type NOSC_CountyCode

DefinitionA coded representation of a county within a region of a country defined by either national or administrative/political borders.


NOSC_CountyCode NOSC_ County Code GDT CountyCode 1..3 restricted





1.16 CreditRiskClassCode

DefinitionA coded representation for the risk of non-payment.

Dictionary Entry NameCredit Risk Class. Code

ExampleA


CreditRiskClassCode Credit Risk Class Code CDT Code 1..10 restricted



Detailed Description and Value RangesSeveral extensible and one user-specific code lists, which are different at runtime, are assigned to the code. A user of this codedetermines the codes in the code list during configuration.Semantic examples of user-specific codes are provided in the Use section.







Integrity ConditionsOnly code lists from the following table may be used for the CreditRiskClassCode .

Code List listAgencyIDDun & Bradstreet Rating Code 016Schufa www.schufa.deBrgel www.buergel.deCreditreform www.creditreform.deMutually agreed

UseCreditRiskClassCode is used to represent the risk of non-payment involved in a business transaction. The risk of non-payment refers tothe party involved in the business transaction concerned.The CreditRiskClassCode is usually the proprietary code list of a credit agency, but may also be a company's credit management codelist.The individual values of the code represent a risk class, for example, "high", "medium", "low" (self-explanatory).



CreditRiskClassCodelistID = 35101




listAgencyID = 310





1.17 CustomerContractGroupCode

DefinitionA coded representation of a group of customer contracts.

Dictionary Entry NameCustomer Contract Group. Code

Example1


CustomerContractGroupCode Customer ContractGroup





Detailed Description and Value RangesA user-specific code list is assigned to the code. A user determines the codes in the code list.

Semantic examples of customer-specific codes are provided in the "Use" section.








Integrity ConditionsThe CustomerContractGroupCode may not be used in B2B messages at present.

UseThe CustomerContractGroupCode is used, for example, in the sales order for pricing and statistics purposes. Examples of the possiblesemantics of the codes are: Industrial enterprise contracts: Customer contract group that