REST Services Manager API for Billing and Revenue Management

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.

Example:

Use @type=CustomerBill for a base object or @type=CustomerBillOracle for an extended object.

amountDue.value: number(float)
Retrieves the customer bills with an amount due that matches the specified value.
Example:
```
amountDue.value=20
```
amountDue.value.gt: number(float)
Retrieves the customer bills with an amount due that is greater than the specified value.
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.
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.
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.
Example:
```
amountDue.value.lte=20
```
billDate: string
Retrieves the customer bills with a billDate that matches the specified dateTime.
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.
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.
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.
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.
Example:
```
billDate.lte=2020-01-01T04:00:27-08:00
```
billNo: string
Retrieves customer bills by bill number.
Example:
```
billNo=B1-28
```
billNo.like: string
Retrieves customer bills that match the specified bill number.
Example:
```
billNo.like=B1-28
```
billingAccount.id: string
Retrieves customer bills for the specified account ID.
Example:
```
billingAccount.id=0.0.0.1+-account+107117
```
billingPeriod.endDateTime: string
Retrieves the customer bills with a billing period end date time that matches the specified dateTime.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Example:
```
billingPeriod.startDateTime.lte=2020-01-01T04:00:27-08:00
```
fields: string
The list of comma-separated fields to return in the response.
Example:
```
fields=runType,amountDue
```
id: string
Retrieves customer bills for the specified bill ID.
Example:
```
id=0.0.0.1+-bill+106861
```
lastUpdate: string
Retrieves the customer bills whose lastUpdate matches the specified dateTime.
Example:
```
lastUpdate=2020-01-01T04:00:27-08:00
```
lastUpdate.gt: string
Retrieves the customer bills whose lastUpdate is greater than the specified dateTime.
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.
Example:
```
lastUpdate.gte=2020-01-01T04:00:27-08:00
```
lastUpdate.lt: string
Retrieves customer bills whose lastUpdate is less than the specified dateTime.
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.
Example:
```
lastUpdate.lte=2020-01-01T04:00:27-08:00
```
limit: integer
The maximum number of results to return.
Example:
```
Use limit=10 to return the first 10 results only.
```
offset: integer
The number of results to offset the response by.
Example:
```
Use offset=10 to return results 10 and higher.
```
paymentDueDate: string
Retrieves the customer bills with a paymentDueDate that matches the specified dateTime.
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.
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.
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.
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.
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.
Example:
```
remainingAmount.value=30
```
remainingAmount.value.gt: string
Retrieves the customer bills with a remaining amount that is greater than the specified value.
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.
Example:
```
remainingAmount.value.gte=30
```
remainingAmount.value.like: string
Retrieves the customer bills with a wild card in the remaining amount value.
Example:
```
remainingAmount.value.like=3
```
remainingAmount.value.lt: number(float)
Retrieves the customer bills with a remaining amount that is less than the specified value.
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.
Example:
```
remainingAmount.value.lte=30
```
state: string
The state of the bill.

Allowed Values: [ "new", "partiallyPaid", "settled", "inProgress" ]
Example:
```
state=inProgress
```

There's no request body for this operation.

Response

Supported Media Types

application/json;charset=utf-8

200 Response

Success

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.

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

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

The parties related to the bill.
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.

{
    "type":"object",
    "title":"Customer Bill",
    "description":"A customer bill, also called an invoice.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Bill ID",
            "description":"The bill's ID."
        },
        "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, <b>normal</b>, <b>duplicate</b>, <b>interim</b>, <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, 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":"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":"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

A base / value business entity used to represent money.

Show Source

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.

{
    "type":"object",
    "description":"A base / value business entity used to represent money.",
    "required":[
        "value",
        "unit"
    ],
    "properties":{
        "value":{
            "type":"number",
            "format":"float",
            "description":"A positive floating point number."
        },
        "unit":{
            "type":"string",
            "description":"Refers to the  currency (ISO4217 norm uses 3 letters to define the currency)."
        }
    }
}

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.

{
    "type":"array",
    "description":"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 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.

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

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.

{
    "type":"object",
    "title":"Billing Account Ref",
    "description":"A billing account is a detailed description of a bill structure.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique ID for the billing account."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "href":{
            "type":"string",
            "description":"A reference for the billing account."
        },
        "name":{
            "type":"string",
            "description":"The name of the billing account."
        },
        "@baseType":{
            "type":"string",
            "description":"The super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"The sub-class entity name when sub-classing."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

Nested Schema : TimePeriod

Type: object

A period of time.

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.

{
    "type":"object",
    "description":"A period of time.",
    "properties":{
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "title":"End Time Period",
            "description":"The end of the time period in IETC-RFC-3339 format."
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "title":"Start Time Period",
            "description":"The start of the time period in IETC-RFC-3339 format."
        }
    }
}

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 : Payment Method Ref

Type: object

Title: Payment Method Ref

A reference to a payment method.

Show Source

@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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Payment Method Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The payment method's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The payment method's href."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The payment method's name."
        },
        "@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",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a payment method."
}

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

Taxes on the bill.

Show Source

Array of: object State Values

Title: State Values

A tax item.

{
    "type":"array",
    "description":"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

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.

{
    "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":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

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

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.

{
    "type":"object",
    "title":"Payment Ref",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Payment ID",
            "description":"The payment reference's ID."
        },
        "href":{
            "type":"string",
            "title":"Payment Href",
            "description":"The payment reference's href."
        },
        "name":{
            "type":"string",
            "title":"Payment Name",
            "description":"The payment reference's name."
        },
        "amount":{
            "description":"The payment reference'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":"A 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 : 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 TimePeriod

A period of time.

{
    "type":"object",
    "title":"Attachment Ref Or Value",
    "description":"An attachment reference or value. The <b>baseType</b>, <b>type</b>, <b>schemaLocation</b> and <b>referredType</b> properties are related to the contained object, not the AttchmentRefOrValue.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Attachment ID",
            "description":"The attachment reference's ID."
        },
        "href":{
            "type":"string",
            "title":"Attachment Href",
            "description":"The attachment reference's href."
        },
        "attachmentType":{
            "type":"string",
            "title":"Attachment Type",
            "description":"The attachment reference's type. For example, <b>video</b> or <b>picture</b>."
        },
        "content":{
            "type":"string",
            "title":"Attachment Content",
            "description":"The attachment's base64 encoded content."
        },
        "description":{
            "type":"string",
            "title":"Attachment Description",
            "description":"The attachment's description."
        },
        "mimeType":{
            "type":"string",
            "title":"Mime Type",
            "description":"The attachment's mime type. For example, a file extension like <b>jpeg</b> or <b>mp4</b>."
        },
        "name":{
            "type":"string",
            "title":"Attachment Name",
            "description":"The attachment's name."
        },
        "url":{
            "type":"string",
            "title":"Attachment Link",
            "description":"A URL linking to the attachment content."
        },
        "size":{
            "description":"The attachment's size.",
            "$ref":"#/components/schemas/Quantity"
        },
        "validFor":{
            "description":"The time period for which the attachment is valid.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@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."
        },
        "@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."
        }
    }
}

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

{
    "type":"object",
    "description":"An amount in a given unit.",
    "properties":{
        "amount":{
            "default":1,
            "type":"number",
            "format":"float",
            "description":"Numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "description":"Unit"
        }
    }
}

Nested Schema : accountBalance

Type: array

The account's balances.

Show Source

Array of: object Account Balance

Title: Account Balance

A balance associated with an account.

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

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

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.

{
    "type":"object",
    "title":"Account Balance",
    "description":"A balance associated with an account.",
    "required":[
        "amount",
        "balanceType",
        "validFor"
    ],
    "properties":{
        "balanceType":{
            "type":"string",
            "title":"Balance Type",
            "description":"The balance's type. For example, <b>deposit</b>, <b>disputed</b>, <b>loyalty</b>, or <b>receivable</b>."
        },
        "amount":{
            "description":"The balance's amount.",
            "$ref":"#/components/schemas/Money"
        },
        "validFor":{
            "description":"The time period for which the balance is valid.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@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."
        }
    }
}

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.

{
    "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":"A 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

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.

{
    "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":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

400 Response

Bad Request

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

401 Response

Unauthorized

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

403 Response

Forbidden

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

404 Response

Not Found

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

405 Response

Method Not allowed

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

409 Response

Conflict

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@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.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

Examples

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, 2020.

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

Example of the 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": "2020-05-02T01:14:13-07:00",
        "nextBillDate": "2020-06-13T00:00:00-07:00",
        "paymentDueDate": "2020-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": "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": "2020-05-02T00:23:54-07:00",
        "nextBillDate": "2020-06-02T00:00:00-07:00",
        "paymentDueDate": "2020-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": "Grace Wang",
            "@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+104221",
            "href": null,
            "name": "Grace Wang",
            "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"
    }
]