billingaccounttmfwebservices API

basic

extended

@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

amount
required

Balance amount

Money

balanceType
required

Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance…

string

validFor
required

Balance validity period

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

description
optional

Detailed description of the account

string

href
optional

Reference of the account

string

id
required

Unique identifier of the account

string

name
optional

Name of the account

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

account
optional

AccountRef

relationshipType
required

Type of relationship

string

validFor
required

Validity period of that relationship

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

certificateNumber
optional

Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction

string

issuingJurisdiction
required

Name of the taxing jurisdiction for which taxes are exempt

string

reason
optional

Reason of the tax exemption

string

validFor
required

Period for which the exemption is valid

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

description
optional

An explanatory text for this bill format

string

href
optional

Reference of the bill format

string

id
optional

Unique identifier of the bill format

string

isRef
required

boolean

name
required

A short descriptive name

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

description
optional

An explanatory text describing this bill presentation media

string

href
optional

Reference of the bill presentation media

string

id
optional

Unique identifier of the bill presentation media

string

isRef
required

boolean

name
required

A short descriptive 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

cycleSpecification
optional

BillingCycleSpecificationRefOrValue

format
optional

BillFormatRefOrValue

presentationMedia
optional

< BillPresentationMediaRefOrValue > array

@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

accountBalance
optional

< AccountBalance > array

accountRelationship
optional

< AccountRelationship > array

accountType
optional

A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.

string

billStructure
optional

BillStructure

contact
optional

< Contact > array

creditLimit
optional

The maximum amount of money that may be charged on an account

Money

defaultPaymentMethod
optional

PaymentMethodRef

description
optional

Detailed description of the party account

string

financialAccount
optional

FinancialAccountRef

href
optional

Unique reference of the account

string

id
optional

Unique identifier of the account

string

lastModified
optional

Date of last modification of the account

string(date-time)

name
required

Name of the account

string

paymentPlan
optional

< PaymentPlan > array

paymentStatus
optional

The condition of the account, such as due, paid, in arrears.

string

ratingType
optional

Indicates whether the account follows a specific payment option such as prepaid or postpaid.

string

relatedParty
optional

< RelatedParty > array

state
optional

Contains the lifecycle state such as: Active, Closed, Suspended and so on.

string

taxExemption
optional

< AccountTaxExemption > array

correlationId
optional

The correlation id for this event.

string

description
optional

An explnatory of the event.

string

domain
optional

The domain of the event.

string

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

fieldPath
optional

The path identifying the object field concerned by this notification.

string

payload
optional

The event payload linked to the involved resource object

BillingAccountAttributeValueChangeEventPayload

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

billingAccount
optional

The involved resource data for the event

BillingAccount

correlationId
optional

The correlation id for this event.

string

description
optional

An explnatory of the event.

string

domain
optional

The domain of the event.

string

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the ProcessFlow

string

id
optional

Identifier of the Process flow

string

payload
optional

The event payload linked to the involved resource object

BillingAccountStateChangeEventPayload

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

billingAccount
optional

The involved resource data for the event

BillingAccount

@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

billingDateShift
optional

An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.

integer(int32)

billingPeriod
optional

A billing time period. It can be recurring, for example: week, month, quarter of year, year .

string

chargeDateOffset
optional

An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.

integer(int32)

creditDateOffset
optional

An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.

integer(int32)

dateShift
optional

An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.

integer(int32)

description
optional

An explanation regarding this billing cycle specification

string

frequency
optional

Frequency of the billing cycle (monthly for instance)

string

href
optional

Reference of the billing cycle specification

string

id
optional

Unique identifier of the billing cycle specification

string

isRef
required

boolean

mailingDateOffset
optional

An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.

integer(int32)

name
required

A short descriptive name

string

paymentDueDateOffset
optional

An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.

integer(int32)

validFor
optional

The period for which the billing specification cycle 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

contactMedium
optional

< ContactMedium > array

contactName
optional

A displayable name for that contact

string

contactType
required

Type of contact (primary, secondary…)

string

partyRoleType
optional

Identifies what kind of party role type is linked to the contact (a account manager…)

string

relatedParty
optional

RelatedParty

validFor
required

Validity period of that contact

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

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

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
optional

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

callback
required

The callback being registered.

string

id
required

Id of the listener

string

query
optional

additional data to be passed

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

accountBalance
optional

AccountBalance

href
optional

Unique reference of the account

string

id
required

Unique identifier of the account

string

name
optional

Name of the account

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

unit
optional

Currency (ISO4217 norm uses 3 letters to define the currency)

string

value
optional

A positive floating point number

number(float)

@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 payment mean

string

id
required

Unique identifier of the payment mean

string

name
optional

Name of the payment mean

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

numberOfPayments
optional

Number of payments used to spread the global payment

integer(int32)

paymentFrequency
optional

Frequency of the payments, such as monthly and bimonthly

string

paymentMethod
optional

PaymentMethodRef

planType
optional

Type of payment plan

string

priority
optional

Priority of the payment plan

integer(int32)

status
optional

Status of the payment plan (effective, ineffective)

string

totalAmount
optional

Amount paid

Money

validFor
optional

Validity period of the payment plan

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

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

body
optional

object

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer(int32)

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)