Party Management TMF Webservices API

basic

extended

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

attachmentType
optional

Attachment type such as video, picture

string

content
optional

The actual contents of the attachment object, if embedded, encoded as base64

string

description
optional

A narrative text describing the content of the attachment

string

href
optional

URI for this Attachment

string

id
optional

Unique identifier for this particular attachment

string

mimeType
optional

Attachment mime type such as extension file for video, picture and document

string

name
optional

The name of the attachment

string

size
optional

The size of the attachment.

Quantity

url
optional

Uniform Resource Locator, is a web page address (a subset of URI)

string

validFor
optional

The period of time for which the attachment is valid

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

name
required

Name of the characteristic

string

value
required

The value of the characteristic

object

valueType
optional

Data type of the value of the characteristic

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

characteristic
optional

Any additional characteristic(s) of this contact medium

MediumCharacteristic

mediumType
optional

Type of the contact medium, such as: email address, telephone number, postal address

string

preferred
optional

If true, indicates that is the preferred contact medium

boolean

validFor
optional

The time period that the contact medium is valid for

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

disabilityCode
optional

Code of the disability

string

disabilityName
optional

Name of the disability

string

validFor
optional

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name.

string

code
required

Application relevant detail, defined in the API or a common list.

string

message
optional

More details and corrective actions related to the error which can be shown to a client user.

string

reason
required

Explanation of the reason for the error which can be shown to a client user.

string

referenceError
optional

URI of documentation describing the error.

string

status
optional

HTTP Error code extension

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

externalReferenceType
optional

Type of the external reference

string

name
optional

External reference name

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

aristocraticTitle
optional

e.g. Baron, Graf, Earl,…

string

birthDate
optional

Birth date

string(date-time)

contactMedium
optional

< ContactMedium > array

countryOfBirth
optional

Country where the individual was born

string

creditRating
optional

< PartyCreditProfile > array

deathDate
optional

Date of death

string(date-time)

disability
optional

< Disability > array

externalReference
optional

< ExternalReference > array

familyName
optional

Contains the non-chosen or inherited name. Also known as last name in the Western context

string

familyNamePrefix
optional

Family name prefix

string

formattedName
optional

A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)

string

fullName
optional

Full name flatten (first, middle, and last names)

string

gender
optional

Gender

string

generation
optional

e.g.. Sr, Jr, III (the third),…

string

givenName
optional

First name of the individual

string

href
optional

Hyperlink to access the organization

string

id
optional

Unique identifier of the organization

string

individualIdentification
optional

< IndividualIdentification > array

languageAbility
optional

< LanguageAbility > array

legalName
optional

Legal name or birth name (name one has for official purposes)

string

location
optional

Temporary current location od the individual (may be used if the individual has approved its sharing)

string

maritalStatus
optional

Marital status (married, divorced, widow …)

string

middleName
optional

Middles name or initial

string

nationality
optional

Nationality

string

otherName
optional

< OtherNameIndividual > array

partyCharacteristic
optional

< Characteristic > array

placeOfBirth
optional

Reference to the place where the individual was born

string

preferredGivenName
optional

Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname

string

relatedParty
optional

< RelatedParty > array

skill
optional

< Skill > array

status
optional

Status of the individual

enum (initialized, validated, deceaded)

taxExemptionCertificate
optional

< TaxExemptionCertificate > array

title
optional

Useful for titles (aristocratic, social,…) Pr, Dr, Sir, …

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

attachment
optional

AttachmentRefOrValue

identificationId
optional

Identifier

string

identificationType
optional

Identification type (passport, national identity card, drivers license, social security number, birth certificate)

string

issuingAuthority
optional

Authority which has issued the identifier, such as: social security, town hall

string

issuingDate
optional

Date at which the identifier was issued

string(date-time)

validFor
optional

The period for which the identification information is valid.

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

isFavouriteLanguage
optional

A “true” value specifies whether the language is considered by the individual as his favourite one

boolean

languageCode
optional

Language code (RFC 5646)

string

languageName
optional

Language name

string

listeningProficiency
optional

Listening proficiency evaluated for this language

string

readingProficiency
optional

Reading proficiency evaluated for this language

string

speakingProficiency
optional

Speaking proficiency evaluated for this language

string

validFor
optional

TimePeriod

writingProficiency
optional

Writing proficiency evaluated for this language

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

city
optional

The city

string

contactType
optional

The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…

string

country
optional

The country

string

emailAddress
optional

Full email address in standard format

string

faxNumber
optional

The fax number of the contact

string

phoneNumber
optional

The primary phone number of the contact

string

postCode
optional

Postcode

string

socialNetworkId
optional

Identifier as a member of a social network

string

stateOrProvince
optional

State or province

string

street1
optional

Describes the street

string

street2
optional

Complementary street description

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

contactMedium
optional

< ContactMedium > array

creditRating
optional

< PartyCreditProfile > array

existsDuring
optional

TimePeriod

externalReference
optional

< ExternalReference > array

href
optional

Hyperlink to access the organization

string

id
optional

Unique identifier of the organization

string

isHeadOffice
optional

If value is true, the organization is the head office

boolean

isLegalEntity
optional

If value is true, the organization is a legal entity known by a national referential.

boolean

name
optional

Organization name (department name for example)

string

nameType
optional

Type of the name : Co, Inc, Ltd,…

string

organizationChildRelationship
optional

< OrganizationChildRelationship > array

organizationIdentification
optional

< OrganizationIdentification > array

organizationParentRelationship
optional

OrganizationParentRelationship

organizationType
optional

Type of Organization (company, department…)

string

otherName
optional

< OtherNameOrganization > array

partyCharacteristic
optional

< Characteristic > array

relatedParty
optional

< RelatedParty > array

status
optional

Status of the organization

enum (initialized, validated, closed)

taxExemptionCertificate
optional

< TaxExemptionCertificate > array

tradingName
optional

Name that the organization (unit) trades under

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

organization
optional

OrganizationRef

relationshipType
optional

Type of the relationship. Could be juridical, hierarchical, geographical, functional for example.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

attachment
optional

AttachmentRefOrValue

identificationId
optional

Identifier

string

identificationType
optional

Type of identification information used to identify the company in a country or internationally

string

issuingAuthority
optional

Authority which has issued the identifier (chamber of commerce…)

string

issuingDate
optional

Date at which the identifier was issued

string(date-time)

validFor
optional

The period for which the identification information is valid.

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

organization
optional

OrganizationRef

relationshipType
optional

Type of the relationship. Could be juridical, hierarchical, geographical, functional for example.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

aristocraticTitle
optional

e.g. Baron, Graf, Earl,…

string

familyName
optional

Contains the non-chosen or inherited name. Also known as last name in the Western context

string

familyNamePrefix
optional

Family name prefix

string

formattedName
optional

. A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)

string

fullName
optional

Full name flatten (first, middle, and last names)

string

generation
optional

e.g. Sr, Jr…

string

givenName
optional

First name

string

legalName
optional

Legal name or birth name (name one has for official purposes)

string

middleName
optional

Middle name or initial

string

preferredGivenName
optional

Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname

string

title
optional

Use for titles (aristrocatic, social, …): Pr, Dr, Sir,….

string

validFor
optional

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

name
optional

Organization name (department name for example)

string

nameType
optional

Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh

string

tradingName
optional

The name that the organization trades under

string

validFor
optional

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

creditAgencyName
optional

Name of the credit agency giving the score

string

creditAgencyType
optional

Type of the credit agency giving the score

string

ratingReference
optional

Reference corresponding to the credit rating

string

ratingScore
optional

A measure of a party’s creditworthiness calculated on the basis of a combination of factors such as their income and credit history

integer(int32)

validFor
optional

TimePeriod

amount
optional

Numeric value in a given unit

number(float)

units
optional

Unit

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
required

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

role
optional

Role played by the related party

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

comment
optional

A free text comment linked to the evaluation done

string

evaluatedLevel
optional

Level of expertise in a skill evaluated for an individual

string

skillCode
optional

Code of the skill

string

skillName
optional

Name of the skill such as Java language,…

string

validFor
optional

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

id
optional

Unique identifier of the tax.

string

name
optional

Tax name.

string

taxType
optional

Type of the tax.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

attachment
optional

AttachmentRefOrValue

id
optional

Unique identifier of the certificate of the tax exemption

string

taxDefinition
optional

< TaxDefinition > array

validFor
optional

TimePeriod

endDateTime
optional

End of the time period, using IETC-RFC-3339 format

string(date-time)

startDateTime
optional

Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end

string(date-time)