Jump to

• Request
• Response

Get Account Collection Details

get

/rest/apis/customer/financials/accountData/{accountId}/collectionDetails

Request

Path Parameters

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

  Example:

  1589800000

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 : C1AcctCollDe

Type: object

Show Source

• accountId: object accountId
  The Account ID is a system-assigned random number that stays with an account for life.
• accountName: string
  Maximum Length: 254

  Name
• collectionsActive: boolean
  When defined as true, indicates that there are active collections or overdue processes on the account.

  Example: false
• collectionsAmounts: object collectionsAmounts
• collectionsEntities: array collectionsEntities
• collectionsInitialDate: string (date)
  Initial Collection Date if there are active Severance Processes.
• creditRating: number
  Minimum Value: -99999

  Maximum Value: 99999

  A Credit Rating is an evaluation of the credit risk of a customer based on their payment history. An account's Credit Rating is equal to the start credit rating value defined on the system installation plus the sum of credit rating demerits that are currently in effect.

  Example: 800
• currency: object currency
  Currency Code defines the currency in which the account's financial transactions are expressed.
• disconnectInformation: object disconnectInformation
• lastPayment: object lastPayment
• scheduledPayments: array scheduledPayments
• systemTimeZoneName: string
  Maximum Length: 50

  The name of the time zone that is used by the system installation.

  Example: US/Pacific

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"object",
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "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"
                }
            }
        },
        "accountName":{
            "type":"string",
            "maxLength":"254",
            "description":"Name"
        },
        "currency":{
            "type":"object",
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "properties":{
                "currency":{
                    "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"
                }
            }
        },
        "creditRating":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"A Credit Rating is an evaluation of the credit risk of a customer based on their payment history.  An account's Credit Rating is equal to the start credit rating value defined on the system installation plus the sum of credit rating demerits that are currently in effect.",
            "example":"800"
        },
        "systemTimeZoneName":{
            "type":"string",
            "maxLength":"50",
            "description":"The name of the time zone that is used by the system installation.",
            "example":"US/Pacific"
        },
        "collectionsActive":{
            "type":"boolean",
            "description":"When defined as true, indicates that there are active collections or overdue processes on the account.",
            "example":"false"
        },
        "collectionsInitialDate":{
            "type":"string",
            "format":"date",
            "description":"Initial Collection Date if there are active Severance Processes."
        },
        "collectionsAmounts":{
            "type":"object",
            "properties":{
                "collectionsInitialAmount":{
                    "type":"number",
                    "description":"Initial Collection Amount from the Collection Process or Overdue Process."
                },
                "collectionsTotalAmount":{
                    "type":"number",
                    "description":"Collection Total Amount for the account.",
                    "example":"30"
                },
                "collectionsMinimumAmount":{
                    "type":"number",
                    "description":"Collection Minimum Amount for the account.",
                    "example":"20"
                },
                "calculationDatetime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The last time that the system evaluated the collections amounts for the account.",
                    "example":"2024-01-01T00:00:00-08:00"
                }
            }
        },
        "disconnectInformation":{
            "type":"object",
            "properties":{
                "disconnectActive":{
                    "type":"boolean",
                    "description":"When defined as true, indicates that the account is disconnected.",
                    "example":"true"
                },
                "disconnectStartDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The disconnect start date for an account. A blank date indicates that the account is not scheduled for or has completed a disconnection.",
                    "example":"2022-11-04"
                }
            }
        },
        "collectionsEntities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "entityType":{
                        "type":"string",
                        "maxLength":"4",
                        "description":"Object reference to the type of collection record that is active such as 'COLL PROC', 'SEV PROC', 'C1-OD-PROC'.",
                        "example":"COLL PROC"
                    },
                    "pkValue1":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Primary Key Value 1 as a unique identifier of the object record indicated by the entity type.",
                        "example":"0275450563"
                    }
                }
            }
        },
        "lastPayment":{
            "type":"object",
            "properties":{
                "paymentAmount":{
                    "type":"number",
                    "description":"Payment Amount is the amount of the payment.",
                    "example":"1"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Payment date",
                    "example":"2021-06-08"
                }
            }
        },
        "scheduledPayments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "scheduledPaymentDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Date for for future scheduled payment for the payee account from self-service task.",
                        "example":"2023-02-10"
                    },
                    "scheduledPaymentAmount":{
                        "type":"number",
                        "description":"Amount for for future scheduled payment from self-service task.",
                        "example":"50.00"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1AcctCollDe"
    }
}

Nested Schema : accountId

Type: object

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

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",
    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
    "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 : collectionsAmounts

Type: object

Show Source

• calculationDatetime: string (date-time)
  The last time that the system evaluated the collections amounts for the account.

  Example: 2024-01-01T00:00:00-08:00
• collectionsInitialAmount: number
  Initial Collection Amount from the Collection Process or Overdue Process.
• collectionsMinimumAmount: number
  Collection Minimum Amount for the account.

  Example: 20
• collectionsTotalAmount: number
  Collection Total Amount for the account.

  Example: 30

{
    "type":"object",
    "properties":{
        "collectionsInitialAmount":{
            "type":"number",
            "description":"Initial Collection Amount from the Collection Process or Overdue Process."
        },
        "collectionsTotalAmount":{
            "type":"number",
            "description":"Collection Total Amount for the account.",
            "example":"30"
        },
        "collectionsMinimumAmount":{
            "type":"number",
            "description":"Collection Minimum Amount for the account.",
            "example":"20"
        },
        "calculationDatetime":{
            "type":"string",
            "format":"date-time",
            "description":"The last time that the system evaluated the collections amounts for the account.",
            "example":"2024-01-01T00:00:00-08:00"
        }
    }
}

Nested Schema : collectionsEntities

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entityType":{
                "type":"string",
                "maxLength":"4",
                "description":"Object reference to the type of collection record that is active such as 'COLL PROC', 'SEV PROC', 'C1-OD-PROC'.",
                "example":"COLL PROC"
            },
            "pkValue1":{
                "type":"string",
                "maxLength":"254",
                "description":"Primary Key Value 1 as a unique identifier of the object record indicated by the entity type.",
                "example":"0275450563"
            }
        }
    }
}

Nested Schema : currency

Type: object

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

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

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

  Example: USD

{
    "type":"object",
    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
    "properties":{
        "currency":{
            "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 : disconnectInformation

Type: object

Show Source

• disconnectActive: boolean
  When defined as true, indicates that the account is disconnected.

  Example: true
• disconnectStartDate: string (date)
  The disconnect start date for an account. A blank date indicates that the account is not scheduled for or has completed a disconnection.

  Example: 2022-11-04

{
    "type":"object",
    "properties":{
        "disconnectActive":{
            "type":"boolean",
            "description":"When defined as true, indicates that the account is disconnected.",
            "example":"true"
        },
        "disconnectStartDate":{
            "type":"string",
            "format":"date",
            "description":"The disconnect start date for an account. A blank date indicates that the account is not scheduled for or has completed a disconnection.",
            "example":"2022-11-04"
        }
    }
}

Nested Schema : lastPayment

Type: object

Show Source

• paymentAmount: number
  Payment Amount is the amount of the payment.

  Example: 1
• paymentDate: string (date)
  Payment date

  Example: 2021-06-08

{
    "type":"object",
    "properties":{
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount is the amount of the payment.",
            "example":"1"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment date",
            "example":"2021-06-08"
        }
    }
}

Nested Schema : scheduledPayments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "scheduledPaymentDate":{
                "type":"string",
                "format":"date",
                "description":"Date for for future scheduled payment for the payee account from self-service task.",
                "example":"2023-02-10"
            },
            "scheduledPaymentAmount":{
                "type":"number",
                "description":"Amount for for future scheduled payment from self-service task.",
                "example":"50.00"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• entityType: string
  Maximum Length: 4

  Object reference to the type of collection record that is active such as 'COLL PROC', 'SEV PROC', 'C1-OD-PROC'.

  Example: COLL PROC
• pkValue1: string
  Maximum Length: 254

  Primary Key Value 1 as a unique identifier of the object record indicated by the entity type.

  Example: 0275450563

{
    "type":"object",
    "properties":{
        "entityType":{
            "type":"string",
            "maxLength":"4",
            "description":"Object reference to the type of collection record that is active such as 'COLL PROC', 'SEV PROC', 'C1-OD-PROC'.",
            "example":"COLL PROC"
        },
        "pkValue1":{
            "type":"string",
            "maxLength":"254",
            "description":"Primary Key Value 1 as a unique identifier of the object record indicated by the entity type.",
            "example":"0275450563"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• scheduledPaymentAmount: number
  Amount for for future scheduled payment from self-service task.

  Example: 50.00
• scheduledPaymentDate: string (date)
  Date for for future scheduled payment for the payee account from self-service task.

  Example: 2023-02-10

{
    "type":"object",
    "properties":{
        "scheduledPaymentDate":{
            "type":"string",
            "format":"date",
            "description":"Date for for future scheduled payment for the payee account from self-service task.",
            "example":"2023-02-10"
        },
        "scheduledPaymentAmount":{
            "type":"number",
            "description":"Amount for for future scheduled payment from self-service task.",
            "example":"50.00"
        }
    }
}

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