Jump to

• Request
• Response

Get Account Financial History

get

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

This operation handles the Integration Suite API to Get Account Financial History

Request

Path Parameters

• accountId(required): string

Query Parameters

• limit: number
• offset: number
• searchBy: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-GtFAcFHis

Type: object

Show Source

• _self: string
  _self
• account: object account
• accountFinancialHistoryList: object accountFinancialHistoryList
• count: number
  Minimum Value: 0

  Maximum Value: 0

  The count element is an integer value that specifies the actual number of items contained in the paging response.

  Example: 18
• hasMore: boolean
  The hasMore element is a Boolean value that indicates whether there are more items/result records to be retrieved.

  Example: false
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  The Limit element 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
• searchBy: string
  Maximum Length: 10

  Search By
• totalResult: number
  Minimum Value: 0

  Maximum Value: 0

  This element is an integer value that specifies the total number of the resource instances, including instances in the current response, as well as instances that have not been fetched.

  Example: 18

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"1589800000"
                }
            }
        },
        "searchBy":{
            "type":"string",
            "maxLength":10,
            "description":"Search By"
        },
        "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":"The Limit element is an integer value that specifies the paging size for number of records to return when serving a client request.",
            "example":"100"
        },
        "totalResult":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"This element is an integer value that specifies the total number of the resource instances, including instances in the current response, as well as instances that have not been fetched.",
            "example":"18"
        },
        "hasMore":{
            "type":"boolean",
            "description":"The hasMore element is a Boolean value that indicates whether there are more items/result records to be retrieved.",
            "example":"false"
        },
        "count":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"The count element is an integer value that specifies the actual number of items contained in the paging response.",
            "example":"18"
        },
        "accountFinancialHistoryList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "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"
                            },
                            "arrearsDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Arrears Date is the date the FT starts aging.",
                                "example":"2021-01-06-00.00.00"
                            },
                            "glExtractDate":{
                                "type":"string",
                                "format":"date",
                                "description":"GL Extract Date",
                                "example":"2014-01-13-00.00.00"
                            },
                            "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"
                            },
                            "bill":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "billId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Bill Segment ID"
                                    }
                                }
                            },
                            "payment":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "paymentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Bill Segment ID"
                                    }
                                }
                            },
                            "currentAmount":{
                                "type":"string",
                                "maxLength":15,
                                "description":"Current Amount shows the financial event's effect on the account's current balance.",
                                "example":"-20.23"
                            },
                            "currentBalance":{
                                "type":"string",
                                "maxLength":15,
                                "description":"Current Balance shows the account's current balance after the financial event.",
                                "example":"-128.42"
                            },
                            "payOffAmount":{
                                "type":"string",
                                "maxLength":1,
                                "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
                                "example":"-20.23"
                            },
                            "payOffBalance":{
                                "type":"string",
                                "maxLength":15,
                                "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
                                "example":"-128.42"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-GtFAcFHis"
    }
}

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":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589800000"
        }
    }
}

Nested Schema : accountFinancialHistoryList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "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"
                    },
                    "arrearsDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Arrears Date is the date the FT starts aging.",
                        "example":"2021-01-06-00.00.00"
                    },
                    "glExtractDate":{
                        "type":"string",
                        "format":"date",
                        "description":"GL Extract Date",
                        "example":"2014-01-13-00.00.00"
                    },
                    "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"
                    },
                    "bill":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "billId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Bill Segment ID"
                            }
                        }
                    },
                    "payment":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "paymentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Bill Segment ID"
                            }
                        }
                    },
                    "currentAmount":{
                        "type":"string",
                        "maxLength":15,
                        "description":"Current Amount shows the financial event's effect on the account's current balance.",
                        "example":"-20.23"
                    },
                    "currentBalance":{
                        "type":"string",
                        "maxLength":15,
                        "description":"Current Balance shows the account's current balance after the financial event.",
                        "example":"-128.42"
                    },
                    "payOffAmount":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
                        "example":"-20.23"
                    },
                    "payOffBalance":{
                        "type":"string",
                        "maxLength":15,
                        "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
                        "example":"-128.42"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "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"
            },
            "arrearsDate":{
                "type":"string",
                "format":"date",
                "description":"Arrears Date is the date the FT starts aging.",
                "example":"2021-01-06-00.00.00"
            },
            "glExtractDate":{
                "type":"string",
                "format":"date",
                "description":"GL Extract Date",
                "example":"2014-01-13-00.00.00"
            },
            "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"
            },
            "bill":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "billId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Bill Segment ID"
                    }
                }
            },
            "payment":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "paymentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Bill Segment ID"
                    }
                }
            },
            "currentAmount":{
                "type":"string",
                "maxLength":15,
                "description":"Current Amount shows the financial event's effect on the account's current balance.",
                "example":"-20.23"
            },
            "currentBalance":{
                "type":"string",
                "maxLength":15,
                "description":"Current Balance shows the account's current balance after the financial event.",
                "example":"-128.42"
            },
            "payOffAmount":{
                "type":"string",
                "maxLength":1,
                "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
                "example":"-20.23"
            },
            "payOffBalance":{
                "type":"string",
                "maxLength":15,
                "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
                "example":"-128.42"
            }
        }
    }
}

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
• arrearsDate: string (date)
  Arrears Date is the date the FT starts aging.

  Example: 2021-01-06-00.00.00
• bill: object bill
• currentAmount: string
  Maximum Length: 15

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

  Example: -20.23
• currentBalance: string
  Maximum Length: 15

  Current Balance shows the account's current balance after the financial event.

  Example: -128.42
• 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: string
  Maximum Length: 1

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

  Example: -20.23
• payOffBalance: string
  Maximum Length: 15

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

  Example: -128.42

{
    "type":"object",
    "properties":{
        "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"
        },
        "arrearsDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date is the date the FT starts aging.",
            "example":"2021-01-06-00.00.00"
        },
        "glExtractDate":{
            "type":"string",
            "format":"date",
            "description":"GL Extract Date",
            "example":"2014-01-13-00.00.00"
        },
        "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"
        },
        "bill":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "billId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill Segment ID"
                }
            }
        },
        "payment":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "paymentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill Segment ID"
                }
            }
        },
        "currentAmount":{
            "type":"string",
            "maxLength":15,
            "description":"Current Amount shows the financial event's effect on the account's current balance.",
            "example":"-20.23"
        },
        "currentBalance":{
            "type":"string",
            "maxLength":15,
            "description":"Current Balance shows the account's current balance after the financial event.",
            "example":"-128.42"
        },
        "payOffAmount":{
            "type":"string",
            "maxLength":1,
            "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
            "example":"-20.23"
        },
        "payOffBalance":{
            "type":"string",
            "maxLength":15,
            "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
            "example":"-128.42"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

• _link: string
  _link
• billId: string
  Maximum Length: 12

  Bill Segment ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "billId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill Segment ID"
        }
    }
}

Nested Schema : payment

Type: object

Show Source

• _link: string
  _link
• paymentId: string
  Maximum Length: 12

  Bill Segment ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill Segment ID"
        }
    }
}

400 Response

Bad Request

Body ()

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

Body ()

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."
        }
    }
}

Back to Top