TM Forum Customer API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
5 operations
across 2 paths,
and defines 116 schemas.
It is described by OpenAPI 3.2.0, at version 5.0.1.
Requests are made against a single base URL, {apiRoot}/tmf-api/customer/v5/.
The identity and technical contract details declared by the specification.
AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyRoleSpecificationRef_FVO
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
CharacteristicRelationship_MVO
IndividualIdentification_MVO
Customer_FVO
object
1 required
PartyRef_FVO
object
A Party reference
IndividualStateType
string
Valid values for the lifecycle state of the individual
OrganizationRef_MVO
object
OrganizationChildRelationship
OrganizationChildRelationship_MVO
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
Extensible_MVO
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
AccountRef_FVO
object
Account reference. A account may be a party account or a financial account.
AgreementRef_FVO
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties
1 required
OrganizationStateType
string
Valid values for the lifecycle state of the organization
IndividualIdentification_FVO
PartyRoleSpecificationRef
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
OtherNameOrganization_MVO
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties
2 required
CharacteristicRelationship
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
RelatedPartyOrPartyRole_MVO
BusinessPartner_FVO
object
When business partner is the BusinessPartner
BusinessPartner_MVO
object
When business partner is the BusinessPartner
PartyRef
object
A Party reference
PaymentMethodRef_FVO
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
RelatedPartyOrPartyRole_FVO
OrganizationChildRelationship_FVO
OrganizationIdentification
Skill
object
Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level…
5 properties
Disability
object
Lack or inadequate strength or ability.
3 properties
OtherNameIndividual
object
Keeps track of other names, for example the old name of a woman before marriage or an artist name.
12 properties
TaxExemptionCertificate_MVO
OrganizationParentRelationship_MVO
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
PartyOrPartyRole_FVO
object
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
PartyOrPartyRole_MVO
object
OrganizationIdentification_FVO
BusinessPartner
object
When business partner is the BusinessPartner
Addressable
object
Base schema for addressable entities
2 properties
Supplier
object
When business partner is the Supplier
TaxExemptionCertificate_FVO
OrganizationParentRelationship
OrganizationRef_FVO
object
CharacteristicRelationship_FVO
OrganizationIdentification_MVO
Supplier_MVO
object
When business partner is the Supplier
AccountRef
object
Account reference. A account may be a party account or a financial account.
PaymentMethodRef_MVO
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
Quantity
object
An amount in a given unit
2 properties
AgreementRef_MVO
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
AccountRef_MVO
object
Account reference. A account may be a party account or a financial account.
OrganizationParentRelationship_FVO
Supplier_FVO
object
When business partner is the Supplier
LanguageAbility
object
Ability of an individual to understand or converse in a language.
8 properties
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyRoleSpecificationRef_MVO
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
AttachmentRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyRef_MVO
object
A Party reference
The full machine-readable OpenAPI contract behind this narrative.
Other APIs TM Forum publishes across the network.
