Jump to

• Request
• Response
• Examples

Get Customer Bills

get

/customerBill

Gets the customer bills that match the query criteria.

Request

Query Parameters

• @type: string
  The type of object to return.

  Examples

  Select an example Use @type=CustomerBill for a base object Use @type=CustomerBillOracle for an extended object

• amountDue.value: number(float)
  Retrieves the customer bills with an amount due that matches the specified value.

  Examples

  Select an example amountDue.value=20

• amountDue.value.gt: number(float)
  Retrieves the customer bills with an amount due that is greater than the specified value.

  Examples

  Select an example amountDue.value.gt=20

• amountDue.value.gte: number(float)
  Retrieves the customer bills with an amount due that is greater than or equal to the specified value.

  Examples

  Select an example amountDue.value.gte=20

• amountDue.value.lt: number(float)
  Retrieves the customer bills with an amount due value that is less than the specified value.

  Examples

  Select an example amountDue.value.lt=20

• amountDue.value.lte: number(float)
  Retrieves the customer bills with an amount due that is less than or equal to the specified value.

  Examples

  Select an example amountDue.value.lte=20

• billDate: string
  Retrieves the customer bills with a billDate that matches the specified dateTime.

  Examples

  Select an example billDate=2020-01-01T04:00:27-08:00

• billDate.gt: string
  Retrieves the customer bills with a billDate that is greater than the specified dateTime.

  Examples

  Select an example billDate.gt=2020-01-01T04:00:27-08:00

• billDate.gte: string
  Retrieves the customer bills with a billDate that is greater than or equal to the specified dateTime.

  Examples

  Select an example billDate.gte=2020-01-01T04:00:27-08:00

• billDate.lt: string
  Retrieves the customer bills with a billDate that is less than the specified dateTime.

  Examples

  Select an example billDate.lt=2020-01-01T04:00:27-08:00

• billDate.lte: string
  Retrieves the customer bills with a billDate that is less than or equal to the specified dateTime.

  Examples

  Select an example billDate.lte=2020-01-01T04:00:27-08:00

• billNo: string
  Retrieves customer bills by bill number. To retrieve the bills that are in progress, enter bill in progress all lowercase.

  Examples

  Select an example billNo=B1-28 billNo=bill in progress

• billNo.like: string
  Retrieves customer bills that match the specified bill number. Use the URL-encoded wild-card character %25 to replace one or more characters.

  Examples

  Select an example billNo.like=B1-28%25

• billingAccount.id: string
  Retrieves customer bills for the specified account ID or account number.

  Examples

  Select an example billingAccount.id=0.0.0.1+-account+107117 billingAccount.id=Account-123

• billingPeriod.endDateTime: string
  Retrieves the customer bills with a billing period end date time that matches the specified dateTime.

  Examples

  Select an example billingPeriod.endDateTime=2020-01-01T04:00:27-08:00

• billingPeriod.endDateTime.gt: string
  Retrieves the customer bills with a billing period end date time that is greater than the specified dateTime.

  Examples

  Select an example billingPeriod.endDateTime.gt=2020-01-01T04:00:27-08:00

• billingPeriod.endDateTime.gte: string
  Retrieves the customer bills with a billing period end date time that is greater than or equal to the specified dateTime.

  Examples

  Select an example billingPeriod.endDateTime.gte=2020-01-01T04:00:27-08:00

• billingPeriod.endDateTime.lt: string
  Retrieves the customer bills with a billing period end date time that is less than the specified dateTime.

  Examples

  Select an example billingPeriod.endDateTime.lt=2020-01-01T04:00:27-08:00

• billingPeriod.endDateTime.lte: string
  Retrieves the customer bills with a billing period end date time that is less than or equal to the specified dateTime.

  Examples

  Select an example billingPeriod.endDateTime.lte=2020-01-01T04:00:27-08:00

• billingPeriod.startDateTime: string
  Retrieves the customer bills with a billing period start date time that matches the specified dateTime.

  Examples

  Select an example billingPeriod.startDateTime=2020-01-01T04:00:27-08:00

• billingPeriod.startDateTime.gt: string
  Retrieves the customer bills with a billing period start date time that is greater than the specified dateTime.

  Examples

  Select an example billingPeriod.startDateTime.gt=2020-01-01T04:00:27-08:00

• billingPeriod.startDateTime.gte: string
  Retrieves the customer bills with a billing period start date that is greater than or equal to the specified dateTime.

  Examples

  Select an example billingPeriod.startDateTime.gte=2020-01-01T04:00:27-08:00

• billingPeriod.startDateTime.lt: string
  Retrieves the customer bills with a billing period start date time that is less than the specified dateTime.

  Examples

  Select an example billingPeriod.startDateTime.lt=2020-01-01T04:00:27-08:00

• billingPeriod.startDateTime.lte: string
  Retrieves the customer bills with a billing period start date time that is less than or equal to the specified dateTime.

  Examples

  Select an example billingPeriod.startDateTime.lte=2020-01-01T04:00:27-08:00

• fields: string
  The list of comma-separated fields to return in the response.

  Examples

  Select an example fields=runType,amountDue

• id: string
  Retrieves customer bills for the specified bill ID.

  Examples

  Select an example id=0.0.0.1+-bill+106861

• lastUpdate: string
  Retrieves the customer bills whose lastUpdate matches the specified dateTime.

  Examples

  Select an example lastUpdate=2020-01-01T04:00:27-08:00

• lastUpdate.gt: string
  Retrieves the customer bills whose lastUpdate is greater than the specified dateTime.

  Examples

  Select an example lastUpdate.gt=2020-01-01T04:00:27-08:00

• lastUpdate.gte: string
  Retrieves the customer bills whose lastUpdate is less than the specified dateTime.

  Examples

  Select an example lastUpdate.gte=2020-01-01T04:00:27-08:00

• lastUpdate.lt: string
  Retrieves customer bills whose lastUpdate is less than the specified dateTime.

  Examples

  Select an example lastUpdate.lt=2020-01-01T04:00:27-08:00

• lastUpdate.lte: string
  Retrieves the customer bills whose lastUpdate is less than or equal to the specified dateTime.

  Examples

  Select an example lastUpdate.lte=2020-01-01T04:00:27-08:00

• limit: integer
  The maximum number of results to return.

  Examples

  Select an example Use limit=10 to return the first 10 results only.

• offset: integer
  The number of results to offset the response by.

  Examples

  Select an example Use offset=10 to return results 10 and higher.

• paymentDueDate: string
  Retrieves the customer bills with a paymentDueDate that matches the specified dateTime.

  Examples

  Select an example paymentDueDate=2020-01-01T04:00:27-08:00

• paymentDueDate.gt: string
  Retrieves the customer bills with a paymentDueDate that is greater than the specified dateTime.

  Examples

  Select an example paymentDueDate.gt=2020-01-01T04:00:27-08:00

• paymentDueDate.gte: string
  Retrieves the customer bills with a paymentDueDate that is greater than or equal to the specified dateTime.

  Examples

  Select an example paymentDueDate.gte=2020-01-01T04:00:27-08:00

• paymentDueDate.lt: string
  Retrieves the customer bills with a paymentDueDate that is less than the specified dateTime.

  Examples

  Select an example paymentDueDate.lt=2020-01-01T04:00:27-08:00

• paymentDueDate.lte: string
  Retrieves the customer bills with a paymentDueDate that is less than or equal to the specified dateTime.

  Examples

  Select an example paymentDueDate.lte=2020-01-01T04:00:27-08:00

• remainingAmount.value: number(float)
  Retrieves the customer bills with a remaining amount that matches the specified value.

  Examples

  Select an example remainingAmount.value=30

• remainingAmount.value.gt: string
  Retrieves the customer bills with a remaining amount that is greater than the specified value.

  Examples

  Select an example remainingAmount.value.gt=30

• remainingAmount.value.gte: number(float)
  Retrieves the customer bills with a remaining amount that is greater than or equal to the specified value.

  Examples

  Select an example remainingAmount.value.gte=30

• remainingAmount.value.like: string
  Retrieves the customer bills with a wild card in the remaining amount value. Use the URL-encoded wild-card character %25 to replace one or more characters.

  Examples

  Select an example remainingAmount.value.like=3%25

• remainingAmount.value.lt: number(float)
  Retrieves the customer bills with a remaining amount that is less than the specified value.

  Examples

  Select an example remainingAmount.value.lt=30

• remainingAmount.value.lte: number(float)
  Retrieves the customer bills with a remaining amount that is less than or equal to the specified value.

  Examples

  Select an example remainingAmount.value.lte=30

• state: string
  The state of the bill, such as new, partiallyPaid, settled, or inProgress.

  Examples

  Select an example state=inProgress

  Allowed Values: [ "new", "partiallyPaid", "settled", "inProgress" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

The customer bills were retrieved successfully.

Headers

• X-Result-Count:
  The number of items returned in the response body.
• X-Total-Count:
  The total number of items that matched the criteria.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Customer Bill
  Title: Customer Bill

  A customer bill, also called an invoice.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerBill"
    }
}

Nested Schema : Customer Bill

Type: object

Title: Customer Bill

A customer bill, also called an invoice.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• amountDue(required): object Money
  Represents a monetary amount.
• appliedPayment: array appliedPayment
  The payments applied to the bill.
• billDate(required): string (date-time)
  Title: Bill Date

  The date the bill was generated.
• billDocument: array billDocument
  A document attached to the bill.
• billingAccount: Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "BillingAccountRef":"#/components/schemas/BillingAccountRef" } }
• billingPeriod: object TimePeriod
  Represents a time period with a start date, an end date, or both.
• billNo: string
  Title: Bill Number

  The bill's number.
• category: string
  Title: Bill Category

  The bill's category. For example: normal, duplicate, interim, or last.
• financialAccount: object Financial Account Ref
  Title: Financial Account Ref

  A financial account reference.
• href(required): string
  Title: Bill Href

  The bill's href.
• id(required): string
  Title: Bill ID

  The bill ID, or the bill number.
• lastUpdate: string (date-time)
  Title: Bill Last Updated Date

  The date that the bill was last updated.
• nextBillDate: string (date-time)
  Title: Next Bill Date

  The date the next bill will be generated.
• paymentDueDate(required): string (date-time)
  Title: Payment Due Date

  The bill's due date.
• paymentMethod: object PaymentMethodRef
  PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
• relatedParty: array relatedParty
  The parties related to the bill.
• remainingAmount: object Money
  Represents a monetary amount.
• runType: string
  Title: Bill Run Type

  The way the bill was generated, either onCycle (a regular billing cycle run) or offCycle (an on-demand request. For example: if requested by the customer or if the account closes.)
• state(required): string
  Title: State Value

  Allowed Values: [ "new", "partiallyPaid", "settled", "onHold", "inProgress" ]

  The possible values for a bill's state: new, partiallyPaid, settled, onHold, and inProgress.
• taxExcludedAmount: object Money
  Represents a monetary amount.
• taxIncludedAmount: object Money
  Represents a monetary amount.
• taxItem: array taxItem
  The taxes on the bill.

{
    "type":"object",
    "title":"Customer Bill",
    "description":"A customer bill, also called an invoice.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Bill ID",
            "description":"The bill ID, or the bill number."
        },
        "href":{
            "type":"string",
            "title":"Bill Href",
            "description":"The bill's href."
        },
        "billDate":{
            "type":"string",
            "title":"Bill Date",
            "format":"date-time",
            "description":"The date the bill was generated."
        },
        "billNo":{
            "type":"string",
            "title":"Bill Number",
            "description":"The bill's number."
        },
        "category":{
            "type":"string",
            "title":"Bill Category",
            "description":"The bill's category. For example&colon; <b>normal</b>, <b>duplicate</b>, <b>interim</b>, or <b>last</b>."
        },
        "lastUpdate":{
            "type":"string",
            "title":"Bill Last Updated Date",
            "format":"date-time",
            "description":"The date that the bill was last updated."
        },
        "nextBillDate":{
            "type":"string",
            "title":"Next Bill Date",
            "format":"date-time",
            "description":"The date the next bill will be generated."
        },
        "paymentDueDate":{
            "type":"string",
            "title":"Payment Due Date",
            "format":"date-time",
            "description":"The bill's due date."
        },
        "runType":{
            "type":"string",
            "title":"Bill Run Type",
            "description":"The way the bill was generated, either <b>onCycle</b> (a regular billing cycle run) or <b>offCycle</b> (an on-demand request. For example&colon; if requested by the customer or if the account closes.)"
        },
        "amountDue":{
            "description":"The amount due on the bill.",
            "$ref":"#/components/schemas/Money"
        },
        "appliedPayment":{
            "type":"array",
            "description":"The payments applied to the bill.",
            "items":{
                "$ref":"#/components/schemas/AppliedPayment"
            }
        },
        "billDocument":{
            "type":"array",
            "description":"A document attached to the bill.",
            "items":{
                "$ref":"#/components/schemas/AttachmentRefOrValue"
            }
        },
        "billingAccount":{
            "description":"The billing account related to the bill.",
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "billingPeriod":{
            "description":"The billing period for the bill.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "financialAccount":{
            "description":"The financial account related to the bill.",
            "$ref":"#/components/schemas/FinancialAccountRef"
        },
        "paymentMethod":{
            "description":"The bill's payment method.",
            "$ref":"#/components/schemas/PaymentMethodRef"
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties related to the bill.",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRef"
            }
        },
        "remainingAmount":{
            "description":"The remaining amount on the bill.",
            "$ref":"#/components/schemas/Money"
        },
        "state":{
            "description":"The bill's state.",
            "$ref":"#/components/schemas/stateValue"
        },
        "taxExcludedAmount":{
            "description":"The amount on the bill, excluding taxes.",
            "$ref":"#/components/schemas/Money"
        },
        "taxIncludedAmount":{
            "description":"The amount on the bill, including taxes.",
            "$ref":"#/components/schemas/Money"
        },
        "taxItem":{
            "type":"array",
            "description":"The taxes on the bill.",
            "items":{
                "$ref":"#/components/schemas/TaxItem"
            }
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "required":[
        "id",
        "href",
        "state",
        "billDate",
        "amountDue",
        "paymentDueDate"
    ]
}

Nested Schema : Money

Type: object

Represents a monetary amount.

Show Source

• unit: string
  The currency's ISO 4217 three-letter code.
• value: number (double)
  A signed floating-point number whose sign depends on the API context.

{
    "type":"object",
    "description":"Represents a monetary amount.",
    "properties":{
        "unit":{
            "type":"string",
            "nullable":true,
            "description":"The currency's ISO 4217 three-letter code."
        },
        "value":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "description":"A signed floating-point number whose sign depends on the API context."
        }
    }
}

Nested Schema : appliedPayment

Type: array

The payments applied to the bill.

Show Source

• Array of: object Applied Payment
  Title: Applied Payment

  A payment that can be assigned to a bill.

{
    "type":"array",
    "description":"The payments applied to the bill.",
    "items":{
        "$ref":"#/components/schemas/AppliedPayment"
    }
}

Nested Schema : billDocument

Type: array

A document attached to the bill.

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment", "AttachmentRef":"#/components/schemas/AttachmentRef" } }

  The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.

{
    "type":"array",
    "description":"A document attached to the bill.",
    "items":{
        "$ref":"#/components/schemas/AttachmentRefOrValue"
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• BillingAccountRef

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Refers to the billing account. The billing account describes the bill structure.",
            "properties":{
                "ratingType":{
                    "type":"string",
                    "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingAccountRef":"#/components/schemas/BillingAccountRef"
        }
    }
}

Match All

Refers to the billing account. The billing account describes the bill structure.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef
• object Discriminator: @type-allOf[2]
  Refers to the billing account. The billing account describes the bill structure.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Refers to the billing account. The billing account describes the bill structure.",
            "properties":{
                "ratingType":{
                    "type":"string",
                    "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingAccountRef":"#/components/schemas/BillingAccountRef"
        }
    }
}

Nested Schema : TimePeriod

Type: object

Represents a time period with a start date, an end date, or both.

Show Source

• endDateTime: string (date-time)
  The end of the time period in IETF RFC 3339 format.

  Example: 1985-04-12T23:20:50.52Z
• startDateTime: string (date-time)
  The start of the time period in IETF RFC 3339 format.

  Example: 1985-04-12T23:20:50.52Z

{
    "type":"object",
    "description":"Represents a time period with a start date, an end date, or both.",
    "properties":{
        "startDateTime":{
            "description":"The start of the time period in IETF RFC 3339 format.",
            "type":"string",
            "nullable":true,
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        },
        "endDateTime":{
            "description":"The end of the time period in IETF RFC 3339 format.",
            "type":"string",
            "nullable":true,
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        }
    }
}

Nested Schema : Financial Account Ref

Type: object

Title: Financial Account Ref

A financial account reference.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system. If baseType and type, need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• accountBalance: array accountBalance
  The account's balances.
• href: string
  Title: Financial Account Href

  The account's href.
• id(required): string
  Title: Financial Account ID

  The account's ID.
• name: string
  Title: Financial Account Name

  The account's name.

{
    "type":"object",
    "title":"Financial Account Ref",
    "description":"A financial account reference.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Financial Account ID",
            "description":"The account's ID."
        },
        "href":{
            "type":"string",
            "title":"Financial Account Href",
            "description":"The account's href."
        },
        "name":{
            "type":"string",
            "title":"Financial Account Name",
            "description":"The account's name."
        },
        "accountBalance":{
            "type":"array",
            "description":"The account's balances.",
            "items":{
                "$ref":"#/components/schemas/AccountBalance"
            }
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system. If <b>baseType</b> and <b>type</b>, need further disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : PaymentMethodRef

Type: object

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Match All

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Show Source

• allOf EntityRef

{
    "type":"object",
    "description":"PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : relatedParty

Type: array

The parties related to the bill.

Show Source

• Array of: object Related Party Ref
  Title: Related Party Ref

  A reference to the party related to an object.

{
    "type":"array",
    "description":"The parties related to the bill.",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRef"
    }
}

Nested Schema : taxItem

Type: array

The taxes on the bill.

Show Source

• Array of: object State Values
  Title: State Values

  A tax item.

{
    "type":"array",
    "description":"The taxes on the bill.",
    "items":{
        "$ref":"#/components/schemas/TaxItem"
    }
}

Nested Schema : Applied Payment

Type: object

Title: Applied Payment

A payment that can be assigned to a bill.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  The URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• appliedAmount: object Money
  Represents a monetary amount.
• payment: object PaymentRef
  A payment received at order time.

{
    "type":"object",
    "title":"Applied Payment",
    "description":"A payment that can be assigned to a bill.",
    "properties":{
        "appliedAmount":{
            "description":"The amount of the payment that has been applied.",
            "$ref":"#/components/schemas/Money"
        },
        "payment":{
            "description":"The payment.",
            "$ref":"#/components/schemas/PaymentRef"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"The URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

Nested Schema : PaymentRef

Type: object

A payment received at order time.

Show Source

• @baseType: string
  The object's superclass.
• @referredType: string
  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  The object's subclass.
• href: string (uri)
  The payment's href.
• id(required): string
  The payment's ID.
• name: string
  The payment's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The payment's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "description":"The payment's ID."
        },
        "name":{
            "type":"string",
            "description":"The payment's name."
        }
    },
    "description":"A payment received at order time."
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Attachment
• AttachmentRef

{
    "type":"object",
    "description":"The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Attachment"
        },
        {
            "$ref":"#/components/schemas/AttachmentRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Attachment":"#/components/schemas/Attachment",
            "AttachmentRef":"#/components/schemas/AttachmentRef"
        }
    }
}

The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.

Match One Schema

Show Source

• Attachment
• AttachmentRef

{
    "type":"object",
    "description":"The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Attachment"
        },
        {
            "$ref":"#/components/schemas/AttachmentRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Attachment":"#/components/schemas/Attachment",
            "AttachmentRef":"#/components/schemas/AttachmentRef"
        }
    }
}

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

• object allOf Entity
  Represents a base entity schema for TM Forum Open APIs.
• object Attachment-allOf[1]
  Represents an attachment that complements an element's description, such as a product description, through videos or pictures.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"Represents an attachment that complements an element's description, such as a product description, through videos or pictures.",
            "properties":{
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The attachment's name."
                },
                "description":{
                    "type":"string",
                    "nullable":true,
                    "description":"The attachment's description.",
                    "example":"Photograph of the Product"
                },
                "url":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URL of the attachment content.",
                    "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f"
                },
                "content":{
                    "type":"string",
                    "nullable":true,
                    "format":"base64",
                    "description":"The attachment's Base64-encoded content when embedded."
                },
                "size":{
                    "nullable":true,
                    "$ref":"#/components/schemas/Quantity"
                },
                "validFor":{
                    "nullable":true,
                    "$ref":"#/components/schemas/TimePeriod"
                },
                "attachmentType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The business characterization of the attachment's purpose, for example <b>logo</b> <b>instructionManual</b> <b>contractCopy</b>."
                },
                "mimeType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The technical characterization of the attachment content format using IETF MIME types."
                }
            }
        }
    ]
}

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

• allOf EntityRef
• object AttachmentRef-allOf[1]
  Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.",
            "properties":{
                "description":{
                    "type":"string",
                    "nullable":true,
                    "description":"The attachment's description."
                },
                "url":{
                    "description":"The link to the attachment media or content.",
                    "type":"string",
                    "nullable":true
                }
            }
        }
    ]
}

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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Addressable
  Defines a base schema for addressable entities.

{
    "type":"object",
    "description":"Represents a base entity schema for TM Forum Open APIs.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

• href: string
  The hyperlink reference.
• id: string
  The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

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

• attachmentType: string
  The business characterization of the attachment's purpose, for example logo instructionManual contractCopy.
• content: string (base64)
  The attachment's Base64-encoded content when embedded.
• description: string
  The attachment's description.

  Example: Photograph of the Product
• mimeType: string
  The technical characterization of the attachment content format using IETF MIME types.
• name: string
  The attachment's name.
• size: object Quantity
  Represents an amount in a specified unit.
• url: string
  The URL of the attachment content.

  Example: http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f
• validFor: object TimePeriod
  Represents a time period with a start date, an end date, or both.

{
    "type":"object",
    "description":"Represents an attachment that complements an element's description, such as a product description, through videos or pictures.",
    "properties":{
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The attachment's name."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "description":"The attachment's description.",
            "example":"Photograph of the Product"
        },
        "url":{
            "type":"string",
            "nullable":true,
            "description":"The URL of the attachment content.",
            "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f"
        },
        "content":{
            "type":"string",
            "nullable":true,
            "format":"base64",
            "description":"The attachment's Base64-encoded content when embedded."
        },
        "size":{
            "nullable":true,
            "$ref":"#/components/schemas/Quantity"
        },
        "validFor":{
            "nullable":true,
            "$ref":"#/components/schemas/TimePeriod"
        },
        "attachmentType":{
            "type":"string",
            "nullable":true,
            "description":"The business characterization of the attachment's purpose, for example <b>logo</b> <b>instructionManual</b> <b>contractCopy</b>."
        },
        "mimeType":{
            "type":"string",
            "nullable":true,
            "description":"The technical characterization of the attachment content format using IETF MIME types."
        }
    }
}

Nested Schema : Quantity

Type: object

Represents an amount in a specified unit.

Show Source

• amount: number (double)
  Default Value: 1

  The numeric value in the specified unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The unit."
        }
    }
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Addressable
  Defines a base schema for addressable entities.
• object EntityRef-allOf[2]
  Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  The URI of the referred entity.
• id(required): string
  The identifier of the referred entity.
• name: string
  The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

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

• description: string
  The attachment's description.
• url: string
  The link to the attachment media or content.

{
    "type":"object",
    "description":"Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.",
    "properties":{
        "description":{
            "type":"string",
            "nullable":true,
            "description":"The attachment's description."
        },
        "url":{
            "description":"The link to the attachment media or content.",
            "type":"string",
            "nullable":true
        }
    }
}

Nested Schema : Discriminator: @type-allOf[2]

Type: object

Refers to the billing account. The billing account describes the bill structure.

Show Source

• ratingType: string
  Indicates if the account follows a specific payment option such as prepaid or postpaid.

{
    "type":"object",
    "description":"Refers to the billing account. The billing account describes the bill structure.",
    "properties":{
        "ratingType":{
            "type":"string",
            "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid."
        }
    }
}

Nested Schema : accountBalance

Type: array

The account's balances.

Show Source

• Array of: AccountBalance

{
    "type":"array",
    "description":"The account's balances.",
    "items":{
        "$ref":"#/components/schemas/AccountBalance"
    }
}

Nested Schema : AccountBalance

Match All

Represents balances linked to an account.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object AccountBalance-allOf[1]
  Represents balances linked to an account.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Represents balances linked to an account.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The balance's ID within the list of balances."
                },
                "amount":{
                    "nullable":true,
                    "$ref":"#/components/schemas/Money"
                },
                "balanceType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The balance's type, such as a deposit, disputed, loyalty, or receivable balance."
                },
                "validFor":{
                    "nullable":true,
                    "$ref":"#/components/schemas/TimePeriod"
                }
            }
        }
    ]
}

Nested Schema : AccountBalance-allOf[1]

Type: object

Represents balances linked to an account.

Show Source

• amount: object Money
  Represents a monetary amount.
• balanceType: string
  The balance's type, such as a deposit, disputed, loyalty, or receivable balance.
• id: string
  The balance's ID within the list of balances.
• validFor: object TimePeriod
  Represents a time period with a start date, an end date, or both.

{
    "type":"object",
    "description":"Represents balances linked to an account.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The balance's ID within the list of balances."
        },
        "amount":{
            "nullable":true,
            "$ref":"#/components/schemas/Money"
        },
        "balanceType":{
            "type":"string",
            "nullable":true,
            "description":"The balance's type, such as a deposit, disputed, loyalty, or receivable balance."
        },
        "validFor":{
            "nullable":true,
            "$ref":"#/components/schemas/TimePeriod"
        }
    }
}

Nested Schema : Related Party Ref

Type: object

Title: Related Party Ref

A reference to the party related to an object.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system. If baseType and type, need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  The URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• href: string
  Title: Related Party Href

  The related party's href.
• id(required): string
  Title: Related Party ID

  The related party's ID.
• name: string
  Title: Related Party Name

  The related party's name.
• role: string
  Title: Related Party Role

  The related party's role.

{
    "type":"object",
    "title":"Related Party Ref",
    "description":"A reference to the party related to an object.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Related Party ID",
            "description":"The related party's ID."
        },
        "href":{
            "type":"string",
            "title":"Related Party Href",
            "description":"The related party's href."
        },
        "name":{
            "type":"string",
            "title":"Related Party Name",
            "description":"The related party's name."
        },
        "role":{
            "type":"string",
            "title":"Related Party Role",
            "description":"The related party's role."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"The URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system. If <b>baseType</b> and <b>type</b>, need further disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : State Values

Type: object

Title: State Values

A tax item.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  The URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• taxAmount: object Money
  Represents a monetary amount.
• taxCategory: string
  Title: Tax Category

  The tax item's category.
• taxRate: number (float)
  Title: Tax Rate

  The tax item's applied rate.

{
    "type":"object",
    "title":"State Values",
    "description":"A tax item.",
    "properties":{
        "taxCategory":{
            "type":"string",
            "title":"Tax Category",
            "description":"The tax item's category."
        },
        "taxRate":{
            "type":"number",
            "title":"Tax Rate",
            "format":"float",
            "description":"The tax item's applied rate."
        },
        "taxAmount":{
            "description":"The tax item's amount.",
            "$ref":"#/components/schemas/Money"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"The URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

400 Response

The request isn't valid.

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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request wasn't authorized.

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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

404 Response

The requested resource couldn't be 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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

This 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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

409 Response

The request could not be processed due to the conflict with the existing state of the resource.

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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The system 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

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Back to Top

Examples

• Example 1: Get In Progress Customer Bills by Payment Due Date

• Example 2: Get Bills Associated with an Account Number

Example 1: Get In Progress Customer Bills by Payment Due Date

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

The request uses query parameters to show a maximum of two results, limited to bills in progress that have a payment due date later than or equal to June 1, 2025.

curl -X GET 'http://host:port/brm/customerBillManagement/version/customerBill?limit=2&state=inProgress&paymentDueDate.gte=2025-06-01T01:05:29-07:00'

Response Body

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

[
   {
      "id": "0.0.0.1+-bill+106861",
      "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+106861",
      "billDate": null,
      "billNo": "bill in progress",
      "category": "0",
      "lastUpdate": "2025-05-02T01:14:13-07:00",
      "nextBillDate": "2025-06-13T00:00:00-07:00",
      "paymentDueDate": "2025-08-01T01:05:29-07:00",
      "runType": "onCycle",
      "amountDue": {
         "unit": "EUR",
         "value": 90.0
      },
      "appliedPayment": null,
      "billDocument": null,
      "billingAccount": {
         "id": "0.0.0.1+-account+107117",
         "href": null,
         "name": "John Miller",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "billingPeriod": {
         "endDateTime": null,
         "startDateTime": "2025-05-02T00:00:00-07:00"
      },
      "financialAccount": {
         "id": "0.0.0.1+-account+107117",
         "href": null,
         "name": "John Miller",
         "accountBalance": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "financialAccount"
      },
      "paymentMethod": {
         "id": "0.0.0.1+-payinfo-invoice+109165",
         "href": null,
         "name": "4243324",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "relatedParty": null,
      "remainingAmount": {
         "unit": "EUR",
         "value": 90.0
      },
      "state": "inProgress",
      "taxExcludedAmount": {
         "unit": "EUR",
         "value": 86.0
      },
      "taxIncludedAmount": {
         "unit": "EUR",
         "value": 90.0
      },
      "taxItem": null,
      "@baseType": "CustomerBill",
      "@schemaLocation": null,
      "@type": "CustomerBill"
    },
    {
      "id": "0.0.0.1+-bill+103581",
      "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+103581",
      "billDate": null,
      "billNo": "bill in progress",
      "category": "0",
      "lastUpdate": "2025-05-02T00:23:54-07:00",
      "nextBillDate": "2025-06-02T00:00:00-07:00",
      "paymentDueDate": "2025-10-12T01:05:29-07:00",
      "runType": "onCycle",
      "amountDue": {
         "unit": "USD",
         "value": 100.0
      },
      "appliedPayment": null,
      "billDocument": null,
      "billingAccount": {
         "id": "0.0.0.1+-account+104221",
         "href": null,
         "name": "John Miller",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "billingPeriod": {
         "endDateTime": null,
         "startDateTime": "2025-05-02T00:00:00-07:00"
      },
      "financialAccount": {
         "id": "0.0.0.1+-account+104221",
         "href": null,
         "name": "John Miller",
         "accountBalance": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "financialAccount"
      },
      "paymentMethod": {
         "id": "0.0.0.1+-payinfo-invoice+106269",
         "href": null,
         "name": "Invoice1",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "relatedParty": null,
      "remainingAmount": {
         "unit": "USD",
         "value": 0.0
      },
      "state": "inProgress",
      "taxExcludedAmount": {
         "unit": "USD",
         "value": 93.75
      },
      "taxIncludedAmount": {
         "unit": "USD",
         "value": 100.0
      },
      "taxItem": null,
      "@baseType": "CustomerBill",
      "@schemaLocation": null,
      "@type": "CustomerBill"
   }
]

Example 2: Get Bills Associated with an Account Number

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

This request uses query parameters to show all bills associated with a specified account number.

curl -X GET 'http://host:port/brm/customerBillManagement/version/customerBill?limit=2&billingAccount.id=Account-1234'

Response Body

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

[
   {
      "id": "0.0.0.1+-bill+106861",
      "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+106861",
      "billDate": null,
      "billNo": "bill in progress",
      "category": "0",
      "lastUpdate": "2025-05-02T01:14:13-07:00",
      "nextBillDate": "2025-06-13T00:00:00-07:00",
      "paymentDueDate": "2025-08-01T01:05:29-07:00",
      "runType": "onCycle",
      "amountDue": {
         "unit": "EUR",
         "value": 90.0
      },
      "appliedPayment": null,
      "billDocument": null,
      "billingAccount": {
         "id": "Account-1234",
         "href": null,
         "name": "John Miller",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "billingPeriod": {
         "endDateTime": null,
         "startDateTime": "2025-05-02T00:00:00-07:00"
      },
      "financialAccount": {
         "id": "0.0.0.1+-account+107117",
         "href": null,
         "name": "John Miller",
         "accountBalance": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "financialAccount"
      },
      "paymentMethod": {
         "id": "0.0.0.1+-payinfo-invoice+109165",
         "href": null,
         "name": "4243324",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "relatedParty": null,
      "remainingAmount": {
         "unit": "EUR",
         "value": 90.0
      },
      "state": "inProgress",
      "taxExcludedAmount": {
         "unit": "EUR",
         "value": 86.0
      },
      "taxIncludedAmount": {
         "unit": "EUR",
         "value": 90.0
      },
      "taxItem": null,
      "@baseType": "CustomerBill",
      "@schemaLocation": null,
      "@type": "CustomerBill"
    },
    {
      "id": "0.0.0.1+-bill+103581",
      "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+103581",
      "billDate": null,
      "billNo": "bill in progress",
      "category": "0",
      "lastUpdate": "2025-05-02T00:23:54-07:00",
      "nextBillDate": "2025-06-02T00:00:00-07:00",
      "paymentDueDate": "2025-10-12T01:05:29-07:00",
      "runType": "onCycle",
      "amountDue": {
         "unit": "USD",
         "value": 100.0
      },
      "appliedPayment": null,
      "billDocument": null,
      "billingAccount": {
         "id": "Account-1234",
         "href": null,
         "name": "John Miller",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "billingPeriod": {
         "endDateTime": null,
         "startDateTime": "2025-05-02T00:00:00-07:00"
      },
      "financialAccount": {
         "id": "0.0.0.1+-account+104221",
         "href": null,
         "name": "John Miller",
         "accountBalance": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "financialAccount"
      },
      "paymentMethod": {
         "id": "0.0.0.1+-payinfo-invoice+106269",
         "href": null,
         "name": "Invoice1",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "relatedParty": null,
      "remainingAmount": {
         "unit": "USD",
         "value": 0.0
      },
      "state": "inProgress",
      "taxExcludedAmount": {
         "unit": "USD",
         "value": 93.75
      },
      "taxIncludedAmount": {
         "unit": "USD",
         "value": 100.0
      },
      "taxItem": null,
      "@baseType": "CustomerBill",
      "@schemaLocation": null,
      "@type": "CustomerBill"
   }
]

Back to Top