Show Source

• accountNumber(required): string
  The account number associated with the bill.
• billId(required): string
  The bill ID.
• billUnitId(required): string
  The ID for the bill unit associated with the bill.
• cycleEnds: string (date-time)
  The date and time the billing cycle ends.
• cycleStarts: string (date-time)
  The date and time the billing cycle starts.
• dueAmount(required): number
  The total amount due.
• dueDate(required): string (date-time)
  The due date for the bill.
• itemsAffected: array itemsAffected
  Affected bill items.
• itemsAffectedCount: integer (int64)
  The number of bill items affected by the bill.

{
    "required":[
        "accountNumber",
        "billId",
        "billUnitId",
        "dueAmount",
        "dueDate"
    ],
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "description":"The bill ID."
        },
        "cycleStarts":{
            "type":"string",
            "description":"The date and time the billing cycle starts.",
            "format":"date-time"
        },
        "cycleEnds":{
            "type":"string",
            "description":"The date and time the billing cycle ends.",
            "format":"date-time"
        },
        "dueAmount":{
            "type":"number",
            "description":"The total amount due."
        },
        "dueDate":{
            "type":"string",
            "description":"The due date for the bill.",
            "format":"date-time"
        },
        "itemsAffectedCount":{
            "type":"integer",
            "description":"The number of bill items affected by the bill.",
            "format":"int64"
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number associated with the bill."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID for the bill unit associated with the bill."
        },
        "itemsAffected":{
            "type":"array",
            "description":"Affected bill items.",
            "items":{
                "$ref":"#/components/schemas/ItemsAffected"
            }
        }
    },
    "description":"The list of bill details associated with the payment."
}

Show Source

• Array of: object ItemsAffected
  Affected bill items.

{
    "type":"array",
    "description":"Affected bill items.",
    "items":{
        "$ref":"#/components/schemas/ItemsAffected"
    }
}

Show Source

• accountNumber(required): string
  The account number associated with the bill item.
• amount(required): number
  The bill item amount.
• billNumber(required): string
  The bill number associated with the bill item.
• billUnitId(required): string
  The ID of the bill unit associated with the bill item.
• cycleEnds: string (date-time)
  The date and time the billing cycle ends.
• cycleStarts: string (date-time)
  The date and time the billing cycle starts.
• item(required): string
  The bill item.
• settledNonTaxedAmount(required): number
  The nontaxable amount for the bill item settled by the payment.
• settledTaxAmount(required): number
  The amount of tax for the bill item settled by the payment.
• settledTaxedAmount(required): number
  The taxable amount for the bill item settled by the payment.

{
    "required":[
        "accountNumber",
        "amount",
        "billNumber",
        "billUnitId",
        "item",
        "settledNonTaxedAmount",
        "settledTaxAmount",
        "settledTaxedAmount"
    ],
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":"The account number associated with the bill item."
        },
        "billNumber":{
            "type":"string",
            "description":"The bill number associated with the bill item."
        },
        "amount":{
            "type":"number",
            "description":"The bill item amount."
        },
        "item":{
            "type":"string",
            "description":"The bill item."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit associated with the bill item."
        },
        "cycleStarts":{
            "type":"string",
            "description":"The date and time the billing cycle starts.",
            "format":"date-time"
        },
        "cycleEnds":{
            "type":"string",
            "description":"The date and time the billing cycle ends.",
            "format":"date-time"
        },
        "settledTaxAmount":{
            "type":"number",
            "description":"The amount of tax for the bill item settled by the payment."
        },
        "settledTaxedAmount":{
            "type":"number",
            "description":"The taxable amount for the bill item settled by the payment."
        },
        "settledNonTaxedAmount":{
            "type":"number",
            "description":"The nontaxable amount for the bill item settled by the payment."
        }
    },
    "description":"Affected bill items."
}