Get a Customer Bill by ID
get
/customerBill/{id}
Gets the specified customer bill.
Request
Path Parameters
-
id(required): string
The ID of the customer bill to get.Examples
Query Parameters
-
@type: string
The type of object to return.Examples
-
fields: string
The list of comma-separated fields to return in the response.Examples
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Root 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
Title:
Money
An amount of 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
Time Period
Title:
Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime. -
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 payment method reference. - relatedParty: array relatedParty
-
remainingAmount: object
Money
Title:
Money
An amount of 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", "onHold", "inProgress" ]
Possible values for a bill's state. -
taxExcludedAmount: object
Money
Title:
Money
An amount of money. -
taxIncludedAmount: object
Money
Title:
Money
An amount of money. -
taxItem: array
taxItem
Taxes on the bill.
Nested Schema : Money
Type:
object
Title:
Money
An amount of money.
Show Source
-
unit: string
Title:
Currency
An ISO 4217 three letter currency code. -
value: number
(float)
Title:
Amount
A positive floating point number.
Nested Schema : appliedPayment
Type:
array
Payments applied to the bill.
Show Source
-
Array of:
object Applied Payment
Title:
Applied Payment
A payment that can be assigned to a bill.
Nested Schema : billDocument
Type:
array
A document attached to the bill.
Show Source
-
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.
Nested Schema : Billing Account Ref
Type:
object
Title:
Billing Account Ref
A billing account is a detailed description of a bill structure.
Show Source
-
@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.
Nested Schema : Time Period
Type:
object
Title:
Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Show Source
-
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. If you specify this, you must also specify endDateTime.
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: object
Account Balance
Title:
Account Balance
A balance associated with an account. -
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.
Nested Schema : Payment Method Ref
Type:
object
Title:
Payment Method Ref
A payment method 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. -
href: string
Title:
Payment Method Href
The payment method's href. -
id(required): string
Title:
Payment Method ID
The payment method's ID. -
name: string
Title:
Payment Method Name
The payment method's name.
Nested Schema : taxItem
Type:
array
Taxes on the bill.
Show Source
-
Array of:
object State Values
Title:
State Values
A tax item.
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
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
appliedAmount: object
Money
Title:
Money
An amount of 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.
Nested Schema : Payment Ref
Type:
object
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.
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. -
amount: object
Money
Title:
Money
An amount of 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.
Nested Schema : Attachment Ref Or Value
Type:
object
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.
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. -
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
Time Period
Title:
Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Nested Schema : Quantity
Type:
object
An amount in a given unit.
Show Source
-
amount: number
(float)
Default Value:
1
Numeric value in a given unit. -
units: string
Unit
Nested Schema : Account Balance
Type:
object
Title:
Account Balance
A balance associated with an account.
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. -
amount(required): object
Money
Title:
Money
An amount of money. -
balanceType(required): string
Title:
Balance Type
The balance's type. For example, deposit, disputed, loyalty, or receivable. -
validFor(required): object
Time Period
Title:
Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
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
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.
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
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
taxAmount: object
Money
Title:
Money
An amount of 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
Bad Request
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An application's error code, defined in the API or a common list. -
message: string
Title:
Error Message
More details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension
401 Response
Unauthorized
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An application's error code, defined in the API or a common list. -
message: string
Title:
Error Message
More details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension
403 Response
Forbidden
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An application's error code, defined in the API or a common list. -
message: string
Title:
Error Message
More details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension
404 Response
Not Found
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An application's error code, defined in the API or a common list. -
message: string
Title:
Error Message
More details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension
405 Response
Method Not allowed
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An application's error code, defined in the API or a common list. -
message: string
Title:
Error Message
More details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension
409 Response
Conflict
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An application's error code, defined in the API or a common list. -
message: string
Title:
Error Message
More details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension
500 Response
Internal Server Error
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An application's error code, defined in the API or a common list. -
message: string
Title:
Error Message
More details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension
Examples
The following example shows how to get the bill with the specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
This request uses the fields query parameter to show the details for certain fields only.
curl -X GET 'http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+106861?fields=amountDue,paymentDueDate'
Example of the Response Body
The following example shows the contents of the response body in JSON format. Because the request included only id, amountDue, and paymentDueDate in the fields query parameter, these are the only details shown.
{ "id": "0.0.0.1+-bill+106861", "href": null, "billDate": null, "billNo": null, "category": null, "lastUpdate": null, "nextBillDate": null, "paymentDueDate": "2025-08-01T01:05:29-07:00", "runType": null, "amountDue": { "unit": "EUR", "value": 40.0 }, "appliedPayment": null, "billDocument": null, "billingAccount": null, "billingPeriod": null, "financialAccount": null, "paymentMethod": null, "relatedParty": null, "remainingAmount": null, "state": null, "taxExcludedAmount": null, "taxIncludedAmount": null, "taxItem": null, "@baseType": "CustomerBill", "@schemaLocation": null, "@type": "CustomerBill" }