Update a Customer Bill
/customerBill/{id}
Request
-
id(required): string
The ID of the customer bill to update.
- application/json;charset=utf-8
object
Customer Bill Update
-
@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. -
state: string
Title:
State Value
Allowed Values:[ "new", "partiallyPaid", "settled" ]
Possible values for a bill's state.
Response
- application/json;charset=utf-8
200 Response
object
Customer Bill
-
@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
A base / value business entity used to represent money.
-
appliedPayment: array
appliedPayment
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: object
Billing Account Ref
Title:
Billing Account Ref
A billing account is a detailed description of a bill structure. -
billingPeriod: object
TimePeriod
A period of time.
-
billNo: string
Title:
Bill Number
The bill's number. -
category: string
Title:
Bill Category
The bill's category. For example, normal, duplicate, interim, 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's ID. -
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
Payment Method Ref
Title:
Payment Method Ref
A reference to a payment method. - relatedParty: array relatedParty
-
remainingAmount: object
Money
A base / value business entity used to represent money.
-
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" ]
Possible values for a bill's state. -
taxExcludedAmount: object
Money
A base / value business entity used to represent money.
-
taxIncludedAmount: object
Money
A base / value business entity used to represent money.
-
taxItem: array
taxItem
Taxes on the bill.
object
-
unit(required): string
Refers to the currency (ISO4217 norm uses 3 letters to define the currency).
-
value(required): number
(float)
A positive floating point number.
array
-
Array of:
object Applied Payment
Title:
Applied Payment
A payment that can be assigned to a bill.
array
-
Array of:
object Attachment Ref Or Value
Title:
Attachment Ref Or Value
An attachment reference or value. The baseType, type, schemaLocation and referredType properties are related to the contained object, not the AttchmentRefOrValue.
object
Billing Account Ref
-
@baseType: string
The super-class when sub-classing.
-
@referredType: string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
The sub-class entity name when sub-classing.
-
accountNumber: string
The account number.
-
href: string
A reference for the billing account.
-
id: string
The unique ID for the billing account.
-
name: string
The name of the billing account.
object
-
endDateTime: string
(date-time)
Title:
End Time Period
The end of the time period in IETC-RFC-3339 format. -
startDateTime: string
(date-time)
Title:
Start Time Period
The start of the time period in IETC-RFC-3339 format.
object
Financial Account Ref
-
@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.
object
Payment Method Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
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. -
href: string
Title:
Href
The payment method's href. -
id(required): string
Title:
ID
The payment method's ID. -
name: string
Title:
Name
The payment method's name.
array
-
Array of:
object State Values
Title:
State Values
A tax item.
object
Applied Payment
-
@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. -
appliedAmount: object
Money
A base / value business entity used to represent money.
-
payment: object
Payment Ref
Title:
Payment Ref
A payment captured as a reference on an order. Used when a payment is made immediately on an order rather than at a later billing date.
object
Payment Ref
-
@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. -
amount: object
Money
A base / value business entity used to represent money.
-
href: string
Title:
Payment Href
The payment reference's href. -
id(required): string
Title:
Payment ID
The payment reference's ID. -
name: string
Title:
Payment Name
The payment reference's name.
object
Attachment Ref Or Value
-
@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. -
attachmentType: string
Title:
Attachment Type
The attachment reference's type. For example, video or picture. -
content: string
Title:
Attachment Content
The attachment's base64 encoded content. -
description: string
Title:
Attachment Description
The attachment's description. -
href: string
Title:
Attachment Href
The attachment reference's href. -
id: string
Title:
Attachment ID
The attachment reference's ID. -
mimeType: string
Title:
Mime Type
The attachment's mime type. For example, a file extension like jpeg or mp4. -
name: string
Title:
Attachment Name
The attachment's name. -
size: object
Quantity
An amount in a given unit.
-
url: string
Title:
Attachment Link
A URL linking to the attachment content. -
validFor: object
TimePeriod
A period of time.
object
-
amount: number
(float)
Default Value:
1
Numeric value in a given unit. -
units: string
Unit
array
-
Array of:
object Account Balance
Title:
Account Balance
A balance associated with an account.
object
Account Balance
-
@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. -
amount(required): object
Money
A base / value business entity used to represent money.
-
balanceType(required): string
Title:
Balance Type
The balance's type. For example, deposit, disputed, loyalty, or receivable. -
validFor(required): object
TimePeriod
A period of time.
object
Related Party Ref
-
@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. -
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.
object
State Values
-
@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. -
taxAmount: object
Money
A base / value business entity used to represent money.
-
taxCategory: string
Title:
Tax Category
The tax item's category. -
taxRate: number
(float)
Title:
Tax Rate
The tax item's applied rate.
400 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
401 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
403 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
404 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
405 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
409 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
500 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
Examples
The following example shows how to update the state of a customer bill by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.
The -d option specifies the file to attach as the request body. You can use either a bill ID POID, as in the example, or a bill number.
curl -X PATCH 'http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+106861' -d @billUpdate.json
Example of Request Body
The following is an example of the contents of the billUpdate.json file sent as the request body. You can only use the PATCH method to update the bill state from InProgress to OnHold and from OnHold to InProgress.
{ "state": "OnHold", "@baseType": "CustomerBill", "@schemaLocation": null, "@type": "CustomerBill" }
Example of Response Body
The following is an example 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": "2021-05-02T01:14:13-07:00",
"nextBillDate": "2021-06-13T00:00:00-07:00",
"paymentDueDate": "2021-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": "Tanya Levy",
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": "billingAccount"
},
"billingPeriod": {
"endDateTime": null,
"startDateTime": "2020-05-02T00:00:00-07:00"
},
"financialAccount": {
"id": "0.0.0.1+-account+107117",
"href": null,
"name": "Tanya Levy",
"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": "OnHold",
"taxExcludedAmount": {
"unit": "EUR",
"value": 86.0
},
"taxIncludedAmount": {
"unit": "EUR",
"value": 90.0
},
"taxItem": null,
"@baseType": "CustomerBill",
"@schemaLocation": null,
"@type": "CustomerBill"
}