1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Account Management
  4. Billing Account

Get a Billing Account by ID

get

/billingAccount/{id}

The operation retrieves a Billing Account entity. The attribute selection is enabled for all first level attributes.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

The operation was successful.
Body ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : BillingAccount
Match All
The party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of Party Account entity.
Show Source
Nested Schema : BillingAccountOracle
Match All
A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
Show Source
  • Entity
    The Base entity schema for use in TMForum Open-APIs Property.
  • BillingAccountOracle-allOf[1]
    A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
Nested Schema : PartyAccount
Match All
The account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.
Show Source
Nested Schema : Account
Match All
The generic account structure defines common elements for account types, including PartyAccount and other accounts supported by the API.
Show Source
  • Entity
    The Base entity schema for use in TMForum Open-APIs Property.
  • Account-allOf[1]
    The generic account structure defines common elements for account types, including PartyAccount and other accounts supported by the API.
Nested Schema : Entity
Type: object
The Base entity schema for use in TMForum Open-APIs Property.
Match All
The Base entity schema for use in TMForum Open-APIs Property.
The Base entity schema for use in TMForum Open-APIs Property.
Show Source
  • Extensible
    The 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
  • Addressable
    The base schema for adressable entities.
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Addressable
Type: object
The base schema for adressable entities.
Show Source
Nested Schema : Account-allOf[1]
Type: object
The generic account structure defines common elements for account types, including PartyAccount and other accounts supported by the API.
Show Source
Nested Schema : PartyAccount-allOf[1]
Type: object
The account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.
Show Source
Nested Schema : BillingAccount-allOf[1]
Type: object
The party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of Party Account entity.
Show Source
  • The indication for whether the account follows a specific payment option such as prepaid or postpaid.
Nested Schema : accountBalance
Type: array
The list of balances for the account, such as regular postpaid balance, deposit balance, or write-off balance.
Show Source
Nested Schema : accountRelationship
Type: array
A list of balances related to the account. For example, a list of billing accounts that contribute to a financial account.
Show Source
Nested Schema : contact
Type: array
The list of people who could be contacted regarding the account, such as the accountant who authorizes payments.
Show Source
Nested Schema : Money
Type: object
The base / value business entity used to represent money.
Show Source
  • The currency (ISO4217 norm uses 3 letters to define the currency).
  • The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type
Nested Schema : relatedParty
Type: array
The list of parties that have some relationship with the account, such as the customer to whom the account belongs.
Show Source
Nested Schema : taxExemption
Type: array
The list of tax exemptions that can be applied when calculating charges levied to the account.
Show Source
Nested Schema : AccountBalance
Match All
The balances linked to the account.
Show Source
  • Extensible
    The 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
  • AccountBalance-allOf[1]
    The balances linked to the account.
Nested Schema : AccountBalance-allOf[1]
Type: object
The balances linked to the account.
Show Source
Nested Schema : TimePeriod
Type: object
The period of time, as a deadline (endDateTime only), a startDateTime only, or both.
Show Source
Nested Schema : AccountRelationship
Match All
The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.
Show Source
  • Extensible
    The 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
  • AccountRelationship-allOf[1]
    The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.
Nested Schema : AccountRelationship-allOf[1]
Type: object
The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.
Show Source
Nested Schema : AccountRef
Type: object
The account reference. An account may be a party account or a financial account.
Match All
The account reference. An account may be a party account or a financial account.
Show Source
Nested Schema : EntityRef
Match All
The entity reference schema to be used for all entityRef class.
Show Source
  • Extensible
    The 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
  • Addressable
    The base schema for adressable entities.
  • EntityRef-allOf[2]
    The entity reference schema to be used for all entityRef class.
Nested Schema : EntityRef-allOf[2]
Type: object
The entity reference schema to be used for all entityRef class.
Show Source
Nested Schema : Contact
Match All
The individual or organization used as a contact point for a given account and accessed via some contact medium.
Show Source
  • Extensible
    The 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
  • Contact-allOf[1]
    The individual or organization used as a contact point for a given account and accessed via some contact medium.
Nested Schema : Contact-allOf[1]
Type: object
The individual or organization used as a contact point for a given account and accessed via some contact medium.
Show Source
Nested Schema : contactMedium
Type: array
The list of contact mediums for the contact, such as mobile phone number and email addresses.
Show Source
Nested Schema : ContactMedium
Match All
The contact medium that could be used to contact the party.
Show Source
  • Extensible
    The 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
  • ContactMedium-allOf[1]
    The contact medium that could be used to contact the party.
Nested Schema : ContactMedium-allOf[1]
Type: object
The contact medium that could be used to contact the party.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef
Match All
The RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
Show Source
  • Extensible
    The 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
  • RelatedPartyRefOrPartyRoleRef-allOf[1]
    The RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
Nested Schema : RelatedPartyRefOrPartyRoleRef-allOf[1]
Type: object
The RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } }
    The reference allows either a party or a party role to be specified.
  • The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The reference allows either a party or a party role to be specified.
Match One Schema
Show Source
Nested Schema : PartyRef
Type: object
A party reference.
Match All
A party reference.
Show Source
Nested Schema : PartyRoleRef
Match All
The Party Role reference. A party role represents the part played by a party in a given context.
Show Source
Nested Schema : PartyRoleRef-allOf[1]
Type: object
The Party Role reference. A party role represents the part played by a party in a given context.
Show Source
  • The identifier of the engaged party that is linked to the PartyRole object.
  • The name of the engaged party that is linked to the PartyRole object.
Nested Schema : TaxExemptionCertificate
Match All
The tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Show Source
  • Extensible
    The 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
  • TaxExemptionCertificate-allOf[1]
    The tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Nested Schema : TaxExemptionCertificate-allOf[1]
Type: object
The tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment", "AttachmentRef":"#/components/schemas/AttachmentRef" } }
    The polymorphic attributes @type, @schemaLocation, and @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself.
  • The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction.
  • The identifier of the tax exemption within list of the exemptions.
  • The name of the jurisdiction that issued the exemption.
    Example: USA
  • The reason for the tax exemption.
  • taxDefinition
    The list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%).
  • TimePeriod
    The period of time, as a deadline (endDateTime only), a startDateTime only, or both.
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The polymorphic attributes @type, @schemaLocation, and @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself.
Match One Schema
Show Source
Nested Schema : taxDefinition
Type: array
The list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%).
Show Source
Nested Schema : Attachment
Match All
The complementary description of an element (for instance a product) through video, pictures, etc.
Show Source
Nested Schema : AttachmentRef
Match All
The attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures.
Show Source
Nested Schema : Attachment-allOf[1]
Type: object
The complementary description of an element (for instance a product) through video, pictures, etc.
Show Source
Nested Schema : Quantity
Type: object
The amount in a given unit.
Show Source
Nested Schema : AttachmentRef-allOf[1]
Type: object
The attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures.
Show Source
Nested Schema : TaxDefinition
Match All
The reference of a tax definition. A tax is levied by an authorized tax jurisdiction. For example, there are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California, City Tax levied by the City of Los Angeles, etc.).
Show Source
  • Extensible
    The 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
  • TaxDefinition-allOf[1]
    The reference of a tax definition. A tax is levied by an authorized tax jurisdiction. For example, there are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California, City Tax levied by the City of Los Angeles, etc.).
Nested Schema : TaxDefinition-allOf[1]
Type: object
The reference of a tax definition. A tax is levied by an authorized tax jurisdiction. For example, there are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California, City Tax levied by the City of Los Angeles, etc.).
Show Source
Nested Schema : BillStructure
Match All
The structure of the bill for party accounts (billing or settlement).
Show Source
  • Extensible
    The 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
  • BillStructure-allOf[1]
    The structure of the bill for party accounts (billing or settlement).
Nested Schema : BillStructure-allOf[1]
Type: object
The structure of the bill for party accounts (billing or settlement).
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef" } }
    The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat", "BillFormatRef":"#/components/schemas/BillFormatRef" } }
    The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillFormat entity and not the BillFormatRefOrValue class itself
  • presentationMedia
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself
Match One Schema
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillFormat entity and not the BillFormatRefOrValue class itself
Match One Schema
Show Source
Nested Schema : presentationMedia
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef" } }
    The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillPresentationMedia entity and not the BillPresentationMediaRefOrValue class itself
Nested Schema : BillingCycleSpecification
Match All
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : BillingCycleSpecificationRef
Type: object
BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Match All
BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : BillingCycleSpecification-allOf[1]
Type: object
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : BillFormat
Match All
The detailed description of the way in which a bill is presented.
Show Source
Nested Schema : BillFormatRef
Type: object
The BillFormat reference. A bill format is a description of the way in which a bill is presented.
Match All
The BillFormat reference. A bill format is a description of the way in which a bill is presented.
Show Source
Nested Schema : BillFormat-allOf[1]
Type: object
The detailed description of the way in which a bill is presented.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillPresentationMedia entity and not the BillPresentationMediaRefOrValue class itself
Match One Schema
Show Source
Nested Schema : BillPresentationMedia
Match All
The mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
Show Source
Nested Schema : BillPresentationMediaRef
Type: object
The PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
Match All
The PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
Show Source
Nested Schema : BillPresentationMedia-allOf[1]
Type: object
The mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
Show Source
Nested Schema : BillingAccountOracle-allOf[1]
Type: object
A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
Show Source
Nested Schema : accountRelationship
Type: array
The list of balances related to the account. For example, a list of billing accounts that contribute to a financial account.
Show Source
Nested Schema : BillStructureOracle
Match All
The structure of the bill for party accounts (billing or settlement).
Show Source
  • Extensible
    The 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
  • BillStructureOracle-allOf[1]
    The structure of the bill for party accounts (billing or settlement).
Nested Schema : contact
Type: array
The list of people who could be contacted regarding the account, such as the accountant who authorizes payments.
Show Source
Nested Schema : relatedParty
Type: array
The list of parties that have some relationship with the account, such as the customer to whom the account belongs.
Show Source
Nested Schema : ServiceBillStructureOracle
Type: array
Array of Bill Structures
Show Source
Nested Schema : taxExemption
Type: array
The list of tax exemptions that can be applied when calculating charges levied to the account.
Show Source
Nested Schema : AccountRelationshipOracle
Match All
The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.
Show Source
Nested Schema : AccountRelationshipOracle-allOf[1]
Type: object
The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.
Show Source
Nested Schema : account
Type: object
The account reference. An account may be a party account or a financial account.
Show Source
Nested Schema : billStructure
Type: object
The bill structure object.
Show Source
Nested Schema : billStructure
Type: object
The bill structure object of the account.
Show Source
Nested Schema : BillStructureOracle-allOf[1]
Type: object
The structure of the bill for party accounts (billing or settlement).
Show Source
Nested Schema : balanceGroup
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself
Match One Schema
Show Source
Nested Schema : presentationMedia
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef" } }
    The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillPresentationMedia entity and not the BillPresentationMediaRefOrValue class itself
Nested Schema : items
Type: object
Show Source
Nested Schema : limit
Type: array
Show Source
Nested Schema : services
Type: array
Show Source
Nested Schema : tempLimit
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • The service id associated with the balance group
Nested Schema : items
Type: object
Show Source
Nested Schema : validFromDuration
Type: object
Show Source
Nested Schema : validToDuration
Type: object
Show Source
Nested Schema : BillingCycleSpecificationOracle
Match All
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : BillingCycleSpecificationOracle-allOf[1]
Type: object
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
  • 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.
  • An explanation regarding this billing cycle specification
  • Allowed Values: [ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ]
    The frequency of the billing cycle: monthly, bi-monthly, quarterly, semiyearly, or yearly.
  • A short descriptive name
  • An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
Nested Schema : ContactOracle
Match All
A list of individuals or organizations used as contact points for a given account, each accessed via some contact medium.
Show Source
  • ContactOracle-allOf[0]
    A list of individuals or organizations used as contact points for a given account, each accessed via some contact medium.
Nested Schema : ContactOracle-allOf[0]
Type: object
A list of individuals or organizations used as contact points for a given account, each accessed via some contact medium.
Show Source
Nested Schema : contactMedium
Type: array
Show Source
Nested Schema : ContactMediumOracle
Match All
The contact medium that could be used to contact the party.
Show Source
Nested Schema : ContactMediumOracle-allOf[0]
Type: object
The contact medium that could be used to contact the party.
Show Source
  • Associated company name.
  • Geographic code for the address.
  • Allowed Values: [ "PostalAddress", "Phone", "Email", "Fax" ]
    The type of contact medium: PostalAddress, Phone, Email, or Fax.
  • Allowed Values: [ "email", "home", "work", "pager", "portable", "pop", "support" ]
    The phone type classification: email, home, work, pager, portable, pop, or support.
Nested Schema : RelatedPartyOracle
Match All
The relatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
Show Source
  • Extensible
    The 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
  • RelatedPartyOracle-allOf[1]
    The relatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
Nested Schema : RelatedPartyOracle-allOf[1]
Type: object
The relatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } }
    The reference allows either a party or a party role to be specified.
  • The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'
Nested Schema : TaxExemptionCertificateOracle
Match All
A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Show Source
  • TaxExemptionCertificateOracle-allOf[0]
    A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Nested Schema : TaxExemptionCertificateOracle-allOf[0]
Type: object
A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Show Source
Match All
A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.
Show Source
Examples

400 Response

The server received a bad request.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

401 Response

The request was not authorized.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

403 Response

The request was forbidden.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

404 Response

The requested resource cannot be found.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

405 Response

The method is not allowed.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

500 Response

The system has encountered an internal server error.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

501 Response

The request was not implemented.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

503 Response

The service is unavailable.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The 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
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The 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
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to get a billing account with a specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET 'http://host:port/brm/accountManagement/version/billingAccount/0.0.0.1+-account+290470'

Response Body

The following example shows the contents of the response body in JSON format.

{
   "vatCertificate": "",
   "lastUpdate": "2018-01-01T08:00:00.00Z",
   "name": "Full Home Account",
   "@type": "BillingAccount",
   "billStructure": {
      "id": "0.0.0.1+-bill_structure+216649",
      "payType": "invoice",
      "name": "Comprehensive Bill Structure",
      "businessProfileId": "0.0.0.0++0",
      "actgType": "balance_forward",
      "billingSegment": "0",
      "@type": "BillStructure",
      "format": {
         "id": "0.0.0.1+-config-bill_format+171403",
         "href": "https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+171403",
         "name": "Summary Invoice",
         "@type": "BillFormat"
      },
      "acctSuppressed": false,
      "cycleSpecification": {
         "id": "0.0.0.1+-config-bill_cycle_specification+175114",
         "href": "https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+175114",
         "name": "Annual Billing-1",
         "@type": "BillingCycleSpecification",
         "billingDateShift": 3,
         "paymentDueDateOffset": 3,
         "frequency": "yearly"
      },
      "balanceGroup": [
         {
            "id": "0.0.0.1+-balance_group+215753",
            "name": "",
            "isDefault": true,
            "limit": [
               {
                  "unit": "USD",
                  "dynamicCreditFloor": false,
                  "creditFloor": null
               }
            ]
         },
         {
            "id": "0.0.0.1+-balance_group+214729",
            "name": "",
            "limit": [
               {
                  "unit": "CAD",
                  "dynamicCreditFloor": true,
                  "creditFloor": null
               },
               {
                  "unit": "USD",
                  "dynamicCreditFloor": false,
                  "creditFloor": null
               },
               {
                  "unit": "YES",
                  "dynamicCreditFloor": false,
                  "creditFloor": null
               }
            ]
         }
      ],
      "presentationMedia": [
         {
            "id": "0.0.0.1+-config-bill_presentation_media+11150",
            "href": "https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150",
            "name": "Post Mail",
            "@type": "BillPresentationMedia"
         },
         {
            "id": "0.0.0.1+-config-bill_presentation_media+12373",
            "href": "https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373",
            "name": "Electronic",
            "@type": "BillPresentationMedia"
         }
      ]
   },
   "serviceBillStructure": [
      {
         "id": "0.0.0.1+-bill_structure+215881",
         "payType": "invoice",
         "name": "Service Bill Structure 1",
         "businessProfileId": "0.0.0.0++0",
         "actgType": "balance_forward",
         "billingSegment": "0",
         "@type": "BillStructure",
         "format": {
            "id": "0.0.0.1+-config-bill_format+170891",
            "href": "https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+170891",
            "name": "No Invoice",
            "@type": "BillFormat"
         },
         "acctSuppressed": false,
         "cycleSpecification": {
            "id": "0.0.0.1+-config-bill_cycle_specification+169867",
            "href": "https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+169867",
            "name": "",
            "@type": "BillingCycleSpecification",
            "billingDateShift": 4,
            "frequency": "yearly"
         },
         "balanceGroup": [
            {
               "id": "0.0.0.1+-balance_group+216777",
               "name": "",
               "isDefault": true,
               "limit": [
                  {
                     "unit": "USD",
                     "dynamicCreditFloor": false,
                     "creditFloor": null
                  },
                  {
                     "unit": "YES",
                     "dynamicCreditFloor": false,
                     "creditFloor": null
                  }
               ]
            }
         ],
         "presentationMedia": [
            {
               "id": "0.0.0.1+-config-bill_presentation_media+11150",
               "href": "https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150",
               "name": "Post Mail",
               "@type": "BillPresentationMedia"
            }
         ]
      },
      {
         "id": "0.0.0.1+-bill_structure+216265",
         "payType": "invoice",
         "name": "Service Bill Structure 2",
         "businessProfileId": "0.0.0.0++0",
         "actgType": "balance_forward",
         "billingSegment": "0",
         "@type": "BillStructure",
         "format": {
            "id": "0.0.0.1+-config-bill_format+171915",
            "href": "https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+171915",
            "name": "Detailed Invoice",
            "@type": "BillFormat"
         },
         "acctSuppressed": false,
         "cycleSpecification": {
            "id": "0.0.0.1+-config-bill_cycle_specification+169867",
            "href": "https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+169867",
            "name": "",
            "@type": "BillingCycleSpecification",
            "billingDateShift": 4,
            "frequency": "yearly"
         },
         "balanceGroup": [
            {
               "id": "0.0.0.1+-balance_group+213449",
               "name": "",
               "isDefault": true,
               "limit": [
                  {
                     "unit": "USD",
                     "dynamicCreditFloor": false,
                     "creditFloor": null
                  },
                  {
                     "unit": "MIN",
                     "dynamicCreditFloor": false,
                     "creditFloor": null
                  }
               ]
            }
         ],
         "presentationMedia": [
            {
               "id": "0.0.0.1+-config-bill_presentation_media+11150",
               "href": "https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150",
               "name": "Post Mail",
               "@type": "BillPresentationMedia"
            }
         ]
      }
   ],
   "glSegment": "test",
   "description": "This comprehensive billing account includes all possible fields.",
   "accountType": "consumer",
   "state": "active",
   "relatedParty": [
      {
         "partyOrPartyRole": {
            "id": "9948",
            "name": "Related Party Name2",
            "partyName": "",
            "partyId": ""
         },
         "@type": "RelatedPartyRefOrPartyRoleRef",
         "role": "service provider2"
      },
      {
         "partyOrPartyRole": {
            "id": "9947",
            "name": "Related Party Name",
            "partyName": "PartyName101",
            "partyId": "PartyId101"
         },
         "@type": "RelatedPartyRefOrPartyRoleRef",
         "role": "service provider"
      }
   ],
   "id": "0.0.0.1+-account+213897",
   "href": "https://localhost:9998/brm/accountManagement/v5/billingAccount/0.0.0.1+-account+213897",
   "taxExemption": [
      {
         "issuingJurisdiction": "USA",
         "id": "EXEM01",
         "@type": "TaxExemptionCertificate",
         "reason": "NGO",
         "certificateNumber": "1234",
         "validFor": {
            "endDateTime": "2027-08-06T11:30:00.00Z",
            "startDateTime": "2024-07-31T11:30:00.00Z"
         },
         "taxDefinition": [
            {
               "Type": "federal",
               "@type": "TaxDefinition",
               "percent": 5
            },
            {
               "Type": "state",
               "@type": "TaxDefinition",
               "percent": 3
            }
         ]
      },
      {
         "issuingJurisdiction": "USA",
         "id": "EXEM02",
         "@type": "TaxExemptionCertificate",
         "reason": "Embassy",
         "certificateNumber": "6789",
         "validFor": {
            "endDateTime": "2027-08-06T11:30:00.00Z",
            "startDateTime": "2024-07-31T11:30:00.00Z"
         },
         "taxDefinition": [
            {
               "Type": "country",
               "@type": "TaxDefinition",
               "percent": 6
            },
            {
               "Type": "city",
               "@type": "TaxDefinition",
               "percent": 7
            }
         ]
      }
   ],
   "brmAccountType": "standard",
   "currencySecondary": "EUR",
   "accountNum": "0.0.0.1-213897",
   "contact": [
      {
         "contactMedium": [
            {
               "stateOrProvince": "IN",
               "@type": "GeographicAddressContactMedium",
               "mediumType": "PostalAddress",
               "country": "France",
               "city": "France",
               "street1": "Rue des Canards test2 blr",
               "postCode": "75014",
               "company": "IN",
               "geoCode": "IN"
            },
            {
               "@type": "EmailContactMedium",
               "emailAddress": "test@oracle.com",
               "mediumType": "Email"
            },
            {
               "phoneType": "email",
               "@type": "PhoneContactMedium",
               "phoneNumber": "28412",
               "mediumType": "Phone"
            },
            {
               "phoneType": "fax",
               "@type": "FaxContactMedium",
               "faxNumber": "141231112",
               "mediumType": "Fax"
            }
         ],
         "@type": "Contact",
         "contactType": "primary",
         "contactName": "John",
         "salutation": ""
      },
      {
         "contactMedium": [
            {
               "stateOrProvince": "IN",
               "@type": "GeographicAddressContactMedium",
               "mediumType": "PostalAddress",
               "country": "India",
               "city": "BLR",
               "street1": "Rue des Canards test ind",
               "postCode": "75014",
               "company": "IN"
            },
            {
               "@type": "EmailContactMedium",
               "emailAddress": "test@oracle.com",
               "mediumType": "Email"
            },
            {
               "phoneType": "home",
               "@type": "PhoneContactMedium",
               "phoneNumber": "890128412",
               "mediumType": "Phone"
            }
         ],
         "@type": "Contact",
         "contactType": "secondary",
         "contactName": "Rachel Douglas",
         "salutation": "Mr."
      }
   ],
   "customerSegmentList": "Business class Customers",
   "locale": "en_US",
   "currency": "GRD"
}
Back to Top