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

Partially Update a Billing Account

patch

/billingAccount/{id}

The operation updates partially a Billing Account entity.

Request

Path Parameters
Query Parameters
  • Specifies the comma-separated properties to include in the response.
Supported Media Types
Request Body - application/json-patch-query+json ()
Root Schema : schema
Type: array
A JSON Patch operations document as defined by RFC 6902.
Show Source
Nested Schema : JsonPatch
Type: object
A JSON Patch document as defined by RFC 6902.
Show Source
Request Body - application/json-patch+json ()
Root Schema : schema
Type: array
A JSON Patch operations document as defined by RFC 6902.
Show Source
Nested Schema : JsonPatch
Type: object
A JSON Patch document as defined by RFC 6902.
Show Source
Request Body - application/merge-patch+json ()
Root Schema : schema
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
  • PartyAccount_MVO
  • type
    Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Nested Schema : PartyAccount_MVO
Match All
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : Account_MVO
Match All
Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.
Show Source
Nested Schema : Entity_MVO
Type: object
Represents a base entity schema for TM Forum Open APIs.
Match All
Represents a base entity schema for TM Forum Open APIs.
Show Source
  • Extensible
    Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Account_MVO-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_MVO-allOf[1]
Type: object
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : type
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_MVO
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_MVO-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_MVO-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_MVO
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 : Addressable
Type: object
Defines a base schema for addressable entities.
Show Source
Nested Schema : EntityRef-allOf[2]
Type: object
Represents an entity reference schema for EntityRef classes.
Show Source
Nested Schema : Contact_MVO
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_MVO-allOf[1]
    Represents an individual or organization that serves as an account contact through a contact medium.
Nested Schema : Contact_MVO-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_MVO
Match All
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : ContactMedium_MVO-allOf[1]
Type: object
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef_MVO
Match All
Refers to a related party or party role linked to a specific entity.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef_MVO-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_MVO", "PartyRoleRef":"#/components/schemas/PartyRoleRef_MVO" } }
  • 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_MVO
Type: object
Refers to a party.
Match All
Refers to a party.
Show Source
Nested Schema : PartyRoleRef_MVO
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_MVO-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_MVO
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : TaxExemptionCertificate_MVO-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_MVO
Match All
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
Nested Schema : TaxDefinition_MVO-allOf[1]
Type: object
Refers to a tax definition. A tax jurisdiction levies the tax.
Nested Schema : BillStructure_MVO
Match All
Represents the bill structure for party accounts, including billing and settlement accounts.
Show Source
Nested Schema : BillStructure_MVO-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_MVO", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef_MVO" } }
    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_MVO", "BillFormatRef":"#/components/schemas/BillFormatRef_MVO" } }
    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_MVO", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef_MVO" } }
    The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : BillingCycleSpecification_MVO
Match All
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillingCycleSpecificationRef_MVO
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_MVO-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_MVO
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_MVO
    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_MVO
    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_MVO
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
Request Body - application/json ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : schema
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
  • PartyAccount_MVO
  • type
    Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.
Nested Schema : BillingAccountOracle_MVO
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_MVO
Match All
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : Account_MVO
Match All
Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.
Show Source
Nested Schema : Entity_MVO
Type: object
Represents a base entity schema for TM Forum Open APIs.
Match All
Represents a base entity schema for TM Forum Open APIs.
Show Source
  • Extensible
    Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Nested Schema : Extensible
Type: object
Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
Show Source
Nested Schema : Account_MVO-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_MVO-allOf[1]
Type: object
Represents an account used for billing or settlement purposes for a party. Specializes Account.
Show Source
Nested Schema : type
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_MVO
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_MVO-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_MVO-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_MVO
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 : Addressable
Type: object
Defines a base schema for addressable entities.
Show Source
Nested Schema : EntityRef-allOf[2]
Type: object
Represents an entity reference schema for EntityRef classes.
Show Source
Nested Schema : Contact_MVO
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_MVO-allOf[1]
    Represents an individual or organization that serves as an account contact through a contact medium.
Nested Schema : Contact_MVO-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_MVO
Match All
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : ContactMedium_MVO-allOf[1]
Type: object
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef_MVO
Match All
Refers to a related party or party role linked to a specific entity.
Show Source
Nested Schema : RelatedPartyRefOrPartyRoleRef_MVO-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_MVO", "PartyRoleRef":"#/components/schemas/PartyRoleRef_MVO" } }
  • 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_MVO
Type: object
Refers to a party.
Match All
Refers to a party.
Show Source
Nested Schema : PartyRoleRef_MVO
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_MVO-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_MVO
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : TaxExemptionCertificate_MVO-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_MVO
Match All
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
Nested Schema : TaxDefinition_MVO-allOf[1]
Type: object
Refers to a tax definition. A tax jurisdiction levies the tax.
Nested Schema : BillStructure_MVO
Match All
Represents the bill structure for party accounts, including billing and settlement accounts.
Show Source
Nested Schema : BillStructure_MVO-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_MVO", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef_MVO" } }
    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_MVO", "BillFormatRef":"#/components/schemas/BillFormatRef_MVO" } }
    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_MVO", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef_MVO" } }
    The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.
Nested Schema : BillingCycleSpecification_MVO
Match All
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillingCycleSpecificationRef_MVO
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_MVO-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_MVO
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_MVO
    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_MVO
    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_MVO
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 : 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 : BillingAccountOracle_MVO-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 : accountRelationship
Type: array
Show Source
Nested Schema : BillStructureOracle_MVO
Match All
Represents an extended bill structure for Oracle implementation.
Show Source
Nested Schema : contact
Type: array
Show Source
Nested Schema : ServiceBillStructureOracle_MVO
Type: array
Represents an array of bill structures.
Show Source
Nested Schema : taxExemption
Type: array
Show Source
Nested Schema : AccountRelationshipOracle_MVO
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_MVO-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_MVO-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_MVO", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef_MVO" } }
    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_MVO
Match All
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : BillingCycleSpecificationOracle_MVO-allOf[1]
Type: object
Describes when to initiate a billing cycle and its substeps.
Show Source
Nested Schema : ContactOracle_MVO
Match All
Represents an individual or organization that serves as an account contact through a contact medium.
Show Source
Nested Schema : ContactOracle_MVO-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_MVO
Match All
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : ContactMediumOracle_MVO-allOf[0]
Type: object
Indicates the contact medium that can contact the party.
Show Source
Nested Schema : TaxExemptionCertificateOracle_MVO
Match All
Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.
Show Source
Nested Schema : TaxExemptionCertificateOracle_MVO-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 : TaxDefinitionOracle_MVO
Match All
Refers to a tax definition. A tax jurisdiction levies the tax.
Show Source
Nested Schema : TaxDefinitionOracle_MVO-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

200 Response

The request completed successfully.
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

Example 1: Update consumption rules

This example shows how to update the consumption rules for a billing account by submitting a PATCH 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 PATCH 'http://hostname:port/brm/accountManagement/v5/billingAccount/billing-account-post-rules' -H 'Content-Type: application/json' -d @patchBillingAccount1.json

Request Body

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

{
  "billStructure": {
    "@type": "BillStructure",
    "balanceGroup": [
      {
        "isDefault": true,
        "limit": [
          {
            "unit": "USD",
            "creditLimit": 10000
          }
        ],
        "rules": [
          {
            "unit": "USD",
            "consumptionRule": "EST"
          }
        ],
        "id": "0.0.0.1+-balance_group+165765"
      }
    ],
    "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"
      }
    ]
  }
}

Response Body

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

{
  "customerSegmentList": "",
  "accountNum": "billing-account-post-rules",
  "vatCertificate": "",
  "@type": "BillingAccountOracle",
  "billStructure": {
    "@type": "BillStructureOracle",
    "billingSegment": "0",
    "balanceGroup": [
      {
        "isDefault": true,
        "name": "",
        "limit": [
          {
            "unit": "CAD",
            "overrideCreditLimit": 0,
            "creditFloor": null,
            "dynamicCreditFloor": false,
            "creditThreshold": 0
          },
          {
            "unit": "USD",
            "overrideCreditLimit": 0,
            "creditLimit": 10000,
            "creditFloor": null,
            "dynamicCreditFloor": false,
            "creditThreshold": 0
          }
        ],
        "rules": [
          {
            "unit": "CAD",
            "consumptionRule": null
          },
          {
            "unit": "USD",
            "consumptionRule": "EST"
          }
        ],
        "id": "0.0.0.1+-balance_group+165765"
      }
    ],
    "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+164027",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+164027"
      },
      {
        "@type": "BillPresentationMedia",
        "name": "Electronic-1",
        "id": "0.0.0.1+-config-bill_presentation_media+166075",
        "href": "https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+166075"
      }
    ],
    "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",
  "lastUpdate": "2018-01-01T08:00:00.00Z",
  "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@oracle.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@oracle.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",
  "currencySecondary": "",
  "currency": "USD",
  "state": "active",
  "id": "billing-account-post-rules",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/billing-account-post-rules",
  "attribute": 0
}

Example 2: Add an account relationship

This example shows how to add an account relationship to a billing account by submitting a PATCH 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 PATCH 'http://hostname:port/brm/accountManagement/v5/billingAccount/0.0.0.1+-account+234351' -H 'Content-Type: application/json' -d @patchBillingAccount2.json

Request Body

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

{
  "accountRelationship": [
    {
      "relationshipType": "Parent",
      "billStructure": {
        "name": "childBill"
      },
      "account": {
        "id": "0.0.0.1+-account+233565",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+237149"
        }
      }
    },
    {
      "relationshipType": "AR",
      "billStructure": {
        "name": "childBill"
      },
      "account": {
        "id": "0.0.0.1+-account+233565",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+237149"
        }
      }
    }
  ]
}

Response Body

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

{
  "vatCertificate": "",
  "name": "Home Account",
  "@type": "BillingAccount",
  "billStructure": {
    "id": "0.0.0.1+-bill_structure+236783",
    "name": "childBill",
    "businessProfileId": "0.0.0.0++0",
    "actgType": "balance_forward",
    "billingSegment": "0",
    "@type": "BillStructure",
    "format": {
      "id": "0.0.0.1+-config-bill_format+226556",
      "href": "https://host:port/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+226556",
      "name": "Summary Invoice-test-id",
      "@type": "BillFormat"
    },
    "acctSuppressed": false,
    "cycleSpecification": {
      "id": "0.0.0.1+-config-bill_cycle_specification+237469",
      "href": "https://host:port/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+237469",
      "name": "Annual billing-testid",
      "@type": "BillingCycleSpecification",
      "billingDateShift": 3,
      "paymentDueDateOffset": 3,
      "frequency": "yearly"
    },
    "balanceGroup": [
      {
        "id": "0.0.0.1+-balance_group+236271",
        "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+235247",
        "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+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": {
        "id": "0.0.0.1+-bill_structure+236783",
        "name": "childBill"
      },
      "relationshipType": "AR",
      "account": {
        "id": "0.0.0.1+-account+233565",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+237149",
          "name": "parentBill"
        }
      }
    },
    {
      "@type": "AccountRelationship",
      "billStructure": {
        "id": "0.0.0.1+-bill_structure+236783",
        "name": "childBill"
      },
      "relationshipType": "Parent",
      "account": {
        "id": "0.0.0.1+-account+233565",
        "billStructure": {
          "id": "0.0.0.1+-bill_structure+237149",
          "name": "parentBill"
        }
      }
    }
  ],
  "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+234991",
        "name": "Related Party Name",
        "partyName": "PartyName101",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": "PartyId101"
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider"
    },
    {
      "partyOrPartyRole": {
        "id": "0.0.0.1+-profile-related_party+237039",
        "name": "Related Party Name2",
        "partyName": "",
        "@type": "PartyRefOrPartyRoleRef",
        "partyId": ""
      },
      "@type": "RelatedPartyRefOrPartyRoleRef",
      "role": "service provider2"
    }
  ],
  "id": "0.0.0.1+-account+234351",
  "href": "https://host:port/brm/accountManagement/v5/billingAccount/0.0.0.1+-account+234351",
  "lastUpdate": "2018-01-15T00:00:00.00Z",
  "brmAccountType": "standard",
  "currencySecondary": "",
  "attribute": 0,
  "accountNum": "0.0.0.1-234351",
  "contact": [
    {
      "contactMedium": [
        {
          "stateOrProvince": "IN",
          "@type": "GeographicAddressContactMedium",
          "mediumType": "PostalAddress",
          "country": "France",
          "city": "France",
          "street1": "Rue des Canards test2 blr",
          "postCode": "75014",
          "company": "IN",
          "geoCode": "IN"
        },
        {
          "@type": "EmailContactMedium",
          "emailAddress": "test@oracle.com",
          "mediumType": "Email"
        },
        {
          "phoneType": 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",
  "currency": "USD"
}
Back to Top