Source Document in ESG data model

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"4.3"stringsemantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all ESG Data Model entities are derived.
enThe source document is the original record of a transaction.

Source documents are important as evidence of the business transaction is case proof is required due to an audit or for other reasons.

entitya reference to the constant entity holding the list of localized text

is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSourceDocument/(resolvedAttributes)/SourceDocumentIdattribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

ParameterValueData typeExplanation
versionNumber"1.2.3"string

is.IDM.modelVersion
Semantic version number of the IDM.

ParameterValueData typeExplanation
versionNumber"2.0.0"string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{FF2B6327-7005-4098-8AE8-CAAE475607F6}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

ParameterValueData typeExplanation
name"Accounting & Financial Reporting"string

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSource Document
entitya reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides, or restates parts of logical schemas to produce one resolved schema.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
SourceDocumentId The unique identifier of a source document involved in a transaction. Sustainability/esg-data-model/SourceDocument
SourceDocumentDate The official date on the source document. Sustainability/esg-data-model/SourceDocument
Description A description of the source document. Sustainability/esg-data-model/SourceDocument
Amount The amount of the source document. Sustainability/esg-data-model/SourceDocument
StorageLocationId The location where the source document is stored. Sustainability/esg-data-model/SourceDocument
SourceDocumentTypeId The unique identifier of a Source Document Type. Sustainability/esg-data-model/SourceDocument
SourceDocumentInputTypeId The unique identifier of a Source Document Input Type. Sustainability/esg-data-model/SourceDocument
TransactionId The unique identifier of a Transaction. Sustainability/esg-data-model/SourceDocument
InvoiceId The unique identifier of an Invoice. Sustainability/esg-data-model/SourceDocument
OrderId The unique number that identifies an Order. Sustainability/esg-data-model/SourceDocument

SourceDocumentId

The unique identifier of a source document involved in a transaction. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameSource Document ID
descriptionThe unique identifier of a source document involved in a transaction.
isPrimaryKeytrue
dataFormatint64

Traits

List of traits for the SourceDocumentId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSourceDocument/(resolvedAttributes)/SourceDocumentIdattribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{0CE720FC-F20B-41B7-8909-7293F2680948}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSource Document ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a source document involved in a transaction.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

SourceDocumentDate

The official date on the source document. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameSource Document Date
descriptionThe official date on the source document.
dataFormatdate
isNullabletrue

Traits

List of traits for the SourceDocumentDate attribute are listed below.

is.dataFormat.date
means.measurement.date
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{A799F56C-79E3-45B4-9854-82B38E8DC569}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSource Document Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe official date on the source document.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

Description

A description of the source document. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameDescription
descriptionA description of the source document.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the Description attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{C6951599-ECEE-4A69-842C-F91CDDFFFB55}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA description of the source document.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"2048"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, and Array of Byte is a Binary Object.

Amount

The amount of the source document. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameAmount
descriptionThe amount of the source document.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the Amount attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{EB08D88F-846A-45F3-BCF5-E075E752BB50}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAmount
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe amount of the source document.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

StorageLocationId

The location where the source document is stored. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameStorage Location ID
descriptionThe location where the source document is stored.
dataFormatint32
isNullabletrue

Traits

List of traits for the StorageLocationId attribute are listed below.

is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{BFC9DE30-7D7E-4827-B629-6DA7EA4AEDBD}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStorage Location ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe location where the source document is stored.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

SourceDocumentTypeId

The unique identifier of a Source Document Type. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameSource Document Type ID
descriptionThe unique identifier of a Source Document Type.
dataFormatint32
isNullabletrue

Traits

List of traits for the SourceDocumentTypeId attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSource Document Type ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Source Document Type.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
SourceDocumentType.cdm.json/SourceDocumentTypeSourceDocumentTypeId
entitya reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{46949F3B-82AE-48D9-BA7F-7B60B6C6BBE9}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

SourceDocumentInputTypeId

The unique identifier of a Source Document Input Type. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameSource Document Input Type ID
descriptionThe unique identifier of a Source Document Input Type.
dataFormatint32
isNullabletrue

Traits

List of traits for the SourceDocumentInputTypeId attribute are listed below.

is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{64D2B6F5-881F-4697-A1E9-A81FCDC1DD56}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSource Document Input Type ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Source Document Input Type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

TransactionId

The unique identifier of a Transaction. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameTransaction ID
descriptionThe unique identifier of a Transaction.
dataFormatint64
isNullabletrue

Traits

List of traits for the TransactionId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransaction ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Transaction.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Transaction.cdm.json/TransactionTransactionId
entitya reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{C8AA4FD4-E6B2-4B17-8532-FC3AE0ECE0D5}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

InvoiceId

The unique identifier of an Invoice. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameInvoice ID
descriptionThe unique identifier of an Invoice.
dataFormatint32
isNullabletrue

Traits

List of traits for the InvoiceId attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInvoice ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of an Invoice.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Invoice.cdm.json/InvoiceInvoiceId
entitya reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{05915722-8E5F-4E42-B352-FBF548F2D3E2}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

OrderId

The unique number that identifies an Order. First included in: Sustainability/esg-data-model/SourceDocument (this entity)

Properties

NameValue
displayNameOrder ID
descriptionThe unique number that identifies an Order.
dataFormatint64
isNullabletrue

Traits

List of traits for the OrderId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

ParameterValueData typeExplanation
identifier"{99C8F57A-591F-465C-9F0A-D810FCD8406F}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrder ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique number that identifies an Order.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.