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

Create a Billing Account

post

/billingAccount

The operation creates a Billing Account entity.

Request

Query Parameters
  • Specifies the comma-separated properties to include in the response.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : BillingAccount_FVO
Match All
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Show Source
Nested Schema : BillingAccountOracle_FVO
Match All
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Show Source
Nested Schema : PartyAccount_FVO
Match All
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : Account_FVO
Match All
Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.
Show Source
Nested Schema : Entity_FVO
Type: object
Represents a base entity schema for TM Forum Open APIs.
Match All
Represents a base entity schema for TM Forum Open APIs.
Represents a base entity schema for TM Forum Open APIs.
Show Source
Nested Schema : Extensible_FVO
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Addressable_FVO
Type: object
Defines a base schema for addressable entities.
Show Source
Nested Schema : Account_FVO-allOf[1]
Type: object
Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.
Show Source
Nested Schema : PartyAccount_FVO-allOf[1]
Type: object
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : BillingAccount_FVO-allOf[1]
Type: object
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Nested Schema : accountRelationship
Type: array
Show Source
Nested Schema : contact
Type: array
Show Source
Nested Schema : Money
Type: object
Represents a monetary amount.
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : taxExemption
Type: array
Show Source
Nested Schema : AccountRelationship_FVO
Match All
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
Nested Schema : AccountRelationship_FVO-allOf[1]
Type: object
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
Nested Schema : AccountRef_FVO
Type: object
Refers to an account. An account may be a party account or a financial account.
Match All
Refers to an account. An account may be a party account or a financial account.
Show Source
Nested Schema : EntityRef_FVO
Match All
Represents an entity reference schema for EntityRef classes.
Show Source
Nested Schema : EntityRef_FVO-allOf[2]
Type: object
Represents an entity reference schema for EntityRef classes.
Show Source
Nested Schema : Contact_FVO
Match All
Represents an individual or organization that serves as an account contact through a contact medium.
Show Source
Nested Schema : Contact_FVO-allOf[1]
Type: object
Represents an individual or organization that serves as an account contact through a contact medium.
Show Source
Nested Schema : contactMedium
Type: array
Show Source
Nested Schema : ContactMedium_FVO
Match All
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : ContactMedium_FVO-allOf[1]
Type: object
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef_FVO
Match All
Refers to a related party or party role linked to a specific entity.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef_FVO-allOf[1]
Type: object
Refers to a related party or party role linked to a specific entity.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Match One Schema
Show Source
Nested Schema : PartyRef_FVO
Type: object
Refers to a party.
Match All
Refers to a party.
Show Source
Nested Schema : PartyRoleRef_FVO
Match All
Refers to a party role. A party role represents the part that a party plays in a context.
Show Source
Nested Schema : PartyRoleRef_FVO-allOf[1]
Type: object
Refers to a party role. A party role represents the part that a party plays in a context.
Show Source
Nested Schema : TaxExemptionCertificate_FVO
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : TaxExemptionCertificate_FVO-allOf[1]
Type: object
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : taxDefinition
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Represents a time period with a start date, an end date, or both.
Show Source
Nested Schema : TaxDefinition_FVO
Match All
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
Nested Schema : TaxDefinition_FVO-allOf[1]
Type: object
Refers to a tax definition. A tax jurisdiction levies the tax.
Nested Schema : BillStructure_FVO
Match All
Represents the bill structure for party accounts, including billing and settlement accounts.
Show Source
Nested Schema : BillStructure_FVO-allOf[1]
Type: object
Represents the bill structure for party accounts, including billing and settlement accounts.
Show Source
Nested Schema : BillingCycleSpecification_FVO
Match All
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The BillFormat entity, not the BillFormatRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Match One Schema
Show Source
Nested Schema : presentationMedia
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia_FVO", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef_FVO" } }
    The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : BillingCycleSpecification_FVO-allOf[1]
Type: object
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : schema
Match All
Represents a detailed description of how a bill is presented.
Show Source
Nested Schema : BillFormatRef_FVO
Type: object
Refers to a bill format. A bill format describes how a bill is presented.
Match All
Refers to a bill format. A bill format describes how a bill is presented.
Show Source
Nested Schema : type
Type: object
Represents a detailed description of how a bill is presented.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Match One Schema
Show Source
  • schema
  • BillPresentationMediaRef_FVO
    Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Nested Schema : schema
Match All
Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Show Source
  • Entity_FVO
    Represents a base entity schema for TM Forum Open APIs.
  • type
    Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Nested Schema : BillPresentationMediaRef_FVO
Type: object
Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Match All
Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Show Source
Nested Schema : type
Type: object
Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Show Source
Nested Schema : BillingAccountOracle_FVO-allOf[0]
Type: object
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Show Source
Nested Schema : accountRelationship
Type: array
Show Source
Nested Schema : BillStructureOracle_FVO
Match All
Represents an extended bill structure for Oracle implementation.
Show Source
Nested Schema : contact
Type: array
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : ServiceBillStructureOracle_FVO
Type: array
Represents an array of bill structures.
Show Source
Nested Schema : taxExemption
Type: array
Show Source
Nested Schema : AccountRelationshipOracle_FVO
Match All
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
Nested Schema : AccountRelationshipOracle_FVO-allOf[1]
Type: object
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
Nested Schema : account
Type: object
Refers to an account. An account may be a party account or a financial account.
Show Source
Nested Schema : billStructure
Type: object
The child account's bill structure.
Show Source
Nested Schema : billStructure
Type: object
The account's bill structure.
Show Source
Nested Schema : BillStructureOracle_FVO-allOf[1]
Type: object
Represents an extended bill structure for Oracle implementation.
Show Source
Nested Schema : balanceGroup
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Match One Schema
Show Source
Nested Schema : presentationMedia
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia_FVO", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef_FVO" } }
    The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : items
Type: object
Show Source
Nested Schema : limit
Type: array
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : tempLimit
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : thresholds
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : validFromDuration
Type: object
Show Source
Nested Schema : validToDuration
Type: object
Show Source
Nested Schema : BillingCycleSpecificationOracle_FVO
Match All
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillingCycleSpecificationRef_FVO
Type: object
Refers to a billing cycle specification. Describes when to initiate a billing cycle and its substeps.
Match All
Refers to a billing cycle specification. Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillingCycleSpecificationOracle_FVO-allOf[1]
Type: object
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : ContactOracle_FVO
Match All
Represents an individual or organization that serves as an account contact through a contact medium.
Show Source
Nested Schema : ContactOracle_FVO-allOf[0]
Type: object
Represents an individual or organization that serves as an account contact through a contact medium.
Show Source
Nested Schema : contactMedium
Type: array
Show Source
Nested Schema : ContactMediumOracle_FVO
Match All
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : ContactMediumOracle_FVO-allOf[0]
Type: object
Indicates the contact medium that can contact the party.
Show Source
  • The associated company name.
  • The geographic address contact medium code.
  • Allowed Values: [ "PostalAddress", "Phone", "Email", "Fax" ]
    The contact medium type.
  • Allowed Values: [ "email", "home", "work", "pager", "portable", "pop", "support" ]
    The phone type classification, for example home work fax.
Nested Schema : TaxExemptionCertificateOracle_FVO
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : TaxExemptionCertificateOracle_FVO-allOf[0]
Type: object
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : taxDefinition
Type: array
Show Source
Nested Schema : TaxDefinitionOracle_FVO
Match All
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
Nested Schema : TaxDefinitionOracle_FVO-allOf[1]
Type: object
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
  • The tax percentage.
  • Allowed Values: [ "federal", "state", "country", "city", "secondary country", "secondary city", "territory", "secondary state", "district", "secondary federal", "country district", "city district", "other" ]
    The tax issuing jurisdiction.
Examples

Back to Top

Response

201 Response

The resource was updated or created.
Body ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : BillingAccount
Match All
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Show Source
Nested Schema : BillingAccountOracle
Match All
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Show Source
Nested Schema : PartyAccount
Match All
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : Account
Match All
Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.
Show Source
  • Entity
    Represents a base entity schema for TM Forum Open APIs.
  • Account-allOf[1]
    Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.
Nested Schema : Entity
Type: object
Represents a base entity schema for TM Forum Open APIs.
Match All
Represents a base entity schema for TM Forum Open APIs.
Represents a base entity schema for TM Forum Open APIs.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Addressable
Type: object
Defines a base schema for addressable entities.
Show Source
Nested Schema : Account-allOf[1]
Type: object
Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.
Show Source
Nested Schema : PartyAccount-allOf[1]
Type: object
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : BillingAccount-allOf[1]
Type: object
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Show Source
Nested Schema : accountBalance
Type: array
Show Source
Nested Schema : accountRelationship
Type: array
Show Source
Nested Schema : contact
Type: array
Show Source
Nested Schema : Money
Type: object
Represents a monetary amount.
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : taxExemption
Type: array
Show Source
Nested Schema : AccountBalance
Match All
Represents balances linked to an account.
Show Source
Nested Schema : AccountBalance-allOf[1]
Type: object
Represents balances linked to an account.
Show Source
Nested Schema : TimePeriod
Type: object
Represents a time period with a start date, an end date, or both.
Show Source
Nested Schema : AccountRelationship
Match All
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
  • Extensible
    Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
  • AccountRelationship-allOf[1]
    Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Nested Schema : AccountRelationship-allOf[1]
Type: object
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
Nested Schema : AccountRef
Type: object
Refers to an account. An account may be a party account or a financial account.
Match All
Refers to an account. An account may be a party account or a financial account.
Show Source
Nested Schema : EntityRef
Match All
Represents an entity reference schema for EntityRef classes.
Show Source
Nested Schema : EntityRef-allOf[2]
Type: object
Represents an entity reference schema for EntityRef classes.
Show Source
Nested Schema : Contact
Match All
Represents an individual or organization that serves as an account contact through a contact medium.
Show Source
  • Extensible
    Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
  • Contact-allOf[1]
    Represents an individual or organization that serves as an account contact through a contact medium.
Nested Schema : Contact-allOf[1]
Type: object
Represents an individual or organization that serves as an account contact through a contact medium.
Show Source
Nested Schema : contactMedium
Type: array
Show Source
Nested Schema : ContactMedium
Match All
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : ContactMedium-allOf[1]
Type: object
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef
Match All
Refers to a related party or party role linked to a specific entity.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef-allOf[1]
Type: object
Refers to a related party or party role linked to a specific entity.
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } }
  • The related party or party role role for the linked entity. Examples initiator customer salesAgent user.
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Match One Schema
Show Source
Nested Schema : PartyRef
Type: object
Refers to a party.
Match All
Refers to a party.
Show Source
Nested Schema : PartyRoleRef
Match All
Refers to a party role. A party role represents the part that a party plays in a context.
Show Source
Nested Schema : PartyRoleRef-allOf[1]
Type: object
Refers to a party role. A party role represents the part that a party plays in a context.
Show Source
Nested Schema : TaxExemptionCertificate
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : TaxExemptionCertificate-allOf[1]
Type: object
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Match One Schema
Show Source
Nested Schema : taxDefinition
Type: array
Show Source
Nested Schema : Attachment
Match All
Represents an attachment that complements an element's description, such as a product description, through videos or pictures.
Show Source
Nested Schema : AttachmentRef
Match All
Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.
Show Source
Nested Schema : Attachment-allOf[1]
Type: object
Represents an attachment that complements an element's description, such as a product description, through videos or pictures.
Show Source
Nested Schema : Quantity
Type: object
Represents an amount in a specified unit.
Show Source
Nested Schema : AttachmentRef-allOf[1]
Type: object
Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.
Show Source
Nested Schema : TaxDefinition
Match All
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
Nested Schema : TaxDefinition-allOf[1]
Type: object
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
Nested Schema : billStructure
Type: object
Match All
Show Source
Nested Schema : BillStructure
Match All
Represents the bill structure for party accounts, including billing and settlement accounts.
Show Source
Nested Schema : BillStructure-allOf[1]
Type: object
Represents the bill structure for party accounts, including billing and settlement accounts.
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef" } }
    The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat", "BillFormatRef":"#/components/schemas/BillFormatRef" } }
    The BillFormat entity, not the BillFormatRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
  • presentationMedia
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Match One Schema
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The BillFormat entity, not the BillFormatRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
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 BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : BillingCycleSpecification
Match All
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillingCycleSpecificationRef
Type: object
Refers to a billing cycle specification. Describes when to initiate a billing cycle and its substeps.
Match All
Refers to a billing cycle specification. Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillingCycleSpecification-allOf[1]
Type: object
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillFormat
Match All
Represents a detailed description of how a bill is presented.
Show Source
Nested Schema : BillFormatRef
Type: object
Refers to a bill format. A bill format describes how a bill is presented.
Match All
Refers to a bill format. A bill format describes how a bill is presented.
Show Source
Nested Schema : BillFormat-allOf[1]
Type: object
Represents a detailed description of how a bill is presented.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Match One Schema
Show Source
Nested Schema : BillPresentationMedia
Match All
Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Show Source
Nested Schema : BillPresentationMediaRef
Type: object
Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Match All
Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Show Source
Nested Schema : BillPresentationMedia-allOf[1]
Type: object
Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.
Show Source
Nested Schema : BillingAccountOracle-allOf[1]
Type: object
Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Show Source
Nested Schema : accountBalance
Type: array
Show Source
Nested Schema : accountRelationship
Type: array
Show Source
Nested Schema : billStructure
Type: object
Match All
Show Source
Nested Schema : contact
Type: array
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : ServiceBillStructureOracle
Type: array
Represents an array of bill structures.
Show Source
Nested Schema : taxExemption
Type: array
Show Source
Nested Schema : AccountBalanceOracle
Match All
Balances linked to the account
Show Source
Nested Schema : AccountBalanceOracle-allOf[1]
Type: object
Balances linked to the account
Show Source
Nested Schema : AccountRelationshipOracle
Match All
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
Nested Schema : AccountRelationshipOracle-allOf[1]
Type: object
Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.
Show Source
Nested Schema : account
Type: object
Refers to an account. An account may be a party account or a financial account.
Show Source
Nested Schema : billStructure
Type: object
The child account's bill structure.
Show Source
Nested Schema : billStructure
Type: object
The account's bill structure.
Show Source
Nested Schema : BillStructureOracle
Match All
Represents an extended bill structure for Oracle implementation.
Show Source
Nested Schema : BillStructureOracle-allOf[1]
Type: object
Represents an extended bill structure for Oracle implementation.
Show Source
Nested Schema : balanceGroup
Type: array
Show Source
Nested Schema : cycleSpecification
Type: object
Match All
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef" } }
    The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : format
Type: object
Match All
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat", "BillFormatRef":"#/components/schemas/BillFormatRef" } }
    The BillFormat entity, not the BillFormatRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : presentationMedia
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef" } }
    The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : items
Type: object
Show Source
Nested Schema : balances
Type: array
Show Source
Nested Schema : limit
Type: array
Show Source
Nested Schema : rules
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
Nested Schema : thresholds
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "EST", "LST", "EET", "LET", "ESTLET", "ESTEET", "LSTEET", "LSTLET", "EETEST", "EETLST", "LETEST", "LETLST" ]
    The consumption rule.
  • The consumption rule.'s unit.
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : validFromDuration
Type: object
Show Source
Nested Schema : validToDuration
Type: object
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Match One Schema
Show Source
Nested Schema : ContactOracle
Match All
Represents account contacts accessed through contact media.
Show Source
Nested Schema : ContactOracle-allOf[0]
Type: object
Represents account contacts accessed through contact media.
Show Source
Nested Schema : contactMedium
Type: array
Show Source
Nested Schema : ContactMediumOracle
Match All
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : ContactMediumOracle-allOf[0]
Type: object
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : TaxExemptionCertificateOracle
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : TaxExemptionCertificateOracle-allOf[0]
Type: object
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Examples

202 Response

The request was accepted.

400 Response

The server received a bad request.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

401 Response

The request is unauthorized.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

403 Response

The request is forbidden.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

404 Response

The resource is not found.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

405 Response

The method is not allowed.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

409 Response

The request conflicts with the resource state.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

500 Response

The server encountered an internal error.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

501 Response

The server does not implement this operation.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

503 Response

The service is unavailable.
Body ()
Root Schema : Error
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Match All
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.
Show Source
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source
Back to Top

Examples

Note:

For Examples 1 through 6, set externalIdMappingEnabled to true when using external IDs in the request. By default, external ID mapping is disabled.

Example 1: Account-level credit limit

This example shows how to create a billing account with an account-level credit limit by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json'  -d @postBillingAccount1.json

Request Body

The following example shows the contents of the postBillingAccount1.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "name": "Home Account",
  "id": "billing-account-post-001",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "accountType": "consumer",
  "creditLimit": {
    "unit": "YES",
    "value": 1000
  },
  "billStructure": {
    "@type": "BillStructure",
    "id": "billing-account-strucuture-post-001",
    "name": "BI_NAME405",
    "presentationMedia": [
      {
        "name": "Post Mail-1"
      },
      {
        "name": "Electronic-1"
      }
    ],
    "format": {
      "id": "test3",
      "name": "Summary Invoice-test-id"
    },
    "cycleSpecification": {
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "frequency": "yearly",
      "id": "test4",
      "name": "Annual billing-testid",
      "paymentDueDateOffset": 3
    }
  },
  "contact": [
    {
      "contactType": "primary",
      "contactName": "John",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "country": "France",
          "city": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test2 blr",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@oracle.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "28412"
        },
        {
          "@type": "FaxContactMedium",
          "mediumType": "Fax",
          "faxNumber": "141231112"
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "service provider",
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyId": "PartyId101",
        "partyName": "PartyName101"
      }
    },
    {
      "role": "service provider2",
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2"
      }
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "vatCertificate": "vat",
  "name": "Home Account",
  "@type": "BillingAccount",
  "billStructure": {
    "payType": "invoice",
    "name": "BI_NAME405",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "id": "billing-account-strucuture-post-001",
    "@type": "BillStructure",
    "format": {
      "name": "Summary Invoice-test-id",
      "id": "test3",
      "href": "https://localhost:8089/brm/accountManagement/v5/billFormat/test3",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "name": "",
      "id": "test4",
      "href": "https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/test4",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+312700",
        "name": "",
        "isDefault": true,
        "limit": [
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 1000.0
          }
        ]
      }
    ],
    "presentationMedia": [
      {
        "name": "Post Mail-1",
        "id": "0.0.0.1+-config-bill_presentation_media+182304",
        "href": "https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+182304",
        "@type": "BillPresentationMedia"
      },
      {
        "name": "Electronic-1",
        "id": "0.0.0.1+-config-bill_presentation_media+181280",
        "href": "https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+181280",
        "@type": "BillPresentationMedia"
      }
    ]
  },
  "glSegment": ".",
  "description": "This billing account represents the main household billing structure",
  "accountType": "consumer",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2",
        "partyName": "",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "billing-account-post-001",
  "href": "https://localhost:8089/brm/accountManagement/v5/billingAccount/billing-account-post-001",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "accountNum": "billing-account-post-001",
  "contact": [
    {
      "contactMedium": [
        {
          "stateOrProvince": "IN",
          "@type": "GeographicAddressContactMedium",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "France",
          "street1": "Rue des Canards",
          "street2": "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",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "Paris",
          "street1": "Rue des Canards",
          "street2": "test ind",
          "postCode": "75014",
          "company": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "emailAddress": "test@oracle.com",
          "mediumType": "Email"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        }
      ],
      "@type": "Contact",
      "contactType": "secondary",
      "contactName": "Rachel Douglas",
      "salutation": ""
    }
  ],
  "customerSegmentList": "",
  "locale": "en_US",
  "currency": "USD"
}

Example 2: Account and balance group limits for different resources

This example shows how to create a billing account with account and balance group limits for different resources by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json' -d @postBillingAccount2.json

Request Body

The following example shows the contents of the postBillingAccount2.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "name": "Home Account",
  "id": "billing-account-post-002",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "accountType": "consumer",
  "vatCertificate": "vat",
  "creditLimit": {
    "unit": "YES",
    "value": 1000
  },
  "billStructure": {
    "@type": "BillStructure",
    "id": "billing-account-strucuture-post-002",
    "name": "BI_NAME405",
    "presentationMedia": [
      {
        "name": "Post Mail-1"
      },
      {
        "name": "Electronic-1"
      }
    ],
    "format": {
      "id": "test3",
      "name": "Summary Invoice-test-id"
    },
    "cycleSpecification": {
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "frequency": "yearly",
      "id": "test4",
      "name": "Annual billing-testid",
      "paymentDueDateOffset": 3
    },
    "balanceGroup": [
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ],
        "isDefault": true
      },
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 1000
          },
          {
            "unit": "YES",
            "creditLimit": 10000
          },
          {
            "unit": "CAD",
            "creditLimit": 1000,
            "dynamicCreditFloor": false,
            "creditFloor": -500
          }
        ]
      }
    ]
  },
  "contact": [
    {
      "contactType": "secondary",
      "contactName": "Rachel Douglas",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "city": "Paris",
          "country": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test ind",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IND"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@oracle.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "890128412",
          "phoneType": "home"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "890128412",
          "phoneType": "home"
        }
      ]
    },
    {
      "contactType": "primary",
      "contactName": "John",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "country": "France",
          "city": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test2 blr",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@oracle.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "28412"
        },
        {
          "@type": "FaxContactMedium",
          "mediumType": "Fax",
          "faxNumber": "141231112"
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "service provider",
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyId": "PartyId101",
        "partyName": "PartyName101"
      }
    },
    {
      "role": "service provider2",
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2"
      }
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "vatCertificate": "vat",
  "name": "Home Account",
  "@type": "BillingAccount",
  "billStructure": {
    "payType": "invoice",
    "name": "BI_NAME405",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "id": "billing-account-strucuture-post-002",
    "@type": "BillStructure",
    "format": {
      "name": "Summary Invoice-test-id",
      "id": "test3",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/test3",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "name": "",
      "id": "test4",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/test4",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+310562",
        "name": "",
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 10000.0
          },
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 1000.0
          }
        ]
      },
      {
        "id": "0.0.0.1+-balance_group+308002",
        "name": "",
        "limit": [
          {
            "unit": "CAD",
            "dynamicCreditFloor": false,
            "creditFloor": -500.0,
            "creditLimit": 1000.0
          },
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 1000.0
          },
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 10000.0
          }
        ]
      }
    ],
    "presentationMedia": [
      {
        "name": "Post Mail-1",
        "id": "0.0.0.1+-config-bill_presentation_media+182304",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+182304",
        "@type": "BillPresentationMedia"
      },
      {
        "name": "Electronic-1",
        "id": "0.0.0.1+-config-bill_presentation_media+181280",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+181280",
        "@type": "BillPresentationMedia"
      }
    ]
  },
  "glSegment": ".",
  "description": "This billing account represents the main household billing structure",
  "accountType": "consumer",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2",
        "partyName": "",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "billing-account-post-002",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/billing-account-post-002",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "accountNum": "billing-account-post-002",
  "contact": [
    {
      "contactMedium": [
        {
          "stateOrProvince": "IN",
          "@type": "GeographicAddressContactMedium",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "France",
          "street1": "Rue des Canards",
          "street2": "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",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "Paris",
          "street1": "Rue des Canards",
          "street2": "test ind",
          "postCode": "75014",
          "company": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "emailAddress": "test@oracle.com",
          "mediumType": "Email"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        }
      ],
      "@type": "Contact",
      "contactType": "secondary",
      "contactName": "Rachel Douglas",
      "salutation": ""
    }
  ],
  "customerSegmentList": "",
  "locale": "en_US",
  "currency": "USD"
}

Example 3: Account and balance group limits for the same resource

This example shows how to create a billing account with account and balance group limits for the same resource by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json' -d @postBillingAccount3.json

Request Body

The following example shows the contents of the postBillingAccount3.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "name": "Home Account",
  "id": "billing-account-post-003",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "accountType": "consumer",
  "vatCertificate": "vat",
  "creditLimit": {
    "unit": "USD",
    "value": 1000
  },
  "billStructure": {
    "@type": "BillStructure",
    "id": "billing-account-strucuture-post-003",
    "name": "BI_NAME405",
    "presentationMedia": [
      {
        "name": "Post Mail-1"
      },
      {
        "name": "Electronic-1"
      }
    ],
    "format": {
      "id": "test3",
      "name": "Summary Invoice-test-id"
    },
    "cycleSpecification": {
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "frequency": "yearly",
      "id": "test4",
      "name": "Annual billing-testid",
      "paymentDueDateOffset": 3
    },
    "balanceGroup": [
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ],
        "isDefault": true
      },
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 1000
          },
          {
            "unit": "YES",
            "creditLimit": 10000
          },
          {
            "unit": "CAD",
            "creditLimit": 1000,
            "dynamicCreditFloor": false,
            "creditFloor": -500
          }
        ]
      }
    ]
  },
  "contact": [
    {
      "contactType": "secondary",
      "contactName": "Rachel Douglas",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "city": "Paris",
          "country": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test ind",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IND"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@url.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "890128412",
          "phoneType": "home"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "890128412",
          "phoneType": "home"
        }
      ]
    },
    {
      "contactType": "primary",
      "contactName": "John",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "country": "France",
          "city": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test2 blr",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@url.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "28412"
        },
        {
          "@type": "FaxContactMedium",
          "mediumType": "Fax",
          "faxNumber": "141231112"
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "service provider",
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyId": "PartyId101",
        "partyName": "PartyName101"
      }
    },
    {
      "role": "service provider2",
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2"
      }
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "vatCertificate": "vat",
  "name": "Home Account",
  "@type": "BillingAccount",
  "billStructure": {
    "payType": "invoice",
    "name": "BI_NAME405",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "id": "billing-account-strucuture-post-003",
    "@type": "BillStructure",
    "format": {
      "name": "Summary Invoice-test-id",
      "id": "test3",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/test3",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "name": "",
      "id": "test4",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/test4",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+310659",
        "name": "",
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 10000.0
          }
        ]
      },
      {
        "id": "0.0.0.1+-balance_group+308099",
        "name": "",
        "limit": [
          {
            "unit": "CAD",
            "dynamicCreditFloor": false,
            "creditFloor": -500.0,
            "creditLimit": 1000.0
          },
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 1000.0
          },
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 10000.0
          }
        ]
      }
    ],
    "presentationMedia": [
      {
        "name": "Post Mail-1",
        "id": "0.0.0.1+-config-bill_presentation_media+182304",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+182304",
        "@type": "BillPresentationMedia"
      },
      {
        "name": "Electronic-1",
        "id": "0.0.0.1+-config-bill_presentation_media+181280",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+181280",
        "@type": "BillPresentationMedia"
      }
    ]
  },
  "glSegment": ".",
  "description": "This billing account represents the main household billing structure",
  "accountType": "consumer",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2",
        "partyName": "",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "billing-account-post-003",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/billing-account-post-003",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "accountNum": "billing-account-post-003",
  "contact": [
    {
      "contactMedium": [
        {
          "stateOrProvince": "IN",
          "@type": "GeographicAddressContactMedium",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "France",
          "street1": "Rue des Canards",
          "street2": "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",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "Paris",
          "street1": "Rue des Canards",
          "street2": "test ind",
          "postCode": "75014",
          "company": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "emailAddress": "test@oracle.com",
          "mediumType": "Email"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        }
      ],
      "@type": "Contact",
      "contactType": "secondary",
      "contactName": "Rachel Douglas",
      "salutation": ""
    }
  ],
  "customerSegmentList": "",
  "locale": "en_US",
  "currency": "USD"
}

Example 4: Account with a VAT certificate

This example shows how to create a billing account with a VAT certificate by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json' -d @postBillingAccount4.json

Request Body

The following example shows the contents of the postBillingAccount4.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "name": "Home Account",
  "id": "billing-account-post-003",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "accountType": "consumer",
  "vatCertificate": "vat",
  "creditLimit": {
    "unit": "USD",
    "value": 1000
  },
  "billStructure": {
    "@type": "BillStructure",
    "id": "billing-account-strucuture-post-003",
    "name": "BI_NAME405",
    "presentationMedia": [
      {
        "name": "Post Mail-1"
      },
      {
        "name": "Electronic-1"
      }
    ],
    "format": {
      "id": "test3",
      "name": "Summary Invoice-test-id"
    },
    "cycleSpecification": {
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "frequency": "yearly",
      "id": "test4",
      "name": "Annual billing-testid",
      "paymentDueDateOffset": 3
    },
    "balanceGroup": [
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ],
        "isDefault": true
      },
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 1000
          },
          {
            "unit": "YES",
            "creditLimit": 10000
          },
          {
            "unit": "CAD",
            "creditLimit": 1000,
            "dynamicCreditFloor": false,
            "creditFloor": -500
          }
        ]
      }
    ]
  },
  "contact": [
    {
      "contactType": "secondary",
      "contactName": "Rachel Douglas",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "city": "Paris",
          "country": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test ind",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IND"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@oracle.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "890128412",
          "phoneType": "home"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "890128412",
          "phoneType": "home"
        }
      ]
    },
    {
      "contactType": "primary",
      "contactName": "John",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "country": "France",
          "city": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test2 blr",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@oracle.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "28412"
        },
        {
          "@type": "FaxContactMedium",
          "mediumType": "Fax",
          "faxNumber": "141231112"
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "role": "service provider",
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyId": "PartyId101",
        "partyName": "PartyName101"
      }
    },
    {
      "role": "service provider2",
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2"
      }
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "vatCertificate": "vat",
  "name": "Home Account",
  "@type": "BillingAccount",
  "billStructure": {
    "payType": "invoice",
    "name": "BI_NAME405",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "id": "billing-account-strucuture-post-003",
    "@type": "BillStructure",
    "format": {
      "name": "Summary Invoice-test-id",
      "id": "test3",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/test3",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "name": "",
      "id": "test4",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/test4",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+310659",
        "name": "",
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 10000.0
          }
        ]
      },
      {
        "id": "0.0.0.1+-balance_group+308099",
        "name": "",
        "limit": [
          {
            "unit": "CAD",
            "dynamicCreditFloor": false,
            "creditFloor": -500.0,
            "creditLimit": 1000.0
          },
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 1000.0
          },
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": 10000.0
          }
        ]
      }
    ],
    "presentationMedia": [
      {
        "name": "Post Mail-1",
        "id": "0.0.0.1+-config-bill_presentation_media+182304",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+182304",
        "@type": "BillPresentationMedia"
      },
      {
        "name": "Electronic-1",
        "id": "0.0.0.1+-config-bill_presentation_media+181280",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+181280",
        "@type": "BillPresentationMedia"
      }
    ]
  },
  "glSegment": ".",
  "description": "This billing account represents the main household billing structure",
  "accountType": "consumer",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "id": "9947",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "9948",
        "name": "Related Party Name2",
        "partyName": "",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "billing-account-post-003",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/billing-account-post-003",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "accountNum": "billing-account-post-003",
  "contact": [
    {
      "contactMedium": [
        {
          "stateOrProvince": "IN",
          "@type": "GeographicAddressContactMedium",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "France",
          "street1": "Rue des Canards",
          "street2": "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",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "Paris",
          "street1": "Rue des Canards",
          "street2": "test ind",
          "postCode": "75014",
          "company": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "emailAddress": "test@oracle.com",
          "mediumType": "Email"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        },
        {
          "phoneType": "home",
          "@type": "PhoneContactMedium",
          "phoneNumber": "890128412",
          "mediumType": "Phone"
        }
      ],
      "@type": "Contact",
      "contactType": "secondary",
      "contactName": "Rachel Douglas",
      "salutation": ""
    }
  ],
  "customerSegmentList": "",
  "locale": "en_US",
  "currency": "USD"
}

Example 5: Account creation before a product purchase

This example shows how to create a billing account before purchasing a product by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json'-d @postBillingAccount5.json

Request Body

The following example shows the contents of the postBillingAccount5.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "accountType": "consumer",
  "billStructure": {
    "@type": "BillStructure",
    "name": "BI_NAME405",
    "format": {
      "name": "Summary Invoice-098"
    },
    "cycleSpecification": {
      "billingDateShift": 8,
      "paymentDueDateOffset": 3,
      "@type": "BillingCycleSpecification",
      "name": "Annual billing-100",
      "frequency": "yearly"
    },
    "id": "billStruct-id-002",
    "presentationMedia": [
      {
        "name": "Post Mail-098"
      },
      {
        "name": "Electronic-098"
      }
    ]
  },
  "name": "Home Account",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "id": "account-with-temp-limit-test-100-002",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "id": "9947",
        "partyId": "PartyId101"
      },
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "name": "Related Party Name2",
        "id": "9948"
      },
      "role": "service provider2"
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "customerSegmentList": "",
  "accountNum": "account-with-temp-limit-test-100-002",
  "@type": "BillingAccountOracle",
  "billStructure": {
    "@type": "BillStructureOracle",
    "billingSegment": "0",
    "balanceGroup": [
      {
        "isDefault": true,
        "name": "",
        "id": "0.0.0.1+-balance_group+178736"
      }
    ],
    "name": "BI_NAME405",
    "format": {
      "@type": "BillFormat",
      "name": "Summary Invoice-098",
      "id": "0.0.0.1+-config-bill_format+177616",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+177616"
    },
    "cycleSpecification": {
      "billingDateShift": 8,
      "paymentDueDateOffset": 3,
      "@type": "BillingCycleSpecificationOracle",
      "name": "",
      "id": "0.0.0.1+-config-bill_cycle_specification+179664",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+179664",
      "frequency": "yearly"
    },
    "id": "billStruct-id-002",
    "presentationMedia": [
      {
        "@type": "BillPresentationMedia",
        "name": "Post Mail-098",
        "id": "0.0.0.1+-config-bill_presentation_media+176592",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+176592"
      },
      {
        "@type": "BillPresentationMedia",
        "name": "Electronic-098",
        "id": "0.0.0.1+-config-bill_presentation_media+178640",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+178640"
      }
    ],
    "acctSuppressed": false,
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward"
  },
  "accountType": "consumer",
  "brmAccountType": "standard",
  "description": "This billing account represents the main household billing structure",
  "glSegment": ".",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "@type": "PartyRefOrPartyRoleRef",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "id": "9947",
        "partyId": "PartyId101"
      },
      "role": "service provider",
      "@type": "RelatedPartyRefOrPartyRoleRef"
    },
    {
      "partyOrPartyRole": {
        "@type": "PartyRefOrPartyRoleRef",
        "name": "Related Party Name2",
        "partyName": "",
        "id": "9948",
        "partyId": ""
      },
      "role": "service provider2",
      "@type": "RelatedPartyRefOrPartyRoleRef"
    }
  ],
  "locale": "en_US",
  "name": "Home Account",
  "currencySecondary": "",
  "currency": "USD",
  "state": "active",
  "id": "account-with-temp-limit-test-100-002",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/account-with-temp-limit-test-100-002"
}

Example 6: Account with consumption rules

This example shows how to create a billing account with consumption rules by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json' -d @postBillingAccount6.json

Request Body

The following example shows the contents of the postBillingAccount6.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "accountType": "consumer",
  "billStructure": {
    "@type": "BillStructure",
    "balanceGroup": [
      {
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ],
        "rules": [
          {
            "unit": "USD",
            "consumptionRule": "EST"
          },
          {
            "unit": "CAD",
            "consumptionRule": "LST"
          }
        ]
      }
    ],
    "name": "BI_NAME405",
    "format": {
      "name": "Summary Invoice-test-id",
      "id": "test3"
    },
    "cycleSpecification": {
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "@type": "BillingCycleSpecification",
      "name": "Annual billing-testid",
      "id": "test4",
      "frequency": "yearly"
    },
    "id": "billing-account-strucuture-post-rules",
    "presentationMedia": [
      {
        "name": "Post Mail-1"
      },
      {
        "name": "Electronic-1"
      }
    ]
  },
  "contact": [
    {
      "contactMedium": [
        {
          "country": "France",
          "stateOrProvince": "IN",
          "city": "Paris",
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "geoCode": "IND",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "company": "IN",
          "street2": "test ind"
        },
        {
          "emailAddress": "test@oracle.com",
          "@type": "EmailContactMedium",
          "mediumType": "Email"
        },
        {
          "phoneType": "home",
          "phoneNumber": "890128412",
          "@type": "PhoneContactMedium",
          "mediumType": "Phone"
        },
        {
          "phoneType": "home",
          "phoneNumber": "890128412",
          "@type": "PhoneContactMedium",
          "mediumType": "Phone"
        }
      ],
      "contactName": "Rachel Douglas",
      "contactType": "secondary"
    },
    {
      "contactMedium": [
        {
          "country": "France",
          "stateOrProvince": "IN",
          "city": "France",
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "geoCode": "IN",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "company": "IN",
          "street2": "test2 blr"
        },
        {
          "emailAddress": "test@url.com",
          "@type": "EmailContactMedium",
          "mediumType": "Email"
        },
        {
          "phoneNumber": "28412",
          "@type": "PhoneContactMedium",
          "mediumType": "Phone"
        },
        {
          "@type": "FaxContactMedium",
          "mediumType": "Fax",
          "faxNumber": "141231112"
        }
      ],
      "contactName": "John",
      "contactType": "primary"
    }
  ],
  "name": "Home Account",
  "description": "This billing account represents the main household billing structure",
  "id": "billing-account-post-rules",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "id": "9947",
        "partyId": "PartyId101"
      },
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "name": "Related Party Name2",
        "id": "9948"
      },
      "role": "service provider2"
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "customerSegmentList": "",
  "accountNum": "billing-account-post-rules",
  "@type": "BillingAccountOracle",
  "billStructure": {
    "@type": "BillStructureOracle",
    "billingSegment": "0",
    "balanceGroup": [
      {
        "isDefault": true,
        "name": "",
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000,
            "creditFloor": null,
            "dynamicCreditFloor": false
          },
          {
            "unit": "CAD",
            "creditFloor": null,
            "dynamicCreditFloor": false
          }
        ],
        "rules": [
          {
            "unit": "USD",
            "consumptionRule": "EST"
          },
          {
            "unit": "CAD",
            "consumptionRule": "LST"
          }
        ],
        "id": "0.0.0.1+-balance_group+181104"
      }
    ],
    "name": "BI_NAME405",
    "format": {
      "@type": "BillFormat",
      "name": "Summary Invoice-test-id",
      "id": "test3",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/test3"
    },
    "cycleSpecification": {
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "@type": "BillingCycleSpecificationOracle",
      "name": "",
      "id": "test4",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/test4",
      "frequency": "yearly"
    },
    "id": "billing-account-strucuture-post-rules",
    "presentationMedia": [
      {
        "@type": "BillPresentationMedia",
        "name": "Post Mail-1",
        "id": "0.0.0.1+-config-bill_presentation_media+176816",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+176816"
      },
      {
        "@type": "BillPresentationMedia",
        "name": "Electronic-1",
        "id": "0.0.0.1+-config-bill_presentation_media+178864",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+178864"
      }
    ],
    "acctSuppressed": false,
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward"
  },
  "accountType": "consumer",
  "brmAccountType": "standard",
  "description": "This billing account represents the main household billing structure",
  "glSegment": ".",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "@type": "PartyRefOrPartyRoleRef",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "id": "9947",
        "partyId": "PartyId101"
      },
      "role": "service provider",
      "@type": "RelatedPartyRefOrPartyRoleRef"
    },
    {
      "partyOrPartyRole": {
        "@type": "PartyRefOrPartyRoleRef",
        "name": "Related Party Name2",
        "partyName": "",
        "id": "9948",
        "partyId": ""
      },
      "role": "service provider2",
      "@type": "RelatedPartyRefOrPartyRoleRef"
    }
  ],
  "locale": "en_US",
  "contact": [
    {
      "contactMedium": [
        {
          "country": "France",
          "stateOrProvince": "IN",
          "city": "France",
          "@type": "GeographicAddressContactMediumOracle",
          "mediumType": "PostalAddress",
          "geoCode": "IN",
          "street1": "Rue des Canards",
          "postCode": "75014",
          "company": "IN",
          "street2": "test2 blr"
        },
        {
          "emailAddress": "test@url.com",
          "@type": "EmailContactMedium",
          "mediumType": "Email"
        },
        {
          "phoneType": null,
          "phoneNumber": "28412",
          "@type": "PhoneContactMediumOracle",
          "mediumType": "Phone"
        },
        {
          "phoneType": "fax",
          "@type": "FaxContactMedium",
          "mediumType": "Fax",
          "faxNumber": "141231112"
        }
      ],
      "@type": "ContactOracle",
      "contactName": "John",
      "contactType": "primary",
      "salutation": ""
    },
    {
      "contactMedium": [
        {
          "country": "France",
          "stateOrProvince": "IN",
          "city": "Paris",
          "@type": "GeographicAddressContactMediumOracle",
          "mediumType": "PostalAddress",
          "street1": "Rue des Canards",
          "postCode": "75014",
          "company": "IN",
          "street2": "test ind"
        },
        {
          "emailAddress": "test@url.com",
          "@type": "EmailContactMedium",
          "mediumType": "Email"
        },
        {
          "phoneType": "home",
          "phoneNumber": "890128412",
          "@type": "PhoneContactMediumOracle",
          "mediumType": "Phone"
        },
        {
          "phoneType": "home",
          "phoneNumber": "890128412",
          "@type": "PhoneContactMediumOracle",
          "mediumType": "Phone"
        }
      ],
      "@type": "ContactOracle",
      "contactName": "Rachel Douglas",
      "contactType": "secondary",
      "salutation": ""
    }
  ],
  "name": "Home Account",
  "creditLimit": {
    "unit": "USD",
    "value": 10000
  },
  "currencySecondary": "",
  "currency": "USD",
  "state": "active",
  "id": "billing-account-post-rules",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/billing-account-post-rules"
}

Example 7: Create an account without an account ID

This example shows how to create a billing account without supplying an account ID by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json' -d @postBillingAccount7.json

Request Body

The following example shows the contents of the postBillingAccount7.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "accountType": "consumer",
  "billStructure": {
    "@type": "BillStructure",
    "balanceGroup": [
      {
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ]
      },
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 1000
          },
          {
            "unit": "YES",
            "creditLimit": 10000
          },
          {
            "unit": "CAD",
            "creditLimit": 1000,
            "creditFloor": -500,
            "dynamicCreditFloor": false
          }
        ]
      }
    ],
    "name": "Billing Account",
    "format": {
      "name": "Summary Invoice OOTB"
    },
    "cycleSpecification": {
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "@type": "BillingCycleSpecification",
      "name": "Annual billing OOTB",
      "frequency": "yearly"
    },
    "presentationMedia": [
      {
        "name": "Post Mail OOTB"
      },
      {
        "name": "Electronic OOTB"
      }
    ]
  },
  "name": "Home Account New Configs",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "partyId": "PartyId101"
      },
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "name": "Related Party Name2"
      },
      "role": "service provider2"
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "vatCertificate": "",
  "name": "Home Account New Configs",
  "@type": "BillingAccount",
  "billStructure": {
    "id": "0.0.0.1+-bill_structure+246660",
    "name": "Billing Account",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "@type": "BillStructure",
    "format": {
      "id": "0.0.0.1+-config-bill_format+248964",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+248964",
      "name": "Summary Invoice OOTB",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "id": "0.0.0.1+-config-bill_cycle_specification+246404",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+246404",
      "name": "Annual billing OOTB",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+247684",
        "name": "",
        "rules": [
          {
            "unit": "USD",
            "consumptionRule": null
          }
        ],
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 10000.0
          }
        ]
      },
      {
        "id": "0.0.0.1+-balance_group+249732",
        "name": "",
        "rules": [
          {
            "unit": "CAD",
            "consumptionRule": null
          },
          {
            "unit": "USD",
            "consumptionRule": null
          },
          {
            "unit": "YES",
            "consumptionRule": null
          }
        ],
        "limit": [
          {
            "unit": "CAD",
            "dynamicCreditFloor": false,
            "creditFloor": -500.0,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 1000.0
          },
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 1000.0
          },
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 10000.0
          }
        ]
      }
    ],
    "presentationMedia": [
      {
        "id": "0.0.0.1+-config-bill_presentation_media+247940",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+247940",
        "name": "Post Mail OOTB",
        "@type": "BillPresentationMedia"
      },
      {
        "id": "0.0.0.1+-config-bill_presentation_media+246916",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+246916",
        "name": "Electronic OOTB",
        "@type": "BillPresentationMedia"
      }
    ]
  },
  "glSegment": ".",
  "description": "This billing account represents the main household billing structure",
  "accountType": "consumer",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "id": "0.0.0.1+-profile-related_party+248900",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "0.0.0.1+-profile-related_party+246340",
        "name": "Related Party Name2",
        "partyName": "",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "0.0.0.1+-account+248452",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/0.0.0.1+-account+248452",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "accountNum": "0.0.0.1-248452",
  "customerSegmentList": "",
  "locale": "en_US",
  "creditLimit": {
    "unit": "USD",
    "value": 10000.0
  },
  "currency": "USD"
}

Example 8: Create an account without a bill structure ID

This example shows how to create a billing account without supplying a bill structure ID by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json' -d @postBillingAccount8.json

Request Body

The following example shows the contents of the postBillingAccount8.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "accountType": "consumer",
  "billStructure": {
    "@type": "BillStructure",
    "balanceGroup": [
      {
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ]
      },
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 1000
          },
          {
            "unit": "YES",
            "creditLimit": 10000
          },
          {
            "unit": "CAD",
            "creditLimit": 1000,
            "creditFloor": -500,
            "dynamicCreditFloor": false
          }
        ]
      }
    ],
    "name": "Billing Account",
    "format": {
      "name": "Summary Invoice OOTB"
    },
    "cycleSpecification": {
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "@type": "BillingCycleSpecification",
      "name": "Annual billing OOTB",
      "frequency": "yearly"
    },
    "presentationMedia": [
      {
        "name": "Post Mail OOTB"
      },
      {
        "name": "Electronic OOTB"
      }
    ]
  },
  "name": "Home Account New Configs",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "partyId": "PartyId101"
      },
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "name": "Related Party Name2"
      },
      "role": "service provider2"
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "vatCertificate": "",
  "name": "Home Account New Configs",
  "@type": "BillingAccount",
  "billStructure": {
    "id": "0.0.0.1+-bill_structure+246660",
    "name": "Billing Account",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "@type": "BillStructure",
    "format": {
      "id": "0.0.0.1+-config-bill_format+248964",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+248964",
      "name": "Summary Invoice OOTB",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "id": "0.0.0.1+-config-bill_cycle_specification+246404",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+246404",
      "name": "Annual billing OOTB",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+247684",
        "name": "",
        "rules": [
          {
            "unit": "USD",
            "consumptionRule": null
          }
        ],
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 10000.0
          }
        ]
      },
      {
        "id": "0.0.0.1+-balance_group+249732",
        "name": "",
        "rules": [
          {
            "unit": "CAD",
            "consumptionRule": null
          },
          {
            "unit": "USD",
            "consumptionRule": null
          },
          {
            "unit": "YES",
            "consumptionRule": null
          }
        ],
        "limit": [
          {
            "unit": "CAD",
            "dynamicCreditFloor": false,
            "creditFloor": -500.0,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 1000.0
          },
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 1000.0
          },
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0.0,
            "creditThreshold": 0.0,
            "creditLimit": 10000.0
          }
        ]
      }
    ],
    "presentationMedia": [
      {
        "id": "0.0.0.1+-config-bill_presentation_media+247940",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+247940",
        "name": "Post Mail OOTB",
        "@type": "BillPresentationMedia"
      },
      {
        "id": "0.0.0.1+-config-bill_presentation_media+246916",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+246916",
        "name": "Electronic OOTB",
        "@type": "BillPresentationMedia"
      }
    ]
  },
  "glSegment": ".",
  "description": "This billing account represents the main household billing structure",
  "accountType": "consumer",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "id": "0.0.0.1+-profile-related_party+248900",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "0.0.0.1+-profile-related_party+246340",
        "name": "Related Party Name2",
        "partyName": "",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "0.0.0.1+-account+248452",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/0.0.0.1+-account+248452",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "accountNum": "0.0.0.1-248452",
  "customerSegmentList": "",
  "locale": "en_US",
  "creditLimit": {
    "unit": "USD",
    "value": 10000.0
  },
  "currency": "USD"
}

Example 9: Create an account with an account relationship

This example shows how to create a billing account with an account relationship by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the sample request body file. 

curl -X POST 'http://hostname:port/brm/accountManagement/v5/billingAccount' -H 'Content-Type: application/json' -d @postBillingAccount9.json

Request Body

The following example shows the contents of the postBillingAccount9.json file sent as the request body. 

{
  "@type": "BillingAccount",
  "name": "Home Account",
  "description": "This billing account represents the main household billing structure",
  "state": "active",
  "accountType": "consumer",
  "billStructure": {
    "@type": "BillStructure",
    "name": "BI_NAME405",
    "presentationMedia": [
      {
        "name": "Post Mail"
      },
      {
        "name": "Electronic"
      }
    ],
    "format": {
      "name": "Summary Invoice-test-id"
    },
    "cycleSpecification": {
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "frequency": "yearly",
      "name": "Annual billing-testid",
      "paymentDueDateOffset": 3
    },
    "balanceGroup": [
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ],
        "isDefault": true
      },
      {
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 1000
          },
          {
            "unit": "YES",
            "creditLimit": 10000
          },
          {
            "unit": "CAD",
            "creditLimit": 1000,
            "dynamicCreditFloor": false,
            "creditFloor": -500
          }
        ]
      }
    ]
  },
  "contact": [
    {
      "contactType": "primary",
      "contactName": "child-billunit",
      "contactMedium": [
        {
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "country": "France",
          "city": "France",
          "postCode": "75014",
          "street1": "Rue des Canards",
          "street2": "test2 blr",
          "company": "IN",
          "stateOrProvince": "IN",
          "geoCode": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "mediumType": "Email",
          "emailAddress": "test@oracle.com"
        },
        {
          "@type": "PhoneContactMedium",
          "mediumType": "Phone",
          "phoneNumber": "28412"
        },
        {
          "@type": "FaxContactMedium",
          "mediumType": "Fax",
          "faxNumber": "141231112"
        }
      ]
    }
  ],
  "accountRelationship": [
    {
      "relationshipType": "Parent",
      "billStructure": {
        "name": "BI_NAME405"
      },
      "account": {
        "id": "0.0.0.1+-account+248452",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+246660"
        }
      }
    },
    {
      "relationshipType": "AR",
      "billStructure": {
        "name": "BI_NAME405"
      },
      "account": {
        "id": "0.0.0.1+-account+248452",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+246660"
        }
      }
    }
  ],
  "relatedParty": [
    {
      "role": "service provider",
      "partyOrPartyRole": {
        "name": "Related Party Name",
        "partyId": "PartyId101",
        "partyName": "PartyName101"
      }
    },
    {
      "role": "service provider2",
      "partyOrPartyRole": {
        "name": "Related Party Name2"
      }
    }
  ]
}

Response Body

If successful, the response code 201 is returned with the following response body.

{
  "vatCertificate": "",
  "name": "Home Account",
  "@type": "BillingAccount",
  "billStructure": {
    "id": "0.0.0.1+-bill_structure+247492",
    "name": "BI_NAME405",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "@type": "BillStructure",
    "format": {
      "id": "0.0.0.1+-config-bill_format+245956",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+245956",
      "name": "Summary Invoice-test-id",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "id": "0.0.0.1+-config-bill_cycle_specification+246404",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+246404",
      "name": "Annual billing OOTB",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+246212",
        "name": "",
        "rules": [
          {
            "unit": "USD",
            "consumptionRule": null
          }
        ],
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0,
            "creditThreshold": 0,
            "creditLimit": 10000
          }
        ]
      },
      {
        "id": "0.0.0.1+-balance_group+248260",
        "name": "",
        "rules": [
          {
            "unit": "CAD",
            "consumptionRule": null
          },
          {
            "unit": "USD",
            "consumptionRule": null
          },
          {
            "unit": "YES",
            "consumptionRule": null
          }
        ],
        "limit": [
          {
            "unit": "CAD",
            "dynamicCreditFloor": false,
            "creditFloor": -500,
            "overrideCreditLimit": 0,
            "creditThreshold": 0,
            "creditLimit": 1000
          },
          {
            "unit": "USD",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0,
            "creditThreshold": 0,
            "creditLimit": 1000
          },
          {
            "unit": "YES",
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "overrideCreditLimit": 0,
            "creditThreshold": 0,
            "creditLimit": 10000
          }
        ]
      }
    ],
    "presentationMedia": [
      {
        "id": "0.0.0.1+-config-bill_presentation_media+9229",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+9229",
        "name": "Post Mail",
        "@type": "BillPresentationMedia"
      },
      {
        "id": "0.0.0.1+-config-bill_presentation_media+9102",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+9102",
        "name": "Electronic",
        "@type": "BillPresentationMedia"
      }
    ]
  },
  "accountRelationship": [
    {
      "@type": "AccountRelationship",
      "billStructure": {
        "name": "BI_NAME405"
      },
      "relationshipType": "AR",
      "account": {
        "id": "0.0.0.1+-account+248452",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+246660",
          "name": "Billing Account"
        }
      }
    },
    {
      "@type": "AccountRelationship",
      "billStructure": {
        "name": "BI_NAME405"
      },
      "relationshipType": "Parent",
      "account": {
        "id": "0.0.0.1+-account+248452",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+246660",
          "name": "Billing Account"
        }
      }
    }
  ],
  "glSegment": ".",
  "description": "This billing account represents the main household billing structure",
  "accountType": "consumer",
  "state": "active",
  "relatedParty": [
    {
      "partyOrPartyRole": {
        "id": "0.0.0.1+-profile-related_party+248772",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "0.0.0.1+-profile-related_party+247748",
        "name": "Related Party Name2",
        "partyName": "",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "0.0.0.1+-account+248004",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/0.0.0.1+-account+248004",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "accountNum": "0.0.0.1-248004",
  "contact": [
    {
      "contactMedium": [
        {
          "stateOrProvince": "IN",
          "@type": "GeographicAddressContactMedium",
          "country": "France",
          "mediumType": "PostalAddress",
          "city": "France",
          "street1": "Rue des Canards test2 blr",
          "postCode": "75014",
          "company": "IN",
          "geoCode": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "emailAddress": "test@oracle.com",
          "mediumType": "Email"
        },
        {
          "phoneType": null,
          "@type": "PhoneContactMedium",
          "phoneNumber": "28412",
          "mediumType": "Phone"
        },
        {
          "phoneType": "fax",
          "@type": "FaxContactMedium",
          "faxNumber": "141231112",
          "mediumType": "Fax"
        }
      ],
      "@type": "Contact",
      "contactType": "primary",
      "contactName": "child-billunit",
      "salutation": ""
    }
  ],
  "customerSegmentList": "",
  "locale": "en_US",
  "creditLimit": {
    "unit": "USD",
    "value": 10000
  },
  "currency": "USD"
}
Back to Top