Table of Contents

• About the REST APIs
• All REST Endpoints

Tasks

• Activity Services
  • Activity Service
    • Add New Activity
    • Delete Activity Identified by Given ID
    • Get Additional Account Information by Account ID
    • Healthcheck of Activity Service
    • Retrieve Activity by ID
    • Retrieve Activity by ID and Activity Type
    • Retrieve List of Activities by Account ID
    • Retrieve List of Activities by Filters
    • Retrieve List of Activities with Distinct Users by Account ID
    • Retrieve List of Existing Activities
    • Update Existing Activity
• Call Action Services
  • Call Action Collector Dashboard Service
    • Fetch Action Results based on TaskId
    • Retrieve the count of Call Action Results
  • Call Action Maintenance Service
    • Add a New Call Action
    • Authorize the Call Action by given ID
    • Close the Call Action by given ID
    • Delete the Call Action identified by given ID
    • Get all Valid Call Action
    • Reopen the Call Action by given ID
    • Retrieve the Call Action by ID
    • Retrieve the Call Action Maintenance History by given ID
    • Retrieve the Unauthorized Call Action by given ID
    • Update an existing Call Action
  • Call Action Transaction Service
    • Add a New Call Action followup record
    • End collection status on an account
    • Fetch details of Call Summary
    • Restore closed collection status on an account
    • Retrieve all open and close existing collection status based on an account ID
    • Retrieve count of call actions based on call type
    • Retrieve specialised status updates on call account ID
    • Retrieve the action details based on segment code
    • Retrieve the action history details based on Task ID
    • Retrieve the existing collection status based on account ID
    • Retrieve the value of all the facts for batches
    • Update the specialised status
• Common Services
  • Fact Details Service
    • Retrieve Fact Details by Account ID
    • Retrieve Fact Details by Category
  • Identifier Definition Service
    • Add New Identifier Definition
    • Authorize Identifier Definition by Given ID
    • Close Identifier Definition by Given ID
    • Delete Identifier Definition Identified by Given ID
    • Fetch Identifier Definition and Parameters Configuration for Given Criteria
    • Generate Number for Given Criteria
    • Get All Valid Identifier Definition
    • Reopen Identifier Definition by Given ID
    • Retrieve Identifier Definition by Given ID
    • Retrieve Identifier Definition by ID
    • Retrieve Identifier Definition History by Given ID
    • Update Existing Identifier Definition
  • Lookup Type Service
    • Add New Lookup Type
    • Authorize Lookup Type by Given ID
    • Close Lookup Type by Given ID
    • Delete Lookup Type Identified by Given ID
    • Get All Valid Lookup Type
    • Reopen Lookup Type by Given ID
    • Retrieve All Unauthorized Records for Lookup Type by Given ID
    • Retrieve History of Lookup Type by Given ID
    • Retrieve Lookup Codes by Given Lookup Type
    • Retrieve Lookup Type by ID
    • Update Existing Lookup Type
  • Product Processor Service
    • Add New Product Processor
    • Authorize Product Processor by Given ID
    • Close Product Processor by Given ID
    • Delete Product Processor Identified by Given ID
    • Get All Valid Product Processors
    • Health Check Of Common Services
    • Reopen Product Processor by Given ID
    • Retrieve All Unauthorized Records of Product Processor by Given ID
    • Retrieve Group Basis Code and Product Processor Code for All Product Processors
    • Retrieve Product Processor by ID
    • Retrieve Product Processor History by Given ID
    • Update Existing Product Processor
• Correspondence Services
  • Communication Details Service
    • Fetch contents of a document in Base 64 format
    • Fetch details of all Inbound Document uploaded
    • Fetch Manual Communication Details
    • Get All count of case history details
    • Get All count of communication details
    • Get Manual Communication History
    • Get settlement related details.
    • Send Manual Communication
    • Upload Inbound Document
    • Validate Block Period for Manual Communication
  • Communication Template Maintenance Service
    • Add New Communication Template
    • Authorize Communication Template by Given ID
    • Close Communication Template by Given ID
    • Delete Communication Template Identified by Given ID
    • Get All Valid Communication Template
    • Healthcheck of Correspondence Service
    • Reopen Communication Template by Given ID
    • Retrieve Communication Template by ID
    • Retrieve Communication Template History by Given ID
    • Retrieve Onload Data
    • Retrieve Unauthorized Communication Template by Given ID
    • Update Existing Communication Template
  • Correspondence Batch Service
    • Generate Report.
• Dashboard Services
  • Dashboard Service
    • Get no of accounts handled
• Data Exchange Services
  • Data Exchange Service
    • Fetch Dialer Record
• Entity Services
  • Account Arrears Service
    • Update arrear details for an existing account
  • Account Bill Details Service
    • Update existing account Bill Details
  • Account Delinquency History Service
    • Add Case ID for delinquent accounts
    • Retrieves account history filtered by collection end date
    • Retrieves the list of existing account delinquency history.
  • Account Party Relationship Service
    • Retrieve Account Party Relationship for given Account ID
    • Retrieve all Accounts for given Party ID
    • Retrieve the email id list of Party by Account ID
    • Retrieve the list of Party by Account ID
    • Update an Existing Account Party Relationship
  • Account Payment Service
    • Get all payments details for an account after a specified date
    • Get payment details based on Account ID
    • Get payment details based on Account ID and date filter
    • Update existing payment details
  • Account Repayment Schedule Service
    • Update existing account repayment schedule
  • Account Review Service
    • Retrieve List of Existing Account Review Details Based on Review Date.
    • Update Existing Review Details of Account
  • Account Service
    • Retrieve the account ID for the given account number.
    • Retrieve the count of accounts obtained in the result specific to task summary account.
    • Retrieve the list of account party details by account IDs and relevant filters.
    • Retrieve the list of all unallocated accounts
    • Retrieve the list of all fact values associated with entities
    • Retrieve the list of in collections account IDs
    • Retrieves the account details based on the provided account ID.
    • Retrieves the account details for dialer batches.
    • Retrieves the account details using the provided account ID
    • Retrieves the account ID based on the provided account number and product processor code
    • Retrieves the group basis using the provided Account ID.
    • Set Allocation flag for the given account ID
    • Update existing account
  • Agent View Party Service
    • Get all Existing Party Details by Account ID.
  • Case Service Summary
    • Get all account details by Account ID
    • Get all customer details by Party ID
  • Collateral Charge Service
    • Update Existing Collateral Charge Details
  • Collateral Linkage Service
    • Update Existing Collateral Linkage
  • Collateral Owner Service
    • Update Existing Collateral Owner
  • Collateral Service
    • Get existing collateral details based on the account ID
    • Update existing collateral details
  • Feed Entity Service
    • Add New Feed Entity
    • Update Account Arrears Entity
    • Update Account Bill Details Entity
    • Update Account Entity
    • Update Account Party Entity
    • Update Account Repayment Schedule Entity
    • Update Collateral Charge Entity
    • Update Collateral Entity
    • Update Collateral Linkage Entity
    • Update Collateral Owner Entity
    • Update Insurance Entity
    • Update Party Address Entity
    • Update Party Contact Entity
    • Update Party Employment Entity
    • Update Party Entity
    • Update Party Identity Entity
    • Update Party Name Entity
    • Update Payment Entity
    • Update Risk Indicator Entity
  • Insurance Service
    • Update Existing Insurance
  • Party Address Service
    • Update Existing Party Address
  • Party Contact Service
    • Update Existing Party Contact
  • Party Employment Service
    • Update Existing Party Employment Details
  • Party Identity Service
    • Update Existing Party Identity Details
  • Party Name Service
    • Update Existing Party Name Details
  • Party Service
    • Retrieve Party ID, Customer Number, and Party Name for LOV Component
    • Update Existing Party
  • Risk Indicator Service
    • Update Existing Risk Indicator
  • Seed Data Configuration Service
    • Add New Seed Data Configuration
    • Authorize Seed Data Configuration by Given ID
    • Close Seed Data Configuration by Given ID
    • Delete Seed Data Configuration Identified by Given ID
    • Get All Valid Seed Data Configuration
    • Health Check of Entity Service
    • Reopen Seed Data Configuration by Given ID
    • Retrieve Seed Data Configuration by Given ID
    • Retrieve Seed Data Configuration by Given ID
    • Retrieve Seed Data Configuration by ID
    • Retrieve Seed Detail Description by Given Seed Type Code and Seed Code
    • Update Existing Seed Data Configuration
• Fees Charges Services
  • Fees Charges Batch Services
    • Health Check of Fees and Charges Batch Service
  • Fees Charges Maintenance Services
    • Adds a new feecharge.
    • Authorize the feecharge by given ID.
    • Close the feecharge by given ID.
    • Deletes the feecharge identified by given ID.
    • Get all valid feecharge.
    • reopen the feecharge by given ID.
    • Retrieves the feecharge by ID.
    • Retrives the feecharge by given ID.
    • Retrives the feecharge by given ID.
    • Update an existing feecharge.
  • Fees Charges Transaction Services
    • Retrieves the feeschargesaccountasso by Account Id.
    • Update Fees and Charges Association History and Delete Fees and Charges Association
• Notes Services
  • Notes Service
    • Add a New Note
    • Add mapping between Action ID and Account ID
    • Get Additional Account Information by Account ID
    • Get Behavior Details by Account ID
    • Get Compliance by Action ID
    • Get Notes by Action ID
    • Health Check of notes service
    • Retrieves Notes Details by Account ID
• Promise to Pay Services
  • Promise to Pay Collector Dashboard Service
    • Display Collection history promise detail by user id
    • Get all PTP related KPI information
  • Promise to Pay Maintenance Service
    • Add New Promise to Pay Type
    • Authorize Promise to Pay Type by Given ID
    • Close Promise to Pay Type by Given ID
    • Delete Promise to Pay Type Identified by Given ID
    • Get All Valid Promise to Pay Type
    • Reopen Promise to Pay Type by Given ID
    • Retrieve Promise to Pay Type by Given ID
    • Retrieve Promise to Pay Type by ID
    • Retrieve Promise to Pay Type History by Given ID
    • Update Existing Promise to Pay Type
  • Promise to Pay Transaction Service
    • Add a new promise
    • Add a new Promise to pay
    • Appropriate Payment Against promise
    • Cancel promise with Reason and Notes
    • Cancel PTPs by Account ID
    • Display upcoming promise detail by user id
    • Fetch Earliest promise details for Dialer batch.
    • Fetch promise and its history using promise Id.
    • Fetch PTP and its history using account number.
    • Get Additional Account Information by Account ID
    • Get All promise Detail by Account ID
    • Get promise History based on account id and case id
    • Get Status Count for Each Status
    • Health Check of promise Service
    • Retrieve Quick promise by Account ID
    • Simulates a New Promise Schedule
• Segmentation Services
  • Segment Maintenance Service
    • Health Check of Segmentation Batch Service
    • Retrieve All Segment Related Facts Values
    • Retrieve List of Segment And Strategy Associated with an Account
    • Retrieve List of Segments Associated with an List of Account ID
    • Retrieve the Segment based on Account ID
    • Retrieve the Segment based on Account ID and Case ID
    • Update Segment Associated and Delete Segment Association History
    • Update Segment Association History and Delete Segment Association
  • Segmentation Batch Service
    • Health Check of Segmentation Batch Service
• Settlement Services
  • Settlement Batch Service
    • Health Check of Settlement Batch Service
    • Retrieve the value of all the facts for batches
  • Settlement Service
    • Get Settlement Details By AccountId
    • Save settlement initiation details
    • Save Settlement Offer Details
    • Update an Existing Offer Status
• Strategy Services
  • Case Account Association Service
    • Add New Case Account Association
    • Delete Case Account Association and Insert in Case Account Association History
    • Delete Case Account Association Identified by the Given ID
    • Retrieve Case Account Association by ID
    • Retrieve List of Existing Case Account Associations
    • Update Existing Case Account Association
  • Case Service
    • Get Case Id from Case Number
    • Get Party Id from Case No
  • Fact Service
    • Retrieve List of All Fact Value for Batch
  • Strategy Maintenance Service
    • Add New Strategy
    • Authorize Strategy by Given ID
    • Close Strategy by Given ID
    • Delete Strategy Identified by Given ID
    • Get All Valid Strategies
    • Reopen Strategy by Given ID
    • Retrieve Strategy by Given ID
    • Retrieve Strategy by Given ID
    • Retrieve the Strategy by ID
    • Retrieve Workflow Status by Given Workflow code.
    • Update Existing Strategy
  • Strategy service
    • Health Check of Strategy Services
  • Task Type Service
    • Add New Task Type
    • Authorize Task Type by Given ID
    • Close Task Type by Given ID
    • Delete Task Type Identified by Given ID
    • Get All Valid Task Type
    • Reopen Task Type by Given ID
    • Retrieve Task Type by ID
    • Retrieve Task Type History by Given ID
    • Retrieve Unauthorized Task Type by Given ID
    • Update Existing Task Type
• Task Workflow Services
  • Ad Hoc Task Service
    • Retrieve Ad hoc Task Onload
    • Save Ad hoc Task Data
  • Collector Dashboard Service
    • Get all segments associated with the logged in user
    • Get all task related KPI information
    • Get task Count based on the age of tasks
    • Get task Count of all tasks associated with logged in user
    • Get task history data
  • Task Summary Service
    • Escalate Tasks By Task ID
    • Get all Accounts with Open/WIP tasks.
    • Get All count of Communication History details
    • Get all task details associated with Ai User Id
    • Get Existing Created Flag Details or Create/Update Flag Details for specific task
    • Get Initial or Filtered Task Summary for Account
    • Get Initial or Filtered Task Summary for Specialized Cases
    • Get Initial or Filtered Task Summary for Task
    • Get the Users Assigned if the Logged in User is a Supervisor
    • Reassign Accounts Based on Segment Codes
    • Reassign Accounts Based on Segment Codes
  • Task Workflow Batch Service
    • Get filtered Task details
    • Get Task Details Based on Task ID
    • Get Task Status
    • Get Work Flow Status
    • Remove Task for given Account ID
    • Update Assignee for Task
    • Update Task Status and Followup Date
  • Task Workflow Maintenance Service
    • Add New Task Workflow
    • Authorize Task Workflow by Given ID
    • Close Task Workflow by Given ID
    • Delete Task Workflow Identified by Given ID
    • Get All Valid Task Workflow
    • Reopen Task Workflow by Given ID
    • Retrieve Task Workflow by ID
    • Retrieve Task Workflow History by Given ID
    • Retrieve Unauthorized Task Workflow by Given ID
    • Update Existing Task Workflow
• User Management Services
  • User Assignment Maintenance Service
    • Add a New User Assignment
    • Authorize The user assignment By Given ID
    • Close The user assignment By Given ID
    • Delete The user assignment Identified By Given ID
    • Get All Valid User Assignment
    • Health Check Of User Management Service
    • Reopen The user assignment By Given ID
    • Retrieve The user assignment By Given ID
    • Retrieve The user assignment By Given ID
    • Retrieve The user assignment By ID
    • Update An Existing User Assignment
  • User Assignment Transaction Service
    • Check if user is a supervisor
    • De allocate User By Account ID
    • Get All Account IDs And User Mapping
    • Get Strategy Assign data based on users that belong to Vendor type User groups
    • Get Strategy Assign Data By Account ID
    • Get Strategy Assign History data based on users that belong to Vendor type User groups
    • Get Subordinate Users By Supervisor ID
    • Reassign Accounts Based On Segment Codes
    • Reassign Accounts Based On Segment Codes and Strategy Codes
  • User Group Maintenance Service
    • Add a New user group
    • Authorize The user group By Given ID
    • Close The user group By Given ID
    • Delete the user group Identified By Given ID
    • Fetch list of users that may or may not be a vendor
    • Get All Valid user group
    • Reopen The user group By Given ID
    • Retrieve The Unauthorized user group By Given ID
    • Retrieve the user group By ID
    • Retrieve The user group History By Given ID
    • Update an Existing user group
• Vendor Management Services
  • Vendor Management Batch Service
    • Fetches a Vendor Account Association.
  • Vendor Management Maintenance Service
    • Adds a new vendor.
    • Authorize the vendor by given ID.
    • Close the vendor by given ID.
    • Deletes the vendor identified by given ID.
    • Get all valid vendor.
    • reopen the vendor by given ID.
    • Retrieves the vendor by ID.
    • Retrives the vendor by given ID.
    • Retrives the vendor by given ID.
    • Update an existing vendor.