KIW Referenzmodell ERP-Software + Rechnungswesen-Software (kompatible ab v2.0)

Download OpenAPI specification:Download

Das KIW Schnittstellen Set beruht auf offenen Standards (zur fachlichen Modellierung insb. die UN/CEFACT CCL) und gängigen Formate. Die Realisierung der API Endpunkte sowie die Nutzung der API kann in jeder geeigneten Entwicklungssprache erfolgen. Auf diese Weise sollen lose gekoppelte und flexibel erweiterbare Integrationsszenarien unterstützt werden, in denen mehrere Business Software Anwendungen jeweils unabhängig voneinander Daten wie beispielsweise Geschäftspartnerdaten oder Buchungs- und Rechnungsdaten austauschen können. Dies geschieht über generisch definierte KIW-Objekte und KIW-Methoden.

Eine ausführliche schriftliche Dokumentation des Entsteheungsprozesses steht ihnen hier zur Verfügung: Dokumentation (Legacy).

AccountingAccount

IdentificationIdentifier
string

The unique identifier for this accounting account.

TypeCode
string <enum>

The code specifying the type of accounting account such as general(main), secondary, cost accounting, budget account.

AmountTypeCode
string <enum>

The code specifying the amount type for a specific accounting account.

NameText
string

The name, expressed as text, of this accounting account.

Abbreviated NameText
string

The abbreviated name, expressed as text, of this accounting account.

CostAssignmentReferenceText
string

The cost assignment reference, expressed as text, for this accounting account.

CostReferenceDimensionPatternext
string

The cost reference dimension pattern, expressed as text, for this accounting account.

NatureCode
string <enum>

The code specifying the nature of this accounting account, such as assets, inventory, revenues, expenses, receivables, or payables.

object

The classification related to this accounting account.

object

A financial account specified for this accounting account.

LinkedAccountingAccount
object Recursive

An accounting account linked to this accounting account.

{
  • "IdentificationIdentifier": "01293",
  • "TypeCode": "A"
}

AccountingAccountCreditRisk

CapLimitationAmount
number

The monetary value of the cap limitation for this accounting account credit risk.

CurrentAmount
number

Amount The monetary value of the current amount for this accounting account credit risk.

{
  • "Value": "Beispiel Objekt"
}

Address

IdentificationIdentifier
string

A unique identifier for this address.

FormatCode
string <enum>

The code specifying the format of this address.

PostcodeCode
string <enum>

A code specifying the postcode of the address.

PostOfficeBoxText
string

The unique identifier, expressed as text, of a container commonly referred to as a box, in a post office or other postal service location, assigned to a person or organization, where postal items may be kept for this address.

BuildingNumberText
string

The number or alphanumeric designation, expressed as text, of a building or house at this address.

BuildingNameText
string

The name, expressed as text, of a building, a house or other structure on a street at this address.

RoomIdentificationText
string

The identification, expressed as text, of a room, suite, office or apartment as part of an address.

FloorIdentificationText
string

The identification by name or number, expressed as text, of the floor in a building as part of an address.

StreetNameText
string

A name, expressed as text, of a street or thoroughfare.

CityNameText
string

The name, expressed as text, of the city, town or village of this address.

AttentionOfText
string

The name, expressed as text, of a person or department in the organization to whom incoming mail is marked with words such as 'for the attention of' or 'FAO' or 'ATTN' for this address.

CareOfText
string

The name, expressed as text, of a person or organization at this address to whom incoming mail is marked with words such as 'care of' or 'C/O'.

CountryIdentifier
string

The unique identifier of a country for this address (Reference ISO 3166 and UN/ECE Rec 3).

TypeCode
string <enum>

A code specifying the type of this address such as business address or home address.

CitySub-DivisionNameText
string

A name, expressed as text, of a sub-division of a city for this address, for example a district or borough.

CountryNameText
string

A name, expressed as text, of the country for this address.

CountrySubDivisionIdentifier
string

A unique identifier of the country sub-division for this address.

CountrySubDivisionNameText
string

A name, expressed as text, of the sub-division of a country for this address.

DescriptionText
string

A textual description of this address.

CityIdentifier
string

The unique identifier of the city for this address, such as United Nations Location Code (UNLOCODE).

TownshipNameText
string

A name, expressed as text, of a township within which this address falls. A township is a geographic area that contains one or more cities, towns and villages.

ReturnedMailIndicator
boolean

An indication of whether or not mail has been returned from this address.

LegalAddressIndicator
boolean

The indication of whether or not this address is a legal address.

PreventOverrideIndicator
boolean

The indication of whether or not automatic override should be prevented for this address. For example some systems based on post office addresses will override local names with official names.

StaircaseNumberText
string

The number, expressed as text, of a staircase for this address.

StreetPrefixCode
string <enum>

The code specifying the street prefix of this address.

StreetSuffixCode
string <enum>

The code specifying the street suffix of this address.

PostalAreaText
string

A postal area, expressed as text, for this address.

object

The unique identifier of the country for this address.

object

An identification of a country sub-division of this address such as a state or county in the US or county in the UK or a department in France.

object

A period applicable for this address.

object

The location specified for this address.

{
  • "Value": "Beispiel Objekt"
}

BinaryFile

IdentificationIdentifier
string

A unique identifier for this binary file.

TitleText
string

A title, expressed as text, for this binary file.

AuthorNameText
string

An author name, expressed as text, of this binary file.

VersionIdentifier
string

A unique version identifier for this binary file.

FileNameText
string

A file name, expressed as text, of this binary file.

URIIdentifier
string

A unique Uniform Resource Identifier (URI) for this binary file.

MIMECode
string <enum>

A code specifying the Multipurpose Internet Mail Extensions (MIME) type for this binary file.

EncodingCode
string <enum>

A code specifying the encoding of this binary file.

CharacterSetCode
string <enum>

A code specifying the character set for this binary file.

IncludedBinaryObject
string <binary>

An included binary object for this binary file.

AccessText
string

Access information, expressed as text, for this binary file such as security and download parameters.

DescriptionText
string

A textual description of this binary file.

SizeMeasure
number

A measure of the size of this binary file.

TypeCode
string <enum>

The code specifying the type of binary file, such as photo, spreadsheet.

NameText
string

A name, expressed as text, of this binary file.

EmbeddedBinaryObject
string <binary>

A binary object embedded in this binary file.

LicenceIdentifier
string

An identifier of a licence for this binary file.

object

Binary File. Access Availability.

{
  • "Value": "Beispiel Objekt"
}

Calendar

IdentificationIdentifier
string

A unique identifier for this calendar.

NameText
string

A name, expressed as text, for this calendar.

DescriptionText
string

A textual description of this calendar.

StartDate
string <date>

A date on which this calendar starts.

EndDate
string <date>

A date on which this calendar ends.

HolidayDate
string <date>

A date which is a holiday for this calendar.

object

A specified period within this calendar.

object

A work shift associated with this calendar.

{
  • "Value": "Beispiel Objekt"
}

Classification

SystemIdentifier
string

An identifier of the classification system.

SystemNameText
string

A name, expressed as text, of a classification system.

ClassCode
string <enum>

A code specifying a class for this classification.

ClassNameText
string

A class name, expressed as text, for this classification.

DescriptionText
string

A textual description of this classification.

RelatedClassification
object Recursive

A classification related to this classification.

{
  • "Value": "Beispiel Objekt"
}

Communication

URIIdentifier
string

The unique identifier of the Uniform Resource Identifier (URI) for this communication, such as a web or an email address.

ChannelCode
string <enum>

The code specifying the channel or manner in which a communication can be made, such as telephone or email.

LocalNumberText
string

The communication number, expressed as text and not including country access code or the area number code, for this communication.

CompleteNumberText
string

A text string of characters that make up the complete number for this communication.

CountryNumberCode
string <enum>

The country access code for this communication number such as 44, 1, 353 etc.

ExtensionNumberText
string

The extension number, expressed as text, assigned to this communication number to enable a caller to reach a specific party.

AreaNumberCode
string <enum>

The code specifying the area number for this communication.

AccessText
string

Access information, expressed as text, for the mode of communication such as 9 or *70 for a telephone network.

UseCode
string <enum>

A code specifying the use of this communication, such as for business purposes or private.

InvalidIndicator
boolean

The indication of whether or not the address or number for this communication is invalid, such as a phone number has been disconnected or an email address is an undeliverable address.

IdentificationIdentifier
string

An identifier for this communication.

VersionIdentifier
string

An identifier of a version of this communication.

object

Contact address information for this communication.

{
  • "Value": "Beispiel Objekt"
}

Contact

IdentificationIdentifier
string

A unique identifier for this contact.

JobTitleText
string

The job title, position or designation, expressed as text, of this contact person within an organization such as Director, Software Engineer, Purchasing Manager.

ResponsibilityText
string

A responsibility, expressed as text, of this contact.

DepartmentNameText
string

A name, expressed as text, of the department to which this contact belongs within an organization, such as a support department.

TypeCode
string <enum>

A code specifying a type of contact.

PersonNameText
string

The name, expressed as text, of this contact person.

DescriptionText
string

A textual description of this contact.

PrimaryIndicator
boolean

The indication of whether or not this is a primary contact.

AccessibilityCode
string <enum>

The code specifying the type of accessibility for this contact.

VersionIdentifier
string

An identifier of a version of this contact.

{
  • "Value": "Beispiel Objekt"
}

Contract

IdentificationIdentifier
string

A unique identification for this contract.

TypeCode
string <enum>

A code specifying a type of contract such as a fixed price contract or a time and materials based contract.

CompletionPercent
number

A percentage of goods or services completed for this contract.

NameText
string

A name, expressed as text, for this contract.

DescriptionText
string

A textual description for this contract.

IssueDateTime
string <date-time>

A date or date time or other date time value of the issuance of this contract.

PriceAmount
number

A monetary value of a price of this contract.

ExtensionIndicator
boolean

To indicate whether or not this contract can be or has been extended.

ItemIdentifier
string

To identify a specific item in this contract.

StartDate
string <date>

A date on which this contract starts.

ItemQuantity
number

A quantity for a specific item in this contract.

FeePercent
number

A percent value of the contract price to be granted as a fee to the provider of the goods or services specified in this contract.

EndDate
string <date>

An end date for this contract.

FundingYearDateTime
string <date-time>

A unique identifier of a funding year for this contract.

LastItemDeliveryDate
string <date>

A date on which the last item was or will be delivered for this contract.

CostAmount
number

A monetary value for a cost of an effort or loss necessary to achieve a goal specified in this contract.

OriginalInceptionDateTime
string <date-time>

The date, time, date time or other date time value of the inception of the original version of this contract, which may differ from the contract issue date.

EffectiveDateTime
string <date-time>

A date, time, date time, or other date time value on which this contract became or will become effective.

SignedDateTime
string <date-time>

A date, time, date time, or other date time value on which this contract was or will be signed.

IssueCountryIdentifier
string

The unique identifier of the country in which this contract was issued.

LanguageCode
string <enum>

The code specifying the language in which this contract is written.

DurationTypeCode
string <enum>

The code specifying the type of duration of this contract, such as short term, long term, open ended.

RenewalFrequencyCode
string <enum>

The code specifying the frequency with which this contract is renewed, such as monthly, annually.

LastRenewalDateTime
string <date-time>

A date, time, date time, or other date time value on which this contract was last renewed.

TerminationNoticePeriodMeasure
number

The measure of the period required for providing notice of termination of this contract, such as number of days, number of months.

ReinstatementDateTime
string <date-time>

A date, time, date time, or other date time value on which this contract was or will be reinstated.

ReplacementIndicator
boolean

The indication of whether or not this contract is a replacement.

CounterSignatureIndicator
boolean

The indication of whether or not a counter signature procedure is needed for this contract.

ClauseText
string

A clause, expressed as text, of this contract.

ContractorLiabilityIndicator
boolean

An indication of whether or not this contractor liable in this contract.

EndDateTime
string <date-time>

A date, time, date time, or other date time value for the end of the contract.

FinalPaymentDateTime
string <date-time>

A date, time, date time, or other date time value of a final payment of the contract.

LastUseDateTime
string <date-time>

A date, time, date time, or other date time value of the last usage of the contract.

StatusCode
string <enum>

A code specifying a status of this contract.

ProjectIdentifier
string

An identifier of a project for this contract.

InformationText
string

Information, expressed as text, for this contract.

VersionIdentifier
string

An identifier of a version of this contract.

StartDateTime
string <date-time>

A date, time, date time, or other date time value for the start of this contract.

RenewalNumeric
number

A number of renewals for this contract.

RenewalStatusCode
string <enum>

The code specifying the status of the renewal of this contract.

object

A period within which this contract is a valid legal instrument.

object

A guarantee that supports this contract.

object

A party that is identified in the contract.

object

A document referenced by this contract.

object

A period within which the provisions of this contract are, or will be, in force.

object

A contract change describing modification of the terms of this contract after adoption.

object

A cost associated with this contract.

object

A project contained within this contract.

object

A contract line item specified in this contract.

object

A location where this contract was or will be signed.

object

A binding period for this contract.

object

The initial period for this contract.

object

The renewal term period for this contract.

object

An ordering party for this contract.

object

An observing party for this contract.

object

An invoicee party for this contract.

object

A party that sends this contract.

object

A party who issues this contract.

object

A buyer party for this contract.

object

A seller party for this contract.

object

A total price for this contract.

SubordinateContract
object Recursive

A subordinate contract for this contract.

object

Payment terms specified for this contract.

object

A contract section included in this contract.

object

A period when there is a lapse or gap in the duration of this contract.

{
  • "Value": "Beispiel Objekt"
}

ContractChange

IdentificationIdentifier
string

A unique identifier for this contract change.

NameText
string

A name, expressed as text, for this contract change.

DescriptionText
string

A textual description of this contract change.

EstimatedCostDifferenceAmount
number

A monetary value of an estimated cost difference for this contract change.

ActualCostDifferenceAmount
number

A monetary value of an actual cost difference for this contract change.

StatusCode
string <enum>

A code specifying a status for this contract change.

EffectiveDate
string <date>

A date on which the contract change has or will become effective.

object

A party identified in this contract change.

{
  • "Value": "Beispiel Objekt"
}

ContractLineItem

IdentificationIdentifier
string

A unique identifier for this contract line item.

NameText
string

A name, expressed as text, for this contract line item.

DescriptionText
string

A textual description of this contract line item.

TotalQuantity
number

A total quantity for this contract line item.

ActualAmount
number

A monetary value of an actual on which the contract line item is determined.

PaymentStatusCode
string <enum>

A code specifying a payment status of this contract line item.

VariationPercent
number

A percent of a variation of the contract line item, such as tolerance.

UnitAmount
number

A monetary value of a unit for the contract line item.

MeasurementCode
string <enum>

A code specifying a measurement for this contract line item, such as for packaging.

AssociatedContractLineItem
object Recursive

A contract line item associated to this contract line item.

{
  • "Value": "Beispiel Objekt"
}

ContractSection

IdentificationIdentifier
string

An identifier for this contract section.

VersionIdentifier
string

An identifier of a version of this contract section.

DescriptionText
string

A textual description of this contract section.

StartDateTime
string <date-time>

A date, time, date time, or other date time value for the start of this contract section.

EndDateTime
string <date-time>

A date, time, date time, or other date time value for the end of this contract section.

object

A total price for this contract section.

{
  • "Value": "Beispiel Objekt"
}

Cost

IdentificationIdentifier
string

A unique identifier for this cost.

NameText
string

A name, expressed as text, for this cost.

DescriptionText
string

A textual description of this cost.

TypeCode
string <enum>

A code specifying a type for this cost.

ComponentAmount
number

A monetary value that is a component of this cost.

EffectiveDate
string <date>

A date on which this cost has or will become effective.

ComponentQuantity
number

A number of the non-monetary value of the cost, such as hours.

ComponentNameText
string

A name, expressed as text, for a component of this cost.

UnitPriceMeasureCode
string <enum>

The code specifying the measure unit used for the corresponding unit price for this cost, such as per day, per tonne, per square metre.

UnitPriceAmount
number

The monetary value of the unit price applicable to this cost.

TaxInclusiveAmount
number

The monetary value of the cost including tax.

TaxExclusiveAmount
number

The monetary value of the cost excluding tax.

DiscountAmount
number

The monetary value of the discount applicable to the cost.

DiscountPercent
number

The percentage of the discount applicable to the cost.

RecurringIndicator
boolean

An indication of whether or not this cost is recurring.

StatusCode
string <enum>

The code specifying the status of this cost, such as estimated or actual.

DiscountTypeCode
string <enum>

The code specifying the discount type for this cost.

DiscountReasonCode
string <enum>

The code specifying the discount reason for this cost.

VersionIdentifier
string

An identifier of a version of this cost.

object

The reporting period over which this cost is tracked.

object

Tax applicable to this cost.

object

An actual payment of this cost.

object

The party assigned to this cost.

{
  • "Value": "Beispiel Objekt"
}

Country

IdentificationIdentifier
string

A unique identifier for a country (Reference ISO 3166 and UN/ECE Rec 3.).

NameText
string

A name, expressed as text, of the country.

object

A country sub-division subordinate to this country, such as a state, a county, a canton, a province.

{
  • "Value": "Beispiel Objekt"
}

CountrySubDivision

IdentificationIdentifier
string

A unique identifier for this sub-division of a country.

NameText
string

A name, expressed as text, of the sub-division of a country.

TypeCode
string <enum>

A code specifying a type of country sub-division.

DescriptionText
string

A textual description of this country sub-division.

HierarchicalLevelCode
string <enum>

The code specifying the hierarchical level of this country sub-division.

object

The party that owns this country sub-division.

SuperordinateCountrySubDivision
object Recursive

A superordinate country sub-division for this country sub-division.

SubordinateCountrySubDivision
object Recursive

A subordinate country sub-division within this country sub-division.

object

A party authorized within this country sub-division.

{
  • "Value": "Beispiel Objekt"
}

CurrencyExchange

SourceCurrencyCode
string <enum>

The code specifying the source currency of a currency conversion.

SourceUnitBasisNumeric
number

The numeric unit basis of the source currency used in the currency exchange rate calculation.

TargetCurrencyCode
string <enum>

The code specifying the target currency of a currency conversion.

TargetUnitBaseNumeric
number

The numeric unit basis of the target currency used in the currency exchange rate calculation.

MarketIdentifier
string

The unique identifier of the currency exchange market from which the exchange rate is taken.

ConversionRate
string

The rate factor used for conversion from the source currency to the target currency.

ConversionRateDateTime
string <date-time>

The date, time, date time or other date time value of the conversion rate for this currency exchange.

RateTypeCode
string <enum>

The code specifying the type of rate for this currency exchange.

object

Contract information applicable to this currency exchange.

object

A referenced document for this currency exchange.

object

An associated document for this currency exchange.

{
  • "Value": "Beispiel Objekt"
}

Document

MultipleTypeIndicator
boolean

An indication of whether or not a document is an aggregation of different types of business documents.

IdentificationIdentifier
string

A unique identifier for this document.

TypeCode
string <enum>

A code specifying a type of document [Reference United Nations Code List (UNCL) 1001].

NameText
string

A name, expressed as text, for this specific document.

PurposeText
string

A purpose, expressed in text, of this document.

DescriptionText
string

A textual description of this document.

IssueDateTime
string <date-time>

A date, time, date time or other date time value for an issuance of this document.

SubmissionDateTime
string <date-time>

The date, time, date time or other date time value for the formal submission of this document to a receiver by a sender.

ReceiptDateTime
string <date-time>

The date, time, date time or other date time value for the formal receipt of this document.

ControlRequirementIndicator
boolean

The indication of whether or not a document has specific control requirements.

AttachmentBinaryObject
string <binary>

A binary object that is attached or otherwise appended to this document.

CreationDateTime
string <date-time>

A date, time, date time or other date time value of a creation of the document.

StatusCode
string <enum>

A code specifying a status of a document.

CopyIndicator
boolean

The indication of whether or not the document is a copy.

ResponseDateTime
string <date-time>

A date, date time, time or other date time value for a response to this document.

ItemIdentificationIdentifier
string

The unique identifier of a specific item in this document.

RemarksText
string

A remark, expressed as text, regarding this document.

LanguageIdentifier
string

A unique identifier for a language used in this document.

CurrencyCode
string <enum>

A code specifying a currency in which monetary amounts are expressed in this document.

LineCountNumeric
number

A count of the number of lines in this document.

ProprietaryInformationTypeCode
string <enum>

The code specifying a status of a line in this d

RevisionText
string

A revision, expressed as text, for this document.

AuthorizationText
string

The authorization, expressed as text, for this document.

ChecksumNumeric
number

The number of the checksum for this document.

ProcessingTypeCode
string <enum>

The code specifying the type of processing for this document.

ItemQuantity
number

A quantity of items in a document.

AcceptanceDateTime
string <date-time>

The date, time, date time or other date time value of the acceptance of this document.

PurposeCode
string <enum>

A code specifying the purpose of this document, such as request or reminder.

InformationText
string

Information, expressed as text, for this document.

TotalPageQuantity
number

The total number of pages for this document.

CategoryCode
string <enum>

The code specifying the category of this document.

RevisionDateTime
string <date-time>

A date, time, date time or other date time value for the revision of this document.

RejectionReasonText
string

A reason, expressed as text, for the rejection of this document.

CancellationReasonCode
string <enum>

A code specifying the reason for the cancellation of this document, such as cancellation due to a change in circumstances invalidating the document, or cancellation due to inadvertent incorrect document content.

CancellationReasonText
string

A reason, expressed as text, for the cancellation of this document.

CancellationDateTime
string <date-time>

A date, time, date time, or other date time value of a cancellation of the document.

SequenceIdentifier
string

A unique identifier for the sequence of this document.

ResponseTypeCode
string <enum>

A code specifying a type of response for this document.

ResponseReasonCode
string <enum>

A code specifying a response reason for this document.

SectionNameText
string

A section name, expressed as text, for this document.

ExternalIdentifier
string

The unique identifier for this document which is external to the document itself, such as the document reference number on an envelope.

FirstVersionIssueDateTime
string <date-time>

The date, time, date time or other date time value when the first version of this document was issued.

ExaminedIndicator
boolean

The indication of whether or not the document has been examined.

VerifiedIndicator
boolean

The indication of whether or not the document has been verified.

SignedIndicator
boolean

The indication of whether or not the document has been signed.

SignedDateTime
string <date-time>

The date, time, date time or other date time value that the document was signed.

RequestedDateTime
string <date-time>

The date, time, date time or other date time value when the document is or was requested.

ChannelCode
string <enum>

The code specifying the channel by which the document is sent, such as mail, email, fax.

SignatureLocationText
string

A geographical location, expressed as text, where the document was or will be signed.

StatusText
string

A status, expressed as text, for this document.

RejectionDateTime
string <date-time>

The date, time, date time, or other date time value of the rejection of this document.

ResponseCode
string <enum>

A code specifying a response in this document.

VersionIdentifier
string

An identifier of a version of this document.

GeographicalSignatureLocationText
string

A geographical location, expressed as text, where this document was or will be signed.

SequenceNumeric
number

A sequence number of this document.

URIIdentifier
string

A Uniform Resource Identifier (URI) of this document.

UrgencyCode
string <enum>

A code specifying an urgency of this document.

PublicationDateTime
string <date-time>

A date, time, date time or other date time value for a publication of this document.

object

The period within which this document is effective.

ReferenceDocument
object Recursive

Other documents referenced by this document.

object

A party that issues this document.

object

The party that owns this document.

object

A location where this document has been or may be issued.

object

A party that sends this document.

object

A party that receives this document.

object

An organization acknowledging this document.

object

A binary file attached to this document.

object

A total price in this document.

{
  • "Value": "Beispiel Objekt"
}

EmployeeCount

UnionIndicator
boolean

The indication of whether or not the employee count applies to union employees.

FullTimeQuantity
number

The number of full time employees.

PartTimeQuantity
number

The number of part time employees.

SeasonalQuantity
number

The number of people employed only on a seasonal basis.

TemporaryQuantity
number

The number of people employed on a temporary basis.

ResignedQuantity
number

The number of people that left employment on a voluntary basis.

TerminatedQuantity
number

The number of people that left employment on an involuntary basis.

LeasedQuantity
number

The number of people employed on a leased basis.

IndependentContractorQuantity
number

The number of people employed as independent contractors.

TotalQuantity
number

The total number of employees working for an organization.

ExemptQuantity
number

The number of exempt employees.

Non-ExemptQuantity
number

The number of non-exempt employees.

CountrySub-DivisionIdentifier
string

The unique identifier of the country sub-division to which the employee counts apply, such as state or province.

CountryIdentifier
string

The unique identifier of the country to which the employee count applies.

LocationQuantity
number

The number of locations to which the employee count applies.

object

The span of time for which the employee count applies.

{
  • "Value": "Beispiel Objekt"
}

Fee

TypeCode
string <enum>

The code specifying the type of fee.

RatePercent
number

The percentage rate of the fee.

ActualAmount
number

The actual monetary value of the fee.

CreditIndicator
boolean

The indication of whether or not this fee is a credit.

TypeDescriptionText
string

The textual description of the type of fee.

object

A guarantee of payment of this fee.

{
  • "Value": "Beispiel Objekt"
}

FinancialAccount

IdentificationIdentifier
string

A unique identifier for this financial account.

TypeCode
string <enum>

A code specifying the type of financial account such as savings, checking.

AccountNameText
string

An account name, expressed as text, of this financial account.

CurrencyCode
string <enum>

A code specifying the currency of this financial account (Reference ISO 4217 codes).

TypeText
string

A type, expressed as text, of a financial account.

object

A party that owns this financial account.

object

A party that services this financial account on behalf of the account owner or owners.

object

A party that is entitled to receive information about this financial account.

object

A party that acts on behalf of another party related to this financial account.

object

The financial institution that services this financial account.

{
  • "Value": "Beispiel Objekt"
}

FinancialInstitution

BEIIdentifier
string

The unique Business Entity Identifier (BEI) as defined in ISO 9362 for this financial institution.

BICIdentifier
string

The unique Bank Identification Code (BIC) as defined in ISO 9362 for this financial institution.

GLNIdentifier
string

The unique Global Location Number (GLN) as defined by GS1 for this financial institution.

IdentificationIdentifier
string

A unique identifier for this financial institution.

NameText
string

A name, expressed as text, for this financial institution.

RoleCode
string <enum>

The code specifying a role for this financial institution, such as intermediary or settlement agent.

ClearingSystemNameText
string

A clearing system name, expressed as text, for this financial institution.

object

The postal address for this financial institution.

object

The country where this financial institution is located.

SubDivisionFinancialInstitution
object Recursive

A financial institution that is a sub-division (branch) of this financial institution.

OrganizationalUnitFinancialInstitution
object Recursive

A financial institution that is an organizational unit of this financial institution.

{
  • "Value": "Beispiel Objekt"
}

GeographicalCoordinate

AltitudeMeasure
number

The measure of the altitude that reflects the vertical elevation of an object above a surface for this geographical coordinate (Reference ISO 6709).

LatitudeMeasure
number

The measure of the latitude as an angular distance north or south from the Equator meridian to the meridian of a specific place for this geographical coordinate. (Reference ISO 6709).

LongitudeMeasure
number

The measure of the longitude as an angular distance east or west from the Greenwich meridian to the meridian of a specific place (Reference ISO 6709).

LatitudeDirectionIndicator
boolean

The indication of whether the latitude compass direction from the Equator meridian is North (true) or South (false) for this geographical coordinate.(Reference ISO 6709).

LongitudeDirectionIndicator
boolean

The indication of whether the longitude as a compass direction from the Greenwich meridian to the meridian of a specific place is East (-) or West (+) for this geographical coordinate. (Reference ISO 6709).

SystemIdentifier
string

The unique identifier of the reference system used for measuring a geographical coordinate.

IdentificationIdentifier
string

The unique identifier for this geographical coordinate.

AltimetricSystemIdentifier
string

The identifier of the system used for measuring the altitude for this geographical coordinate.

DescriptionText
string

A textual description of this geographical coordinate.

{
  • "Value": "Beispiel Objekt"
}

Guarantee

DescriptionText
string

A textual description for this guarantee.

LiabilityAmount
number

A monetary amount of liability for this guarantee.

ExemptionIndicator
boolean

An indication of whether or not the contract or business is exempted from the guarantee according to a regulation or business rule.

AmountRate
number

A rate used to calculate a guarantee amount.

ConditionText
string

A textual expression of the condition of this guarantee.

TypeCode
string <enum>

A code specifying the type of guarantee.

IdentificationIdentifier
string

An identifier for this guarantee.

VersionIdentifier
string

An identifier of a version of this guarantee.

CalculationRate
number

The rate used to calculate this guarantee.

object

An organization which has the authority to charge guarantee credit which is accompanied by placing an order.

object

The period within which this guarantee is effective.

object

Penalty charge information incurred under this guarantee.

object

A document referenced by this guarantee.

object

A subscriber organization which requests the issue of this guarantee.

object

A supporting document for this guarantee.

object

A party that provides a surety for this guarantee.

object

A country where this guarantee is invalid.

object

A requesting party for this guarantee.

{
  • "Value": "Beispiel Objekt"
}

InstalmentPlan

NextInstalmentDateTime
string <date-time>

The date, time, date time or other date time value when the next instalment is due to be paid under this instalment plan.

object

A payment for this instalment plan.

{
  • "Value": "Beispiel Objekt"
}

Location

IdentificationIdentifier
string

A unique identifier for this location such as a United Nations Location Code (UNLOCODE) or GS1 Global Location Number (GLN).

NameText
string

A name, expressed as text, of this location.

TypeCode
string <enum>

A code specifying the type of location.

DirectionsText
string

A textual description of how to reach the location.

DescriptionText
string

A textual description of the location.

DistrictIdentifier
string

A unique identifier of the district area regarded as a geographic or administrative unit within which this location is situated.

CountryNameText
string

A name, expressed as text, of the country for this location.

CountrySub-DivisionNameText
string

A name, expressed as text, of the sub-division of a country for this location.

CountryIdentifier
string

A unique identifier of a country for this location (Reference ISO 3166 and UN/ECE Rec 3).

CountrySub-DivisionIdentifier
string

The unique identifier of the country sub-division for this location.

GeopoliticalRegionNameText
string

The name, expressed as text, of the geopolitical region for this location.

GeopoliticalRegionCode
string <enum>

The code specifying the geopolitical region for this location.

CountrySuperordinateIdentifier
string

The unique identifier of the country superordinate (grouping of countries to a bigger entity) in which the location is situated.

UTCOffsetNumeric
number

The time offset value from the Universal Time Coordinate (UTC) for this location.

TypeText
string

A type, expressed as text, of this location.

RelatedDateTime
string <date-time>

A date, time, date time, or other date time value related to this location.

VersionIdentifier
string

An identifier of a version of this location.

ConditionCode
string <enum>

A code specifying a condition of this location, such as flooded.

PossessionDateTime
string <date-time>

A date, time, date time, or other date time value for possession of this location.

ManagementOrganizationCode
string <enum>

A code specifying an organization, such as a body of administrative officials, managing this location.

ReferenceCode
string <enum>

A code specifying a reference for this location.

object

Geographical coordinate information for this location.

object

Postal address information for this location.

SubordinateLocation
object Recursive

Subordinate location information within this location.

object

A party specified for this location.

object

The physical address of this location.

object

An availability period for a location.

object

A country sub-division specified for this location.

object

A tax applicable at a location.

RelatedLocation
object Recursive

A location related to this location.

object

A party responsible for this location.

object

An address specified for this location.

{
  • "Value": "Beispiel Objekt"
}

Occupation

TypeCode
string <enum>

The code specifying the type of occupation.

DescriptionText
string

The textual description of the occupation.

ClassCode
string <enum>

The code specifying the class of the occupation, such as accountancy, banking, car delivery.

RankingCode
string <enum>

The code specifying the relative importance (ranking) of this occupation with respect to the person's other occupations such as main occupation, secondary occupation.

Full-TimeIndicator
boolean

The indication of whether or not the occupation is full-time.

object

A period of time during which this occupation has been held.

{
  • "Value": "Beispiel Objekt"
}

Organization

BusinessTypeCode
string <enum>

A code specifying a type of business of this organization.

LegalClassificationCode
string <enum>

The code specifying the legal classification of this organization such as those representing Incorporated (Inc), limited liability corporation (LLC) or non-profit.

TaxRegistrationIdentifier
string

A unique tax registration identifier assigned to an organization for the purpose of collecting taxes. In the US, this could be the Federal Employer Identification Number (FEIN), in the EU this could be the Value Added Tax (VAT) Registration Number.

NameText
string

A name, expressed as text, of this organization.

IdentificationIdentifier
string

A unique identifier for this organization.

DescriptionText
string

A textual description of this organization.

DistrictIdentifier
string

A unique identifier of the district area regarded as a geographic or administrative unit within which this organization operates.

TradeMarkText
string

A trade mark, expressed as text, for an organization.

AbbreviatedNameText
string

An abbreviated name, expressed as text, for an organization.

TypeCode
string <enum>

A code specifying a type of organization.

FunctionCode
string <enum>

A code specifying a function of an organization.

EstablishedDateTime
string <date-time>

The date, time, date time, or other date time value when the organization was established.

TrustTypeCode
string <enum>

The code specifying the type of trust for the organization.

OwnerQuantity
number

The number of owners of the organization.

DBANameText
string

The DBA (Doing Business As) name of the organization, expressed as text.

TradingBusinessNameText
string

The trading business name of the organization, expressed as text.

DivisionNameText
string

The name of a division of the organization, expressed as text.

OrganizationalUnitIdentifier
string

The unique identifier of an organizational unit within an organization.

OrganizationalUnitFunctionCode
string <enum>

The code specifying the function of the organizational unit.

ProfitObjectiveCode
string <enum>

The code specifying the profit objective for the organization.

DissolvedDateTime
string <date-time>

The date, time, date time or other date time value when the organization was legally dissolved or went out of business.

PubliclyTradedIndicator
boolean

The indication of whether or not the organization is publicly traded.

TaxExemptIndicator
boolean

The indication of whether or not this organization is exempt from tax, such as from US federal tax or VAT.

BusinessDurationMeasure
number

The measure of the period of time that this organization has been in business.

ActiveIndicator
boolean

The indication of whether or not the organization is currently active.

OperationsScopeCode
string <enum>

The code specifying the scope of operations for this organization.

OperationsDescriptionText
string

The textual description of the operations performed by this organization.

DomesticLocationQuantity
number

The number of domestic locations for the organization.

ForeignLocationQuantity
number

The number of foreign locations for the organization.

MembersAndManagersQuantity
number

The number of members and managers in the organization.

CompanyMergerDateTime
string <date-time>

The date, time, date time or other date time value when the organization merged with another company to form the current organization.

MergedCompanyNameText
string

The merged company name, expressed as text, for this organization.

CompanyNameChangeDateTime
string <date-time>

The date, time, date time or other date time value when the organization changed from its previous name to its current name.

PreviousNameText
string

The previous name of the organization, expressed as text.

BrokerRelationshipDateTime
string <date-time>

The date, time, date time or other date time value when the organization first established a relationship with its broker.

ParentText
string

The parent organization, expressed as text, of this organization.

LanguageCode
string <enum>

The code specifying the language of this organization.

ParentIdentifier
string

A unique identifier for the parent of this organization.

NameChangeDateTime
string <date-time>

A date, time, date time or other date time value when this organization changed from its previous name to its current name.

CapitalValueAmount
number

A monetary value of the capital of this organization.

DomesticRegisteredIndicator
boolean

The indication of whether or not the organization is registered within the country of the address specified.

object

A primary contact information for this organization.

SubordinateOrganization
object Recursive

An organization subordinate to this organization.

object

A postal address for this organization.

object

A physical location for this organization.

object

Information for a designated contact within this organization.

InternalUnitOrganization
object Recursive

An internal unit within this organization.

CompanyBranchOrganization
object Recursive

A company branch of this organization.

FieldOfficeOrganization
object Recursive

A field office of this organization.

object

An employee count specified for this organization.

object

The period during which the organization has been operating under its present name.

object

The period during which the organization has actually been operating.

object

The primary person for this organization.

ParentOrganization
object Recursive

A parent organization of this organization.

object

A designated party for this organization.

object

A person who is authorized to act for this organization.

object

A physical address for this organization.

object

A party responsible for this organization.

{
  • "Value": "Beispiel Objekt"
}

Party

IdentificationIdentifier
string

A unique identifier of the party.

TypeCode
string <enum>

A code specifying the type of party that is independent of its role.

NameText
string

A name, expressed as text, for this party.

DescriptionText
string

A textual description of this party.

AccessRightsCode
string <enum>

A code specifying this party's access rights such as unlimited, restricted, prohibited.

ClassificationCode
string <enum>

A code specifying a classification for this party.

RoleCode
string <enum>

A code specifying the role of this party.

LanguageCode
string <enum>

A code specifying a language for this specific party.

ResidenceCountryIdentifier
string

The unique identifier of the residence country of this party.

CountryIdentifier
string

A unique country identifier for this party.

BranchIndicator
boolean

An indication of whether or not this party is a branch of an organization.

AssignedToRoleDateTime
string <date-time>

The date, time, date time or other date time value when this role was assigned to the party.

VersionIdentifier
string

An identifier of a version of this party.

RatingCode
string <enum>

The code specifying the rating of this party.

object

A defined contact for this party.

object

The organization specified for this party.

object

The residence address for this party.

object

A postal address for this party.

object

A telephone communication for this party.

object

A fax communication for this party.

object

A Uniform Resource Identifier (URI) communication for this party, such as a web or email address.

AssociatedParty
object Recursive

A party associated with this party, such as a local agent of a shipping line.

object

A location or place specified for this party.

object

A document referenced by this party.

object

An office address for this party.

object

The party group specified for this party.

object

An appointed person for this party.

object

A binary file associated with this party, such as the binary representation of a picture or company logo.

object

A financial account owned by this party.

object

A country specified for this party.

ParentParty
object Recursive

A party that is a parent of this party.

DesignatedParty
object Recursive

A designated party for this party.

object

A specified person for this party.

{
  • "Value": "Beispiel Objekt"
}

PartyGroup

DescriptionText
string

The textual description of the party group.

EffectiveDateTime
string <date-time>

The date, time, date time or other date time value that the party group became effective.

FullNameText
string

The full name of the party group, expressed as text.

OperatingStatusCode
string <enum>

The code specifying the operating status of the party group, such as active or inactive.

TypeCode
string <enum>

The code specifying the type of party group.

MemberQuantity
number

The number of individuals in the party group.

PurposeCode
string <enum>

The code specifying the common interest or purpose of the party group.

EndDateTime
string <date-time>

The date, time, date time or other date time value of the end of the party group.

AdultQuantity
number

The number of adults in the party group.

ChildrenQuantity
number

The number of children in the party group.

SeniorsQuantity
number

The number of senior citizens in the party group.

CouplesQuantity
number

The number of couples in the party group.

FamilyQuantity
number

The number of families in the party group.

InfantQuantity
number

The number of infants (ages one year or less) in the party group.

SingleParentFamilyQuantity
number

The number of single parent families in the party group.

object

A specified person in the party group.

{
  • "Value": "Beispiel Objekt"
}

Payment

InstructionIdentifier
string

A unique identifier for a payment instruction as assigned by the clearing agent or initiating party.

ReceivedDateTime
string <date-time>

A date, time, date time, or other date time value on which the payment has been or will be received by a party in the payment chain.

PaidAmount
number

A monetary value of the funds or securities to be paid for this payment.

TaxAmount
number

A monetary value of the taxes that are part of the total payment amount.

CreationDateTime
string <date-time>

A date, time, date time, or other date time value on which the payment has been or will be created by the originator of the payment.

RequestedExecutionDateTime
string <date-time>

A date, time, date, or other date time value the originator [the debtor or creditor] requests the clearing agent to process the payment instruction.

InstructionCode
string <enum>

A code specifying an instruction for the payment.

PriorityCode
string <enum>

A code specifying the relative urgency or importance that the recipient would like the originator to apply to the payment.

StatusCode
string <enum>

A code specifying status information about this payment.

TypeCode
string <enum>

A code specifying the type of payment such as cash or credit.

ReasonCode
string <enum>

A code specifying the reason for a payment.

PenaltyPercent
number

A percent applied to calculate the penalty for this payment.

DiscountPercent
number

A percent applied to calculate the discount for this payment.

DueDateTime
string <date-time>

A date, time, date time or other date time value of a due date for this payment.

ServiceLevelCode
string <enum>

The code specifying the service level for this payment.

ServiceLevelText
string

The service level, expressed as text, for this payment.

ClearingChannelCode
string <enum>

The code specifying the clearing channel for this payment.

LocalInstrumentCode
string <enum>

A code specifying the local instrument for this payment, such as a settlement means defined by a user community.

PoolingAdjustmentDateTime
string <date-time>

The date, time, date time, or other date time value used in the pooling adjustment for this payment, such as the correction of the value date of a cash pool movement that has been posted with a different value date.

EntitlementIndicator
boolean

An indication of whether or not this payment is entitled.

SequenceCode
string <enum>

The code specifying the sequence of this payment, such as whether it is a deposit or a first, last or intermediate instalment.

PayerAssignedReferenceIdentifier
string

The unique reference identifier for this payment, as assigned by the payer.

IdentificationIdentifier
string

An identifier for this payment.

InformationText
string

Information, expressed as text, about this payment.

AcceptedAmount
number

A monetary value accepted for this payment.

RequestedAmount
number

A monetary value requested for this payment.

object

A trade settlement specified for this payment.

{
  • "Value": "Beispiel Objekt"
}

PaymentDiscountTerms

BasisDateTime
string <date-time>

A date, time, date time, or other date time value used as the basis to calculate the payment discount in the payment discount terms.

BasisPeriodMeasure
number

A measure of the basis period for the payment discount terms.

BasisAmount
number

A monetary value used as a basis to calculate the discount in the payment discount terms.

CalculationPercent
number

A percentage used to calculate the discount in the payment discount terms.

ActualDiscountAmount
number

A monetary value of an actual discount in the payment discount terms.

SettlementPeriodMeasure
number

A measure of the settlement period for these payment discount terms.

{
  • "Value": "Beispiel Objekt"
}

PaymentInstruction

InformationType
string <enum>

The code specifying the type of information for this payment instruction, such as processing requirements.

CreditorAgentInformation
string <enum>

Creditor agent information, expressed as text, for this payment instruction, such as processing information that may need to be acted upon by the creditor agent.

DebtorAgentInformation
string <enum>

Debtor agent information, expressed as text, for this payment instruction, such as processing information that may need to be acted upon by the debtor agent.

ApprovalRequirement
number

The indication of whether or not approval is required for this payment.

object

A payment terms identified for this payment instruction.

object

The party acting as an agent of the payer to carry out this payment instruction.

{
  • "Value": "Beispiel Objekt"
}

PaymentMeans

PaymentChannelCode
string <enum>

The code specifying the payment means channel through which the payment is to be processed. (Reference United Nations Location Code (UNCL) 4435).

TypeCode
string <enum>

A code specifying a type of payment means, such as cash or cheque.

GuaranteeMethodCode
string <enum>

The code specifying the method of guarantee for the payment means such as bank guarantee, public authority guarantee, standby letter of credit.

PaidAmount
number

A monetary value of the funds or securities to be paid by this means of payment.

PaymentMethodCode
string <enum>

A code specifying the method in which a payment may be made or regarded as made for this payment means.

TypeText
string

A type of this payment means, expressed as text.

InformationText
string

Information, expressed as text, for this payment means.

IdentificationIdentifier
string

An identifier for these payment means.

{
  • "Value": "Beispiel Objekt"
}

PaymentPenaltyTerms

BasisDateTime
string <date-time>

A date, time, date time, or other date time value used as the basis to calculate the payment penalty terms.

BasisPeriodMeasure
number

A measure of the period used as a basis to calculate the payment penalty terms.

BasisAmount
number

A monetary value used as a basis to calculate the penalty in the payment penalty terms.

CalculationPercent
number

A percentage used to calculate the penalty in the payment penalty terms.

ActualPenaltyAmount
number

A monetary value of an actual penalty in the payment penalty terms.

SettlementPeriodMeasure
number

A measure of the settlement period for these payment penalty terms.

object

A currency exchange that is used in the settlement of the payment.

object

The party that an acts on behalf of another party as an agent in the payment chain to carry out payment.

object

A payment means identified for this payment.

object

Payment terms identified for this payment.

object

A fee charged for payment administration which is part of the total payment amount for this payment.

object

A guarantee identified for this payment.

object

A financial account specified for this payment.

object

A payee party for this payment.

object

A requesting party for this payment.

object

A tax included in this payment.

{
  • "Value": "Beispiel Objekt"
}

PaymentTerms

IdentificationIdentifier
string

A unique identifier of these payment terms.

DescriptionText
string

A textual description of these payment terms.

DueDateDateTime
string <date-time>

A date, time, date time, or other date time value of a due date for these payment terms.

DurationMeasure
number

The measure of the length of time duration for these payment terms such as 12 hours, 15 days, 2 weeks, 3 months, 5 years.

TypeCode
string <enum>

A code specifying the type of payment terms.

SettlementDiscountRate
number

The rate for the settlement discount that is offered for payment under these payment terms.

SettlementSurchargeRate
number

The rate for the settlement surcharge that may be charged under these payment terms.

SettlementPeriodMeasure
number

A measure of the number of settlement periods from the payment term time reference to the latest payment date such as 30 days, 3 months.

SettlementDiscountAmount
number

A monetary value of a settlement discount offered for payment under these payment terms.

FromEventCode
string <enum>

A code specifying the event from which payment terms are offered for a length of time.

EquivalentAmount
number

An equivalent monetary value to be transferred between debtor and creditor before deduction of charges for these payment terms, expressed in the currency of the debtor's account which is different but equivalent from the currency in which it is to be transferred.

InstructedAmount
number

A monetary value that has been instructed to be transferred between debtor and creditor for these payment terms before deduction of charges.

PaymentTransactionTypeIndicator
boolean

The indication of whether or not the payment transaction type is credit or debit for these payment terms.

InformationText
string

Information, expressed as text, for these payment terms.

CurrencyCode
string <enum>

A code specifying a currency for these payment terms.

InstructionCode
string <enum>

A code specifying an instruction for these payment terms.

PartialPaymentPercent
number

A partial payment, expressed as a percent, in these payment terms.

AdditionalPostponementCode
string <enum>

The code specifying the additional postponement for these payment terms, such as the end of the month, 10 days after the end of the month, 15 days after the end of the month.

PartialPaymentAmount
number

A monetary value of a partial payment in these payment terms.

DueDateTime
string <date-time>

A date, time, date time, or other date time value of a due date for these payment terms.

object

A period over which the settlement terms are offered as part of the payment terms.

object

A period after which a penalty is charged as part of the payment terms.

object

Payment penalty terms applicable to these payment terms.

object

Payment discount terms applicable to these payment terms.

object

The party that acts on behalf of another party for these payment terms.

object

The financial account related to these payment terms.

object

A payee party in these payment terms.

{
  • "Value": "Beispiel Objekt"
}

PenaltyCharge

DueAmount
number

An amount of penalty that may be due as a result of this breach.

CalculationRate
number

A rate used to calculate the due amount for the penalty charge.

ExemptionIndicator
boolean

The indication of whether or not the penalty charge applies to a specific payer.

ConditionText
string

The condition, expressed as text, for this penalty charge.

object

A period within which this penalty charge is valid or effective.

object

Document information referenced by this penalty charge.

{
  • "Value": "Beispiel Objekt"
}

Period

DurationMeasure
number

A measure of the length of time for this time period such as hours, days, weeks, months, years.

InclusiveIndicator
boolean

The indication of whether or not the start and end dates are included in this period.

DescriptionText
string

A textual description of this period of time.

StartDateTime
string <date-time>

The date, time, date time or other date time value for the start of this period of time.

EndDateTime
string <date-time>

The date, time, date time or other date time value which specifies the end of this period of time.

CompleteDateTime
string <date-time>

The date, time, date time or other date time value for a complete period of time expressed as a specific month, a specific week etc.

OpenIndicator
boolean

The indication of whether or not an entity is open during this period.

IdentificationIdentifier
string

A unique identifier of this period.

SeasonCode
string <enum>

A code specifying the season for this period.

NameText
string

A name, expressed as text, of this period.

SequenceNumeric
number

A sequence number for this period.

ContinuousIndicator
boolean

The indication of whether or not the period is continuous.

PurposeCode
string <enum>

The code specifying the purpose of a period.

DayOfWeekCode
string <enum>

A code specifying a day of the week for a period.

FunctionCode
string <enum>

A code specifying the function of this period, such as fiscal period, accounting period.

VersionIdentifier
string

An identifier of a version of this period.

DurationCode
string <enum>

The code specifying the duration for this period, such as under one year, over one year.

{
  • "Value": "Beispiel Objekt"
}

Person

IdentificationIdentifier
number

A unique identifier for this person.

NameText
string

A name or set of names, expressed as text, by which this person is known.

GivenNameText
string

Name or names, expressed as text, usually given to a person by his/her parents at birth.

MiddleNameText
string

Name or names, expressed as text, usually given to a person by his/her parents at birth, other than the first name.

FamilyNameText
string

A name, expressed as text, that a person shares with members of his/her family.

TitleText
string

A textual expression of the title associated with a specific person, such as Doctor, Mr., Mrs., Ms.

SalutationText
string

A formal sign or expression of greeting, expressed as text, that is appropriate for this person such as Right Honourable, Monsignor or Madam.

MaritalStatusCode
number

A code specifying the married status of this person such as married, single, or divorced.

GenderCode
number

A code specifying the gender of this person such as male, female.

BirthDateTime
string <date-time>

A date, time, date time or other date time value which specifies the birth date for this person.

DeathDateTime
string <date-time>

A date, time, date time or other date time value which specifies the death date for this person.

DescriptionText
string

A textual description of this person.

MaidenNameText
string

A family name, expressed as text, of a person before first marriage.

SocialInsuranceContractIdentifier
number

The unique identifier for the person's contract with the social insurance provider.

AlternateLanguageIdentifier
number

The unique identifier of the language alternate to the native language of this person.

AlternateLanguageProficiencyCode
number

The code specifying the proficiency of the individual in the alternate language specified.

BirthplaceNameText
string

The name of the place where this person was born, expressed as text.

ChildrenQuantity
number

The number of children this person has.

HandicappedIndicator
boolean

The indication of whether or not the person is handicapped.

object

A residence address for this person.

object

A country that constitutes a nationality by origin, birth, or naturalization for this person.

object

Telephone communication information for this person.

object

Fax communication information for this person.

object

Uniform Resource Identifier (URI) communication information for this person such as a web or email address.

FiliationPerson
object Recursive

A person that is a filiation of this person, such as a child.

object

The financial situation applicable to this person.

object

A qualification attained by this person.

object

An occupation specified for this person.

{
  • "Value": "Beispiel Objekt"
}

PersonFinancialSituation

EstimatedGrossAnnualNonSalaryIncomeAmount
number

The monetary value of the annual estimated gross income for this person which is not included in salary.

EstimatedAnnualSalaryAmount
number

The monetary value of the estimated annual salary of this person.

IncomeInformationFromPersonIndicator
boolean

The indication of whether or not income and net worth amounts are from the person or estimated by the agent.

NetIncomeAmount
number

The monetary value of a person's net income.

NetSavingsAmount
number

The monetary value of a person's net savings.

EstimatedNetWorthAmount
number

The monetary value of a person's estimated net worth.

TotalAnnualIncomeAmount
number

The monetary value of a person's total annual income.

DisposableIncomeAmount
number

The amount of money that a person can spend after having paid all fixed expenses, such as rent or mortgage repayment.

FixedAssetAmount
number

The monetary value of a person's fixed assets.

GrossAnnualIncomeRangeText
string

The range of a person's gross annual income, expressed as text.

LiquidAssetAmount
number

The monetary value of a person's liquid assets.

EstimatedTotalLiabilitiesAmount
number

The monetary value of a person's estimated total liabilities.

LiquidNetWorthAmount
number

The monetary value of a person's liquid net worth.

{
  • "Value": "Beispiel Objekt"
}

Price

TypeCode
string <enum>

A code specifying the type of price.

ChargeAmount
number

A monetary value of a price charged.

BasisQuantity
number

A quantity on which the price is based.

NetPriceIndicator
boolean

An indication of whether or not the price is a net price.

MinimumChargeAmount
number

A monetary value that is the minimum charge in a range of prices.

MaximumChargeAmount
number

A monetary value that is the maximum charge in a range of prices.

MinimumQuantity
number

A minimum quantity in a range for which this price applies.

MaximumQuantity
number

A maximum quantity in a range for which the price applies.

UnitAmount
number

A monetary value of a unit price.

ChangeReasonText
string

A reason, expressed as text, for a change of the price.

UnitConversionFactorNumeric
number

The value used as a factor to convert the price unit.

TypeText
string

The type of price, expressed as text.

CalculationPercent
number

The percent used in the price calculation.

ChargeApplicableIndicator
boolean

An indication of whether or not a charge is applicable to a price.

CommissionPaidIndicator
boolean

The indication of whether or not a commission will be paid for a price.

ReasonCode
string <enum>

The code specifying the reason for a price.

ReasonApplicableQuantity
number

The number applicable to the reason for this price.

DeterminationCode
string <enum>

The code specifying how a price is determined.

ComparisonMethodCode
string <enum>

The code specifying a comparison method for this price.

ChargeDateTime
string <date-time>

A date, time, date time, or other date time value when this price was or will be charged.

CustomerServicePointQuantity
number

A number of customer service points, such as frequent flyer miles, for this price.

InformationText
string

Information, expressed as text, about this price.

object

A period for which this price is valid.

object

A tax included in this price.

object

A referenced document for this price.

object

A delivery location for this price.

ComparisonPrice
object Recursive

A price that provides a comparison with this price.

ChargedPrice
object Recursive

A price charged for this price, such as a discount price.

object

A tax charged for this price.

{
  • "Value": "Beispiel Objekt"
}

Project

IdentificationIdentifier
string

A unique identifier of this project.

DescriptionText
string

A textual description of this project.

NameText
string

A name, expressed as text, of this project.

TypeCode
string <enum>

A code specifying the type of project.

ConstraintIndicator
boolean

An indication of whether or not the project is constrained by an authority such as the World Trade Organization (WTO).

BudgetAmount
number

A monetary value of a budget for this project.

WorksTypeCode
string <enum>

A code specifying the works type of this project, such as repair or building operation.

ContractIdentifier
string

A unique identifier for a contract for this project.

ProjectPortfolioIdentifier
string

A unique identifier for a project portfolio for this project.

PurposeCode
string <enum>

A code specifying a purpose for this project.

VersionIdentifier
string

An identifier of a version of this project.

LargerAgreementPartIndicator
boolean

An indication of whether or not this project is part of a larger agreement.

object

A baseline calendar for this project.

object

A physical location for this project.

object

A planned period for this project.

object

A cost that is managed within this project.

object

A management reserve cost item set aside for contingencies that is accounted for as a cost for this project.

object

An undistributed budget item that has not been allocated to any task that is accounted for as a cost for this project.

object

An overhead cost item representing routine administrative and maintenance expenses for this project.

object

A cost of funds borrowed for this project.

object

A total cost for this project.

{
  • "Value": "Beispiel Objekt"
}

Qualification

TypeCode
string <enum>

A code specifying the type of qualification.

NameText
string

A name, expressed as text, of this qualification.

AbbreviatedNameText
string

An abbreviated name, expressed as text, of this qualification.

EndorsementCode
string <enum>

A code specifying an endorsement to this qualification, such as the type of special service that a person is allowed to perform.

object

The country issuing this qualification.

object

A certification document for this qualification.

{
  • "Value": "Beispiel Objekt"
}

Tax

IdentificationIdentifier
string

A unique identifier for this tax.

CalculatedAmount
number

A monetary value resulting from the calculation of a tax.

TypeCode
string <enum>

A code specifying a type of tax, such as a code for a Value Added Tax (VAT) [Reference United Nations Code List (UNCL) 5153].

ExemptionReasonText
string

A reason, expressed as text, for exemption from the tax.

CalculatedRate
number

A rate used to calculate the tax amount.

CalculationSequenceNumeric
number

A numeric expression of the sequence in which the tax is to be or has been applied when multiple taxes are applicable per calculation such as first Value Added Tax (VAT), second Transfer.

BasisQuantity
number

A quantity used as the principal component in calculating a tax amount.

BasisAmount
number

A monetary value used as the basis in calculating the tax amount.

CategoryCode
string <enum>

The code specifying the category to which the tax applies such as codes for Exempt from Tax, Standard Rate, Free Export Item - Tax Not Charged.

CurrencyCode
string <enum>

The code specifying a currency of the tax.

JurisdictionText
string

A jurisdiction, expressed as text, to which the tax applies.

CustomsDutyIndicator
boolean

The indication of whether or not this tax is a customs duty.

ExemptionReasonCode
string <enum>

A code specifying a reason for exemption from this tax.

TaxBasisAllowanceRate
number

The rate of the tax basis allowance (deduction or discount) used to calculate the tax.

IdentificationText
string

An identification, expressed as text, for a tax.

DueDateTime
string <date-time>

The date, time, date time, or other date time value of when tax is due.

DescriptionText
string

A textual description of this tax.

TypeText
string

A type of tax, expressed as text.

PaymentIdentifier
string

A unique identifier of a payment of this tax.

PaymentMethodCode
string <enum>

A code specifying a payment method for this tax.

DeductionAmount
number

A monetary value of a deduction from this tax.

SelfAssessedCalculatedAmount
number

A monetary value of a self-assessed calculated amount of this tax.

SelfAssessedBasisQuantity
number

A quantity used as a basis in calculating a self-assessed tax amount.

SelfAssessedBasisAmount
number

A monetary value used as a basis in calculating a self-assessed tax amount.

RegimeTypeText
string

A type of regime, expressed as text, applicable to an assessment or calculation of this tax, such as a preferential duty rate.

RegimeTypeCode
string <enum>

A code specifying a type of regime applicable to an assessment or calculation of this tax, such as a preferential duty rate.

ExemptionIndicator
boolean

The indication of whether or not there is an exemption from this tax.

RefundAmount
number

A monetary value of a refund of this tax.

RateCode
string <enum>

The code specifying the rate for this tax.

RateText
string

The rate, expressed as text, for this tax.

GuaranteeCode
string <enum>

The code specifying an undertaking given in cash, bond or as a written guarantee to ensure that an obligation will be fulfilled for this tax, levy or duty.

GuaranteeText
string

The undertaking, expressed as text, given in cash, bond or as a written guarantee to ensure that an obligation will be fulfilled for this tax, levy or duty.

TariffDeductionQuantity
number

A quantity to be deducted from the tariff quantity for the calculation of this tax, levy or duty.

InformationAmount
number

A monetary value of an amount being reported for information for this tax.

DueDateTypeCode
string <enum>

The code specifying the type of due date for this tax.

CategoryNameText
string

A category name, expressed as text, of this tax.

FunctionCode
string <enum>

A code specifying the function of this tax, such as tax, duty or fee.

BasisCode
string <enum>

The code specifying the basis of a tax.

TaxFreeAmount
number

The monetary value that is tax free for the tax.

CreditIndicator
boolean

The indication of whether or not the tax amount is a credit.

JurisdictionIdentifier
string

The unique jurisdiction identifier for this tax.

StatusCode
string <enum>

The code specifying the status of a tax.

ApplicablePercent
number

A percent of tax applicable, such as to an object or an activity.

RefundableIndicator
boolean

The indication of whether or not this tax is refundable.

RefundedAtPurchaseIndicator
boolean

The indication of whether or not this tax was refunded at purchase.

AuthorityAssessedAmount
number

A monetary value assessed by an authority for this tax.

BasisAllowanceRate
number

A rate of the basis allowance (deduction or discount) used to calculate this tax.

SpecifiedTaxPointDateTime
string <date-time>

The date, time, date time or other date time value specified as the tax point for this tax.

GrandTotalAmount
number

A monetary value of the grand total of the basis plus tax.

object

A specified accounting account for this tax.

object

The financial account of a party for this tax.

object

A period for which a tax is valid.

object

A country or country sub-division where a service was supplied for this tax.

object

A location where this tax is applicable.

object

A payment associated with an incidence of this tax.

object

A location of a collection office for this tax.

object

A guarantee for the payment of this tax.

{
  • "Value": "Beispiel Objekt"
}

TradeSettlement

InvoiceDateTime
string <date-time>

A date, time, date time, or other date time value of an invoice in this trade settlement.

CreditorReferenceIssuerIdentifier
string

An identifier of the issuer of the creditor reference for this trade settlement.

CurrenCode
string <enum>

A code specifying a currency for this breakdown statement.

TotalInvoiceAmount
number

A monetary value of the total invoice on which this trade settlement is calculated.

DescriptionText
string

A textual description of this trade settlement.

ReferenceText
string

A reference, expressed as text, for this trade settlement.

object

An accounting account specified for this trade settlement.

object

A payment specified for this trade settlement.

object

A payment specified for this trade settlement.

object

Payment terms specified for this trade settlement.

object

A payment specified for this trade settlement.

{
  • "Value": "Beispiel Objekt"
}

WorkShift

IdentificationIdentifier
string

A unique identifier for this work shift.

DayCode
string <enum>

A code specifying a day for this work shift.

NameText
string

A name, expressed as text, of this work shift.

object (Period)

A specific period of time such as the length of time between two known date/time points, from a start date onwards, or up to an end date.

{
  • "Value": "Beispiel Objekt"
}