Oracle Utilities REST API for Metering and Customer Information

Get Account Financial History

get

https://server:port/spl/rest/apis/customer/financials/accountData/{accountId}/financialHistory

This operation retrieves financial history for the given Account Id.

Request

Path Parameters

accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.
Example:
```
1589800000
```

Query Parameters

endDate: string
limit: number
offset: number
startDate: string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1FinHistRes

Type: object

Show Source

account: object account
accountFinancialHistoryList: array accountFinancialHistoryList
hasMore: boolean

The hasMore element indicates whether there are more items or result records to be retrieved.

Example: false
limit: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

Limit is an integer value that specifies the paging size for number of records to return when serving a client request.

Example: 100
offset: number

Minimum Value: 0

Maximum Value: 9.99999999999999E8

The offset element is an integer value that specifies the index of the first item to be returned. The offset index begins at 0 and cannot be negative.

Example: 0
totalNumberOfRecords: number

Minimum Value: 0

Maximum Value: 99999

Total Number Of Records

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"1589800000"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"The offset element is an integer value that specifies the index of the first item to be returned. The offset index begins at 0 and cannot be negative.",
            "example":"0"
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit is an integer value that specifies the paging size for number of records to return when serving a client request.",
            "example":"100"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records"
        },
        "hasMore":{
            "type":"boolean",
            "description":"The hasMore element indicates whether there are more items or result records to be retrieved.",
            "example":"false"
        },
        "accountFinancialHistoryList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "financialTransactionType":{
                        "type":"string",
                        "maxLength":2,
                        "description":"Financial Transaction Type indicates the type of financial event: Bill Segment, Pay Segment, Bill Segment Cancellation, Pay Segment Cancellation, Adjustment, and Adjustment (Cancel).",
                        "example":"Bill Segment Cancellation"
                    },
                    "currency":{
                        "type":"object",
                        "properties":{
                            "currencyCode":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                                "example":"USD"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "primaryDescription":{
                        "type":"string",
                        "description":"(primaryDescription)"
                    },
                    "secondaryDescription":{
                        "type":"string",
                        "description":"(secondaryDescription)"
                    },
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount shows the financial event's effect on the account's current balance.",
                        "example":"-20.23"
                    },
                    "currentBalance":{
                        "type":"number",
                        "description":"Current Balance"
                    },
                    "payOffAmount":{
                        "type":"number",
                        "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
                        "example":"-20.23"
                    },
                    "payOffBalance":{
                        "type":"number",
                        "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
                        "example":"48337.45"
                    },
                    "arrearsDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Arrears Date is the date the FT starts aging.",
                        "example":"2021-01-06-00.00.00"
                    },
                    "accountingDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Accounting Date is the date the system uses to determine the FT's accounting period in your general ledger.",
                        "example":"2021-01-06-00.00.00"
                    },
                    "glExtractDate":{
                        "type":"string",
                        "format":"date",
                        "description":"GL Extract Date",
                        "example":"2014-01-13-00.00.00"
                    },
                    "bill":{
                        "type":"object",
                        "properties":{
                            "bill":{
                                "type":"object",
                                "properties":{
                                    "billId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Bill ID is the system-assigned unique identifier of the bill.",
                                        "example":"549133128888"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "billDueDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Due Date is the date on which the bill is due.",
                                "example":"1999-10-11"
                            },
                            "billPeriodStartDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date",
                                "example":"2001-01-01"
                            },
                            "billPeriodEndDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date",
                                "example":"2001-08-01"
                            },
                            "mixedPeriodIndicator":{
                                "type":"boolean",
                                "description":"mixed Period Indicator"
                            },
                            "billCancelReason":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Cancel Reason"
                            },
                            "billCancelReasonDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Cancel Reason Description"
                            }
                        }
                    },
                    "payment":{
                        "type":"object",
                        "properties":{
                            "payment":{
                                "type":"object",
                                "properties":{
                                    "paymentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
                                        "example":"025898353555"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "payTenderType":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Tender Type"
                            },
                            "payTenderTypeDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "payCancelReason":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Cancel Reason"
                            },
                            "payCancelReasonDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Cancel Reason Description"
                            }
                        }
                    },
                    "adjustment":{
                        "type":"object",
                        "properties":{
                            "adjustment":{
                                "type":"object",
                                "properties":{
                                    "adjustmentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Adjustment ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "adjustmentType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Adjustment Type"
                            },
                            "adjustmentTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Adjustment Type Description"
                            },
                            "isCalculatedAmount":{
                                "type":"boolean",
                                "description":"Calculated Amount"
                            },
                            "adjustmentCancelReason":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Cancel Reason"
                            },
                            "adjustmentCancelReasonDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Cancel Reason Description"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1FinHistRes"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId: string

Maximum Length: 10

The Account ID is a system-assigned random number that stays with an account for life.

Example: 1589800000

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589800000"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : accountFinancialHistoryList

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "financialTransactionType":{
                "type":"string",
                "maxLength":2,
                "description":"Financial Transaction Type indicates the type of financial event: Bill Segment, Pay Segment, Bill Segment Cancellation, Pay Segment Cancellation, Adjustment, and Adjustment (Cancel).",
                "example":"Bill Segment Cancellation"
            },
            "currency":{
                "type":"object",
                "properties":{
                    "currencyCode":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                        "example":"USD"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "primaryDescription":{
                "type":"string",
                "description":"(primaryDescription)"
            },
            "secondaryDescription":{
                "type":"string",
                "description":"(secondaryDescription)"
            },
            "currentAmount":{
                "type":"number",
                "description":"Current Amount shows the financial event's effect on the account's current balance.",
                "example":"-20.23"
            },
            "currentBalance":{
                "type":"number",
                "description":"Current Balance"
            },
            "payOffAmount":{
                "type":"number",
                "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
                "example":"-20.23"
            },
            "payOffBalance":{
                "type":"number",
                "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
                "example":"48337.45"
            },
            "arrearsDate":{
                "type":"string",
                "format":"date",
                "description":"Arrears Date is the date the FT starts aging.",
                "example":"2021-01-06-00.00.00"
            },
            "accountingDate":{
                "type":"string",
                "format":"date",
                "description":"Accounting Date is the date the system uses to determine the FT's accounting period in your general ledger.",
                "example":"2021-01-06-00.00.00"
            },
            "glExtractDate":{
                "type":"string",
                "format":"date",
                "description":"GL Extract Date",
                "example":"2014-01-13-00.00.00"
            },
            "bill":{
                "type":"object",
                "properties":{
                    "bill":{
                        "type":"object",
                        "properties":{
                            "billId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Bill ID is the system-assigned unique identifier of the bill.",
                                "example":"549133128888"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "billDueDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Due Date is the date on which the bill is due.",
                        "example":"1999-10-11"
                    },
                    "billPeriodStartDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date",
                        "example":"2001-01-01"
                    },
                    "billPeriodEndDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date",
                        "example":"2001-08-01"
                    },
                    "mixedPeriodIndicator":{
                        "type":"boolean",
                        "description":"mixed Period Indicator"
                    },
                    "billCancelReason":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Cancel Reason"
                    },
                    "billCancelReasonDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Cancel Reason Description"
                    }
                }
            },
            "payment":{
                "type":"object",
                "properties":{
                    "payment":{
                        "type":"object",
                        "properties":{
                            "paymentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
                                "example":"025898353555"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "payTenderType":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Tender Type"
                    },
                    "payTenderTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "payCancelReason":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Cancel Reason"
                    },
                    "payCancelReasonDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Cancel Reason Description"
                    }
                }
            },
            "adjustment":{
                "type":"object",
                "properties":{
                    "adjustment":{
                        "type":"object",
                        "properties":{
                            "adjustmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Adjustment ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "adjustmentType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Adjustment Type"
                    },
                    "adjustmentTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Adjustment Type Description"
                    },
                    "isCalculatedAmount":{
                        "type":"boolean",
                        "description":"Calculated Amount"
                    },
                    "adjustmentCancelReason":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Cancel Reason"
                    },
                    "adjustmentCancelReasonDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Cancel Reason Description"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

accountingDate: string (date)

Accounting Date is the date the system uses to determine the FT's accounting period in your general ledger.

Example: 2021-01-06-00.00.00
adjustment: object adjustment
arrearsDate: string (date)

Arrears Date is the date the FT starts aging.

Example: 2021-01-06-00.00.00
bill: object bill
currency: object currency
currentAmount: number

Current Amount shows the financial event's effect on the account's current balance.

Example: -20.23
currentBalance: number

Current Balance
financialTransactionType: string

Maximum Length: 2

Financial Transaction Type indicates the type of financial event: Bill Segment, Pay Segment, Bill Segment Cancellation, Pay Segment Cancellation, Adjustment, and Adjustment (Cancel).

Example: Bill Segment Cancellation
glExtractDate: string (date)

GL Extract Date

Example: 2014-01-13-00.00.00
payment: object payment
payOffAmount: number

Payoff Amount shows the financial event's effect on the account's payoff balance.

Example: -20.23
payOffBalance: number

Payoff Balance shows the account's payoff balance after the financial event.

Example: 48337.45
primaryDescription: string

(primaryDescription)
secondaryDescription: string

(secondaryDescription)

{
    "type":"object",
    "properties":{
        "financialTransactionType":{
            "type":"string",
            "maxLength":2,
            "description":"Financial Transaction Type indicates the type of financial event: Bill Segment, Pay Segment, Bill Segment Cancellation, Pay Segment Cancellation, Adjustment, and Adjustment (Cancel).",
            "example":"Bill Segment Cancellation"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currencyCode":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "example":"USD"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "primaryDescription":{
            "type":"string",
            "description":"(primaryDescription)"
        },
        "secondaryDescription":{
            "type":"string",
            "description":"(secondaryDescription)"
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount shows the financial event's effect on the account's current balance.",
            "example":"-20.23"
        },
        "currentBalance":{
            "type":"number",
            "description":"Current Balance"
        },
        "payOffAmount":{
            "type":"number",
            "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
            "example":"-20.23"
        },
        "payOffBalance":{
            "type":"number",
            "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
            "example":"48337.45"
        },
        "arrearsDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date is the date the FT starts aging.",
            "example":"2021-01-06-00.00.00"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date is the date the system uses to determine the FT's accounting period in your general ledger.",
            "example":"2021-01-06-00.00.00"
        },
        "glExtractDate":{
            "type":"string",
            "format":"date",
            "description":"GL Extract Date",
            "example":"2014-01-13-00.00.00"
        },
        "bill":{
            "type":"object",
            "properties":{
                "bill":{
                    "type":"object",
                    "properties":{
                        "billId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Bill ID is the system-assigned unique identifier of the bill.",
                            "example":"549133128888"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "billDueDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Due Date is the date on which the bill is due.",
                    "example":"1999-10-11"
                },
                "billPeriodStartDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Start Date",
                    "example":"2001-01-01"
                },
                "billPeriodEndDate":{
                    "type":"string",
                    "format":"date",
                    "description":"End Date",
                    "example":"2001-08-01"
                },
                "mixedPeriodIndicator":{
                    "type":"boolean",
                    "description":"mixed Period Indicator"
                },
                "billCancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason"
                },
                "billCancelReasonDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Cancel Reason Description"
                }
            }
        },
        "payment":{
            "type":"object",
            "properties":{
                "payment":{
                    "type":"object",
                    "properties":{
                        "paymentId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
                            "example":"025898353555"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "payTenderType":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Tender Type"
                },
                "payTenderTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "payCancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason"
                },
                "payCancelReasonDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Cancel Reason Description"
                }
            }
        },
        "adjustment":{
            "type":"object",
            "properties":{
                "adjustment":{
                    "type":"object",
                    "properties":{
                        "adjustmentId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Adjustment ID"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "adjustmentType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Adjustment Type"
                },
                "adjustmentTypeDescription":{
                    "type":"string",
                    "maxLength":150,
                    "description":"Adjustment Type Description"
                },
                "isCalculatedAmount":{
                    "type":"boolean",
                    "description":"Calculated Amount"
                },
                "adjustmentCancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason"
                },
                "adjustmentCancelReasonDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Cancel Reason Description"
                }
            }
        }
    }
}

Nested Schema : adjustment

Type: object

Show Source

adjustment: object adjustment
adjustmentCancelReason: string

Maximum Length: 4

Cancel Reason
adjustmentCancelReasonDescription: string

Maximum Length: 100

Cancel Reason Description
adjustmentType: string

Maximum Length: 8

Adjustment Type
adjustmentTypeDescription: string

Maximum Length: 150

Adjustment Type Description
isCalculatedAmount: boolean

Calculated Amount

{
    "type":"object",
    "properties":{
        "adjustment":{
            "type":"object",
            "properties":{
                "adjustmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Adjustment ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "adjustmentType":{
            "type":"string",
            "maxLength":8,
            "description":"Adjustment Type"
        },
        "adjustmentTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Adjustment Type Description"
        },
        "isCalculatedAmount":{
            "type":"boolean",
            "description":"Calculated Amount"
        },
        "adjustmentCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        },
        "adjustmentCancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

bill: object bill
billCancelReason: string

Maximum Length: 4

Cancel Reason
billCancelReasonDescription: string

Maximum Length: 100

Cancel Reason Description
billDueDate: string (date)

Due Date is the date on which the bill is due.

Example: 1999-10-11
billPeriodEndDate: string (date)

End Date

Example: 2001-08-01
billPeriodStartDate: string (date)

Start Date

Example: 2001-01-01
mixedPeriodIndicator: boolean

mixed Period Indicator

{
    "type":"object",
    "properties":{
        "bill":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill ID is the system-assigned unique identifier of the bill.",
                    "example":"549133128888"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billDueDate":{
            "type":"string",
            "format":"date",
            "description":"Due Date is the date on which the bill is due.",
            "example":"1999-10-11"
        },
        "billPeriodStartDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date",
            "example":"2001-01-01"
        },
        "billPeriodEndDate":{
            "type":"string",
            "format":"date",
            "description":"End Date",
            "example":"2001-08-01"
        },
        "mixedPeriodIndicator":{
            "type":"boolean",
            "description":"mixed Period Indicator"
        },
        "billCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        },
        "billCancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

_link: string

_link
currencyCode: string

Maximum Length: 3

Currency Code defines the currency in which the account's financial transactions are expressed.

Example: USD

{
    "type":"object",
    "properties":{
        "currencyCode":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "example":"USD"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payment

Type: object

Show Source

payCancelReason: string

Maximum Length: 4

Cancel Reason
payCancelReasonDescription: string

Maximum Length: 100

Cancel Reason Description
payment: object payment
payTenderType: string

Maximum Length: 4

Tender Type
payTenderTypeDescription: string

Maximum Length: 60

Description

{
    "type":"object",
    "properties":{
        "payment":{
            "type":"object",
            "properties":{
                "paymentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
                    "example":"025898353555"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "payTenderType":{
            "type":"string",
            "maxLength":4,
            "description":"Tender Type"
        },
        "payTenderTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "payCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        },
        "payCancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description"
        }
    }
}

Nested Schema : adjustment

Type: object

Show Source

_link: string

_link
adjustmentId: string

Maximum Length: 12

Adjustment ID

{
    "type":"object",
    "properties":{
        "adjustmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Adjustment ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

_link: string

_link
billId: string

Maximum Length: 12

Bill ID is the system-assigned unique identifier of the bill.

Example: 549133128888

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill ID is the system-assigned unique identifier of the bill.",
            "example":"549133128888"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payment

Type: object

Show Source

_link: string

_link
paymentId: string

Maximum Length: 12

Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.

Example: 025898353555

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
            "example":"025898353555"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

400 Response

Bad Request

Root Schema : problemDetailDocument

Type: object

Show Source

detail: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
httpStatus: number

Minimum Value: 0

Maximum Value: 9999

The HTTP Status code for the error.
problemInstance: string

Maximum Length: 60

Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
problemType: string

Maximum Length: 60

URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
serverMessage: object serverMessage
stackTrace: string

Maximum Length: 60

The stack trace shows where the error occurs during the execution of a program.
title: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

callSequence: string

Maximum Length: 60

Delimited sequence of programs called.
longDescription: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
messageCategory: number

Minimum Value: 0

Maximum Value: 0

Message Category within Oracle Utilities Application Framework.
messageNbr: number

Minimum Value: -99999

Maximum Value: 99999

Message Number within Oracle Utilities Application Framework.
messageText: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
programName: string

Maximum Length: 60

Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

detail: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
httpStatus: number

Minimum Value: 0

Maximum Value: 9999

The HTTP Status code for the error.
problemInstance: string

Maximum Length: 60

Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
problemType: string

Maximum Length: 60

URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
serverMessage: object serverMessage
stackTrace: string

Maximum Length: 60

The stack trace shows where the error occurs during the execution of a program.
title: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

callSequence: string

Maximum Length: 60

Delimited sequence of programs called.
longDescription: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
messageCategory: number

Minimum Value: 0

Maximum Value: 0

Message Category within Oracle Utilities Application Framework.
messageNbr: number

Minimum Value: -99999

Maximum Value: 99999

Message Number within Oracle Utilities Application Framework.
messageText: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
programName: string

Maximum Length: 60

Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}