REST API for Oracle Banking Collections Cloud Service

All REST Endpoints

Activity Services/Activity Service

This service is used to perform activity operations.

Add New Activity: Method: post
Path: /activity-service/activity
Delete Activity Identified by Given ID: Method: delete
Path: /activity-service/activity/{id}
Get Additional Account Information by Account ID: Method: get
Path: /activity-service/activity/acct/addn/{acctId}
Healthcheck of Activity Service: Method: get
Path: /activity-service/healthcheck
Retrieve Activity by ID: Method: get
Path: /activity-service/activity/{id}
Retrieve Activity by ID and Activity Type: Method: get
Path: /activity-service/activity/getActivityByType
Retrieve List of Activities by Account ID: Method: get
Path: /activity-service/activity/getActivityByAccount
Retrieve List of Activities by Filters: Method: get
Path: /activity-service/activity/getActivityByFilter
Retrieve List of Activities with Distinct Users by Account ID: Method: get
Path: /activity-service/activity/getActivityUniqueUsersByAccount
Retrieve List of Existing Activities: Method: get
Path: /activity-service/activity
Update Existing Activity: Method: put
Path: /activity-service/activity/{id}

Call Action Services/Call Action Collector Dashboard Service

This Service is used to Perform Action transactional operations.

Fetch Action Results based on TaskId: Method: post
Path: /api/1.0/collectordashboard/actionResultsCountByTaskId
Retrieve the count of Call Action Results: Method: get
Path: /api/1.0/collectordashboard/callactionresultcount

Call Action Services/Call Action Maintenance Service

This service is used to perform Action Maintenance operations.

Add a New Call Action: Method: post
Path: /api/1.0/callAction
Authorize the Call Action by given ID: Method: patch
Path: /api/1.0/callAction/{id}/approve
Close the Call Action by given ID: Method: patch
Path: /api/1.0/callAction/{id}/close
Delete the Call Action identified by given ID: Method: delete
Path: /api/1.0/callAction/{id}
Get all Valid Call Action: Method: get
Path: /api/1.0/callAction
Reopen the Call Action by given ID: Method: patch
Path: /api/1.0/callAction/{id}/reopen
Retrieve the Call Action by ID: Method: get
Path: /api/1.0/callAction/{id}
Retrieve the Call Action Maintenance History by given ID: Method: get
Path: /api/1.0/callAction/{id}/history
Retrieve the Unauthorized Call Action by given ID: Method: get
Path: /api/1.0/callAction/{id}/unauthorized
Update an existing Call Action: Method: put
Path: /api/1.0/callAction/{id}

Call Action Services/Call Action Transaction Service

This service is used to perform Call Action transactional operations.

Add a New Call Action followup record: Method: post
Path: /api/1.0/callActionTransactional
End collection status on an account: Method: post
Path: /api/1.0/callActionTransactional/endCollStatusByAccId
Fetch details of Call Summary: Method: get
Path: /api/1.0/callActionTransactional/callSummary
Restore closed collection status on an account: Method: post
Path: /api/1.0/callActionTransactional/reverseClosedCollStat
Retrieve all open and close existing collection status based on an account ID: Method: get
Path: /api/1.0/callActionTransactional/getAllAccExisCollStat
Retrieve count of call actions based on call type: Method: get
Path: /api/1.0/callActionTransactional/callCount
Retrieve specialised status updates on call account ID: Method: get
Path: /api/1.0/callActionTransactional/getSpecializedUpdateStatus/{accountId}
Retrieve the action details based on segment code: Method: get
Path: /api/1.0/callActionTransactional/getActionDetails/{segmentCode}
Retrieve the action history details based on Task ID: Method: get
Path: /api/1.0/callActionTransactional/getHistoryDetails
Retrieve the existing collection status based on account ID: Method: get
Path: /api/1.0/callActionTransactional/getExistingCollectionStatus
Retrieve the value of all the facts for batches: Method: post
Path: /api/1.0/dmaccountgetfacts
Update the specialised status: Method: post
Path: /api/1.0/callActionTransactional/postSpecializedUpdateStatus

Common Services/Fact Details Service

This service is used to perform Fact Details Service operations.

Retrieve Fact Details by Account ID: Method: get
Path: /obedm-common-services/factDetails/{accountId}
Retrieve Fact Details by Category: Method: get
Path: /obedm-common-services/factDetails/category/{category}

Common Services/Identifier Definition Service

This service is used to perform Identifier Definition Maintenance Service operations.

Add New Identifier Definition: Method: post
Path: /obedm-common-services/identifierdefinition
Authorize Identifier Definition by Given ID: Method: patch
Path: /obedm-common-services/identifierdefinition/{id}/approve
Close Identifier Definition by Given ID: Method: patch
Path: /obedm-common-services/identifierdefinition/{id}/close
Delete Identifier Definition Identified by Given ID: Method: delete
Path: /obedm-common-services/identifierdefinition/{id}
Fetch Identifier Definition and Parameters Configuration for Given Criteria: Method: get
Path: /obedm-common-services/identifierdefinition/getAngConfig
Generate Number for Given Criteria: Method: get
Path: /obedm-common-services/identifierdefinition/generate
Get All Valid Identifier Definition: Method: get
Path: /obedm-common-services/identifierdefinition
Reopen Identifier Definition by Given ID: Method: patch
Path: /obedm-common-services/identifierdefinition/{id}/reopen
Retrieve Identifier Definition by Given ID: Method: get
Path: /obedm-common-services/identifierdefinition/{id}/unauthorized
Retrieve Identifier Definition by ID: Method: get
Path: /obedm-common-services/identifierdefinition/{id}
Retrieve Identifier Definition History by Given ID: Method: get
Path: /obedm-common-services/identifierdefinition/{id}/history
Update Existing Identifier Definition: Method: put
Path: /obedm-common-services/identifierdefinition/{id}

Common Services/Lookup Type Service

This service is used to perform Lookup Type maintenance service operations.

Add New Lookup Type: Method: post
Path: /obedm-common-services/lookuptype
Authorize Lookup Type by Given ID: Method: patch
Path: /obedm-common-services/lookuptype/{id}/approve
Close Lookup Type by Given ID: Method: patch
Path: /obedm-common-services/lookuptype/{id}/close
Delete Lookup Type Identified by Given ID: Method: delete
Path: /obedm-common-services/lookuptype/{id}
Get All Valid Lookup Type: Method: get
Path: /obedm-common-services/lookuptype
Reopen Lookup Type by Given ID: Method: patch
Path: /obedm-common-services/lookuptype/{id}/reopen
Retrieve All Unauthorized Records for Lookup Type by Given ID: Method: get
Path: /obedm-common-services/lookuptype/{id}/unauthorized
Retrieve History of Lookup Type by Given ID: Method: get
Path: /obedm-common-services/lookuptype/{id}/history
Retrieve Lookup Codes by Given Lookup Type: Method: get
Path: /obedm-common-services/lookuptype/lookuplov/{lookupTypeCd}
Retrieve Lookup Type by ID: Method: get
Path: /obedm-common-services/lookuptype/{id}
Update Existing Lookup Type: Method: put
Path: /obedm-common-services/lookuptype/{id}

Common Services/Product Processor Service

This service is used to perform Product Processor Maintenance Service operations.

Add New Product Processor: Method: post
Path: /obedm-common-services/productprocessor
Authorize Product Processor by Given ID: Method: patch
Path: /obedm-common-services/productprocessor/{id}/approve
Close Product Processor by Given ID: Method: patch
Path: /obedm-common-services/productprocessor/{id}/close
Delete Product Processor Identified by Given ID: Method: delete
Path: /obedm-common-services/productprocessor/{id}
Get All Valid Product Processors: Method: get
Path: /obedm-common-services/productprocessor
Health Check Of Common Services: Method: get
Path: /obedm-common-services/healthcheck
Reopen Product Processor by Given ID: Method: patch
Path: /obedm-common-services/productprocessor/{id}/reopen
Retrieve All Unauthorized Records of Product Processor by Given ID: Method: get
Path: /obedm-common-services/productprocessor/{id}/unauthorized
Retrieve Group Basis Code and Product Processor Code for All Product Processors: Method: get
Path: /obedm-common-services/productprocessor/groupBasis
Retrieve Product Processor by ID: Method: get
Path: /obedm-common-services/productprocessor/{id}
Retrieve Product Processor History by Given ID: Method: get
Path: /obedm-common-services/productprocessor/{id}/history
Update Existing Product Processor: Method: put
Path: /obedm-common-services/productprocessor/{id}

Correspondence Services/Communication Details Service

This service is used to perform communication details transaction operations.

Fetch contents of a document in Base 64 format: Method: get
Path: /obcr-correspondence-services/inboundDocument/downloadDocument
Fetch details of all Inbound Document uploaded: Method: get
Path: /obcr-correspondence-services/inboundDocument/getDetails
Fetch Manual Communication Details: Method: post
Path: /obcr-correspondence-services/commdetails/fetchManualCommDetails
Get All count of case history details: Method: get
Path: /obcr-correspondence-services/commdetails/allcasehistcount
Get All count of communication details: Method: get
Path: /obcr-correspondence-services/commdetails/count
Get Manual Communication History: Method: get
Path: /obcr-correspondence-services/commdetails/getManualCommHistory
Get settlement related details.: Method: get
Path: /obcr-correspondence-services/commdetails/settlementCommDetails
Send Manual Communication: Method: post
Path: /obcr-correspondence-services/commdetails/sendManualComm
Upload Inbound Document: Method: post
Path: /obcr-correspondence-services/inboundDocument/upload
Validate Block Period for Manual Communication: Method: get
Path: /obcr-correspondence-services/commdetails/validateBlockPeriod

Correspondence Services/Communication Template Maintenance Service

This service is used to perform Communication Template Maintenance operations.

Add New Communication Template: Method: post
Path: /obedm-correspondence-services/commtemplate
Authorize Communication Template by Given ID: Method: patch
Path: /obedm-correspondence-services/commtemplate/{id}/approve
Close Communication Template by Given ID: Method: patch
Path: /obedm-correspondence-services/commtemplate/{id}/close
Delete Communication Template Identified by Given ID: Method: delete
Path: /obedm-correspondence-services/commtemplate/{id}
Get All Valid Communication Template: Method: get
Path: /obedm-correspondence-services/commtemplate
Healthcheck of Correspondence Service: Method: get
Path: /obedm-correspondence-services/healthcheck
Reopen Communication Template by Given ID: Method: patch
Path: /obedm-correspondence-services/commtemplate/{id}/reopen
Retrieve Communication Template by ID: Method: get
Path: /obedm-correspondence-services/commtemplate/{id}
Retrieve Communication Template History by Given ID: Method: get
Path: /obedm-correspondence-services/commtemplate/{id}/history
Retrieve Onload Data: Method: get
Path: /obedm-correspondence-services/commtemplate/onload
Retrieve Unauthorized Communication Template by Given ID: Method: get
Path: /obedm-correspondence-services/commtemplate/{id}/unauthorized
Update Existing Communication Template: Method: put
Path: /obedm-correspondence-services/commtemplate/{id}

Correspondence Services/Correspondence Batch Service

Correspondence Batch Service REST Endpoints

Generate Report.: Method: post
Path: /obedm-correspondence-services/correspondence/sendLetter

Dashboard Services/Dashboard Service

This service is used to perform Collector Dashboard Transaction Service operations..

Get no of accounts handled: Method: get
Path: /api/1.0/dashboard/kpi/all

Data Exchange Services/Data Exchange Service

This service describes the API information for Data Exchange Service.

Fetch Dialer Record: Method: get
Path: /api/1.0/dataexchng/fetchDialerRecords

Entity Services/Account Arrears Service

This service is used to populate the arrear details of an account.

Update arrear details for an existing account: Method: put
Path: /dmaccountarrears-service/accountarrears

Entity Services/Account Bill Details Service

This service is used to populate billing information of an account.

Update existing account Bill Details: Method: put
Path: /dmaccountbilldtls-service/accountbilldtls

Entity Services/Account Delinquency History Service

This service is used to populate delinquency history of the account.

Add Case ID for delinquent accounts: Method: post
Path: /dmaccountdelhistory-service/addcaseidfordelaccounts
Retrieves account history filtered by collection end date: Method: get
Path: /dmaccountdelhistory-service/fetchdmaccountdelhistoriesbycollectionenddate
Retrieves the list of existing account delinquency history.: Method: get
Path: /dmaccountdelhistory-service/dmaccountdelhistories

Entity Services/Account Party Relationship Service

This service is used to populate account party relationship.

Retrieve Account Party Relationship for given Account ID: Method: get
Path: /DmAccountParty-service/getPartyIdForAccountId/{accountId}
Retrieve all Accounts for given Party ID: Method: get
Path: /DmAccountParty-service/accountParties/{partyId}
Retrieve the email id list of Party by Account ID: Method: get
Path: /DmAccountParty-service/accountParties/getPartyDetails/{accountId}
Retrieve the list of Party by Account ID: Method: get
Path: /DmAccountParty-service/accountParties/getPartyDetailsByTaskType/{accountId}
Update an Existing Account Party Relationship: Method: put
Path: /DmAccountParty-service/accountParties

Entity Services/Account Payment Service

This service is used to populate payment details of the account.

Get all payments details for an account after a specified date: Method: get
Path: /dmpayment-service/payments
Get payment details based on Account ID: Method: get
Path: /dmpayment-service/payment/getPaymentDetailsByAcctId
Get payment details based on Account ID and date filter: Method: get
Path: /dmpayment-service/payment/getPaymentDetailsByDateFilter
Update existing payment details: Method: put
Path: /dmpayment-service/payments

Entity Services/Account Repayment Schedule Service

This service is used to populate the repayment schedule of the account.

Update existing account repayment schedule: Method: put
Path: /dmaccountrepaysch-service/accountrepayschs

Entity Services/Account Review Service

This service is used to populate review details of the account.

Retrieve List of Existing Account Review Details Based on Review Date.: Method: get
Path: /dmaccountreview-service/getAccountsToBeProcessed
Update Existing Review Details of Account: Method: put
Path: /dmaccountreview-service/accountreview

Entity Services/Account Service

This service is used to maintain basic financial & non-financial details of account.

Retrieve the account ID for the given account number.: Method: post
Path: /dmaccount-service/accounts/getAccountIdforAccountNumber
Retrieve the count of accounts obtained in the result specific to task summary account.: Method: post
Path: /dmaccount-service/accounts/resultCount
Retrieve the list of account party details by account IDs and relevant filters.: Method: post
Path: /dmaccount-service/accounts/limitedAcctPartyDetails
Retrieve the list of all unallocated accounts: Method: get
Path: /dmaccount-service/accounts/unallocated
Retrieve the list of all fact values associated with entities: Method: post
Path: /dmaccount-service/dmaccountgetfacts
Retrieve the list of in collections account IDs: Method: get
Path: /dmaccount-service/accounts
Retrieves the account details based on the provided account ID.: Method: post
Path: /dmaccount-service/agentAccounts/limitedDetails
Retrieves the account details for dialer batches.: Method: get
Path: /dmaccount-service/accounts/fetchDialerData
Retrieves the account details using the provided account ID: Method: get
Path: /dmaccount-service/accounts/getAccountDetailsById
Retrieves the account ID based on the provided account number and product processor code: Method: post
Path: /dmaccount-service/accounts/getAccountId
Retrieves the group basis using the provided Account ID.: Method: get
Path: /dmaccount-service/accounts/getGroupBasisByAccId
Set Allocation flag for the given account ID: Method: put
Path: /dmaccount-service/accounts/allocate
Update existing account: Method: put
Path: /dmaccount-service/accounts

Entity Services/Agent View Party Service

This service is used to populate name details of the party.

Get all Existing Party Details by Account ID.: Method: get
Path: /dmpartyname-service/agentUserView/allpartynames/{acctId}

Entity Services/Case Service Summary

This service is used to maintain basic financial & non-financial details of account.

Get all account details by Account ID: Method: get
Path: /dmaccount-service/agentUserView/{acctId}/complete
Get all customer details by Party ID: Method: get
Path: /dmaccount-service/agentUserView/{partyId}/card

Entity Services/Collateral Charge Service

This service is used to populate charge details of the collateral.

Update Existing Collateral Charge Details: Method: put
Path: /DmCollateralCharge-service/collateralCharges

Entity Services/Collateral Linkage Service

This service is used to populate collateral and account linkage.

Update Existing Collateral Linkage: Method: put
Path: /DmCollateralLinkage-service/collateralLinkages

Entity Services/Collateral Owner Service

This service is used to populate ownership details of the collateral.

Update Existing Collateral Owner: Method: put
Path: /DmCollateralOwner-service/collateralOwners

Entity Services/Collateral Service

This service is used to populate basic details of the collateral.

Get existing collateral details based on the account ID: Method: get
Path: /DmCollateral-service/collateralDetails
Update existing collateral details: Method: put
Path: /DmCollateral-service/collaterals

Entity Services/Feed Entity Service

This service is used to create feed entity.

Add New Feed Entity: Method: post
Path: /dmfeedentity-service/feedentities
Update Account Arrears Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processAcctArrearsFeed
Update Account Bill Details Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processAcctBillDtlsFeed
Update Account Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processAcctFeed
Update Account Party Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processAccountPartyFeed
Update Account Repayment Schedule Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processAcctRepaySchFeed
Update Collateral Charge Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processCollateralChargeFeed
Update Collateral Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processCollateralFeed
Update Collateral Linkage Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processCollateralLinkageFeed
Update Collateral Owner Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processCollateralOwnerFeed
Update Insurance Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processInsuranceFeed
Update Party Address Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processPartyAddressFeed
Update Party Contact Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processPartyContactFeed
Update Party Employment Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processPartyEmploymentFeed
Update Party Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processPartyFeed
Update Party Identity Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processPartyIdentityFeed
Update Party Name Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processPartyNameFeed
Update Payment Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processPaymentFeed
Update Risk Indicator Entity: Method: post
Path: /dmfeedentity-service/feedEntity/processRiskIndicatorFeed

Entity Services/Insurance Service

This service is used to populate basic details of the insurance.

Update Existing Insurance: Method: put
Path: /DmInsurance-service/insurances

Entity Services/Party Address Service

This service is used to populate address details of the party.

Update Existing Party Address: Method: put
Path: /dmpartyaddress-service/partyaddresses

Entity Services/Party Contact Service

This service is used to populate contact details of the party.

Update Existing Party Contact: Method: put
Path: /dmpartycontact-service/partycontacts

Entity Services/Party Employment Service

This service is used to populate employment details of the party.

Update Existing Party Employment Details: Method: put
Path: /dmpartyemployment-service/partyemployments

Entity Services/Party Identity Service

This service is used to populate identification details of the party.

Update Existing Party Identity Details: Method: put
Path: /dmpartyidentity-service/partyidentities

Entity Services/Party Name Service

This service is used to populate name details of the party.

Update Existing Party Name Details: Method: put
Path: /dmpartyname-service/partynames

Entity Services/Party Service

This service is used to populate basic details of the party.

Retrieve Party ID, Customer Number, and Party Name for LOV Component: Method: get
Path: /dmparty-service/parties/lov
Update Existing Party: Method: put
Path: /dmparty-service/parties

Entity Services/Risk Indicator Service

This service is used to populate risk indicator details on account and party.

Update Existing Risk Indicator: Method: put
Path: /DmRiskIndicator-service/riskIndicators

Entity Services/Seed Data Configuration Service

This service is used to create Seed Data Configuration related tasks.

Add New Seed Data Configuration: Method: post
Path: /api/1.0/seeddataconfig
Authorize Seed Data Configuration by Given ID: Method: patch
Path: /api/1.0/seeddataconfig/{id}/approve
Close Seed Data Configuration by Given ID: Method: patch
Path: /api/1.0/seeddataconfig/{id}/close
Delete Seed Data Configuration Identified by Given ID: Method: delete
Path: /api/1.0/seeddataconfig/{id}
Get All Valid Seed Data Configuration: Method: get
Path: /api/1.0/seeddataconfig
Health Check of Entity Service: Method: get
Path: /api/1.0/seeddataconfig/healthcheck
Reopen Seed Data Configuration by Given ID: Method: patch
Path: /api/1.0/seeddataconfig/{id}/reopen
Retrieve Seed Data Configuration by Given ID: Method: get
Path: /api/1.0/seeddataconfig/{id}/history
Retrieve Seed Data Configuration by Given ID: Method: get
Path: /api/1.0/seeddataconfig/{id}/unauthorized
Retrieve Seed Data Configuration by ID: Method: get
Path: /api/1.0/seeddataconfig/{id}
Retrieve Seed Detail Description by Given Seed Type Code and Seed Code: Method: get
Path: /api/1.0/seeddataconfig/getDescription/{seedTypeCd}/{seedCd}
Update Existing Seed Data Configuration: Method: put
Path: /api/1.0/seeddataconfig/{id}

Fees Charges Services/Fees Charges Batch Services

This service is used to perform various actions related to fee charge service.

Health Check of Fees and Charges Batch Service: Method: get
Path: /obcr-fees-charges-services/healthcheck

Fees Charges Services/Fees Charges Maintenance Services

This service is used to perform various actions related to fee charge service.

Adds a new feecharge.: Method: post
Path: /obcr-fees-charges-services/feecharge
Authorize the feecharge by given ID.: Method: patch
Path: /obcr-fees-charges-services/feecharge/{id}/approve
Close the feecharge by given ID.: Method: patch
Path: /obcr-fees-charges-services/feecharge/{id}/close
Deletes the feecharge identified by given ID.: Method: delete
Path: /obcr-fees-charges-services/feecharge/{id}
Get all valid feecharge.: Method: get
Path: /obcr-fees-charges-services/feecharge
reopen the feecharge by given ID.: Method: patch
Path: /obcr-fees-charges-services/feecharge/{id}/reopen
Retrieves the feecharge by ID.: Method: get
Path: /obcr-fees-charges-services/feecharge/{id}
Retrives the feecharge by given ID.: Method: get
Path: /obcr-fees-charges-services/feecharge/{id}/history
Retrives the feecharge by given ID.: Method: get
Path: /obcr-fees-charges-services/feecharge/{id}/unauthorized
Update an existing feecharge.: Method: put
Path: /obcr-fees-charges-services/feecharge/{id}

Fees Charges Services/Fees Charges Transaction Services

This service is used to perform various actions related to fee charge service.

Retrieves the feeschargesaccountasso by Account Id.: Method: get
Path: /obcr-fees-charges-services/feechargetransaction/getaccount/{accountId}
Update Fees and Charges Association History and Delete Fees and Charges Association: Method: get
Path: /obcr-fees-charges-services/feechargetransaction/updateFeesandChargesAssoHistAndDeleteFeesandChargesAsso/{acctId}

Notes Services/Notes Service

This service is used to perform notes service operations.

Add a New Note: Method: post
Path: /notes-service/saveNotes
Add mapping between Action ID and Account ID: Method: post
Path: /notes-service/mapActionIdtoAccountId
Get Additional Account Information by Account ID: Method: get
Path: /notes-service/note/acct/addn/{acctId}
Get Behavior Details by Account ID: Method: get
Path: /notes-service/BehaviorDetails/{accountId}
Get Compliance by Action ID: Method: get
Path: /notes-service/note/compliance/{actionId}
Get Notes by Action ID: Method: get
Path: /notes-service/note/{actionId}
Health Check of notes service: Method: get
Path: /notes-service/healthcheck
Retrieves Notes Details by Account ID: Method: get
Path: /notes-service/getNotes

Promise to Pay Services/Promise to Pay Collector Dashboard Service

This service is used to perform collector dashboard transaction service operations.

Display Collection history promise detail by user id: Method: get
Path: /obedm-ptp-services/collectordashboard/collectionhistory/{period}
Get all PTP related KPI information: Method: get
Path: /obedm-ptp-services/collectordashboard/kpi/all

Promise to Pay Services/Promise to Pay Maintenance Service

This service is used to perform Promise to Pay Type Maintenance Service operations.

Add New Promise to Pay Type: Method: post
Path: /obedm-ptp-services/ptptype
Authorize Promise to Pay Type by Given ID: Method: patch
Path: /obedm-ptp-services/ptptype/{id}/approve
Close Promise to Pay Type by Given ID: Method: patch
Path: /obedm-ptp-services/ptptype/{id}/close
Delete Promise to Pay Type Identified by Given ID: Method: delete
Path: /obedm-ptp-services/ptptype/{id}
Get All Valid Promise to Pay Type: Method: get
Path: /obedm-ptp-services/ptptype
Reopen Promise to Pay Type by Given ID: Method: patch
Path: /obedm-ptp-services/ptptype/{id}/reopen
Retrieve Promise to Pay Type by Given ID: Method: get
Path: /obedm-ptp-services/ptptype/{id}/unauthorized
Retrieve Promise to Pay Type by ID: Method: get
Path: /obedm-ptp-services/ptptype/{id}
Retrieve Promise to Pay Type History by Given ID: Method: get
Path: /obedm-ptp-services/ptptype/{id}/history
Update Existing Promise to Pay Type: Method: put
Path: /obedm-ptp-services/ptptype/{id}

Promise to Pay Services/Promise to Pay Transaction Service

This service is used to perform promise Transaction Service operations.

Add a new promise: Method: post
Path: /obedm-ptp-services/ptp/create/{accountNumber}
Add a new Promise to pay: Method: post
Path: /obedm-ptp-services/ptp
Appropriate Payment Against promise: Method: put
Path: /obedm-ptp-services/ptp/appropriate
Cancel promise with Reason and Notes: Method: post
Path: /obedm-ptp-services/ptp/cancel
Cancel PTPs by Account ID: Method: get
Path: /obedm-ptp-services/ptp/cancel/{acctId}
Display upcoming promise detail by user id: Method: get
Path: /obedm-ptp-services/upcomingpromise
Fetch Earliest promise details for Dialer batch.: Method: get
Path: /obedm-ptp-services/ptp/fetchEarliestPromise
Fetch promise and its history using promise Id.: Method: get
Path: /obedm-ptp-services/ptp/getPtpById/{ptpId}
Fetch PTP and its history using account number.: Method: get
Path: /obedm-ptp-services/ptp/fetch/{accountNumber}
Get Additional Account Information by Account ID: Method: get
Path: /obedm-ptp-services/ptp/acct/addn/{acctId}
Get All promise Detail by Account ID: Method: get
Path: /obedm-ptp-services/ptp/{type}
Get promise History based on account id and case id: Method: post
Path: /obedm-ptp-services/ptphistory
Get Status Count for Each Status: Method: post
Path: /obedm-ptp-services/ptp/count
Health Check of promise Service: Method: get
Path: /obedm-ptp-services/healthcheck
Retrieve Quick promise by Account ID: Method: get
Path: /obedm-ptp-services/ptp
Simulates a New Promise Schedule: Method: post
Path: /obedm-ptp-services/ptp/simulate

Segmentation Services/Segment Maintenance Service

This service is used to perform Segment Batch operations.

Health Check of Segmentation Batch Service: Method: get
Path: /api/1.0/healthcheck
Retrieve All Segment Related Facts Values: Method: post
Path: /api/1.0/segmentBatch/getSegmentfacts
Retrieve List of Segment And Strategy Associated with an Account: Method: get
Path: /api/1.0/segmentBatch/getAccountSegmentStrategyAssociation
Retrieve List of Segments Associated with an List of Account ID: Method: post
Path: /api/1.0/segmentBatch/getSegmentCdAndAcctIdMapping
Retrieve the Segment based on Account ID: Method: get
Path: /api/1.0/segmentBatch/getSegmentCdByAcctId
Retrieve the Segment based on Account ID and Case ID: Method: get
Path: /api/1.0/segmentBatch/getSegmentCdByAcctIdandCaseId
Update Segment Associated and Delete Segment Association History: Method: post
Path: /api/1.0/segmentBatch/updateSegAssoAndDeleteSegAssoHistRev
Update Segment Association History and Delete Segment Association: Method: post
Path: /api/1.0/segmentBatch/updateSegAssoHistAndDeleteSegAsso

Segmentation Services/Segmentation Batch Service

This service is used to perform Segment Batch operations.

Health Check of Segmentation Batch Service: Method: get
Path: /api/1.0/segmentationbatch/healthcheck

Settlement Services/Settlement Batch Service

This service describes the API information for Settlement Batch Service.

Health Check of Settlement Batch Service: Method: get
Path: /obcr-Settlement-services/healthcheck
Retrieve the value of all the facts for batches: Method: post
Path: /obcr-Settlement-services/dmaccountgetfacts

Settlement Services/Settlement Service

Settlement Details Transaction Service REST Endpoints

Get Settlement Details By AccountId: Method: get
Path: /obcr-Settlement-services/settlementDetails/getSettlementDetails/{accountId}
Save settlement initiation details: Method: post
Path: /obcr-Settlement-services/settlementDetails/saveSettlementInitDetails
Save Settlement Offer Details: Method: post
Path: /obcr-Settlement-services/settlementDetails/saveSettlementOffer
Update an Existing Offer Status: Method: put
Path: /obcr-Settlement-services/settlementDetails/updateStatus

Strategy Services/Case Account Association Service

Case Account Association Operations

Add New Case Account Association: Method: post
Path: /obcr-strategy-services/api/v1/dmcaseaccountassos
Delete Case Account Association and Insert in Case Account Association History: Method: post
Path: /obcr-strategy-services/strategy/delDmCaseAssoAndInsInDmCaseAssoHist
Delete Case Account Association Identified by the Given ID: Method: delete
Path: /obcr-strategy-services/api/v1/dmcaseaccountassociations/{id}
Retrieve Case Account Association by ID: Method: get
Path: /obcr-strategy-services/api/v1/dmcaseaccountassociations/{id}
Retrieve List of Existing Case Account Associations: Method: get
Path: /obcr-strategy-services/strategy/delDmCaseAssoAndInsInDmCaseAssoHist
Update Existing Case Account Association: Method: put
Path: /obcr-strategy-services/api/v1/dmcaseaccountassociations/{id}

Strategy Services/Case Service

Case operations

Get Case Id from Case Number: Method: get
Path: /obcr-strategy-services/getCaseIdFromCaseNbr
Get Party Id from Case No: Method: get
Path: /obcr-strategy-services/getPartyIdFromCaseNo

Strategy Services/Fact Service

This service describes the API information for Fact Service.

Retrieve List of All Fact Value for Batch: Method: post
Path: /obcr-strategy-services/dmaccountgetfacts

Strategy Services/Strategy Maintenance Service

This service is used for performing various actions related to Strategy Maintenance.

Add New Strategy: Method: post
Path: /api/1.0/strategymaintenance
Authorize Strategy by Given ID: Method: patch
Path: /api/1.0/strategymaintenance/{id}/approve
Close Strategy by Given ID: Method: patch
Path: /api/1.0/strategymaintenance/{id}/close
Delete Strategy Identified by Given ID: Method: delete
Path: /api/1.0/strategymaintenance/{id}
Get All Valid Strategies: Method: get
Path: /api/1.0/strategymaintenance
Reopen Strategy by Given ID: Method: patch
Path: /api/1.0/strategymaintenance/{id}/reopen
Retrieve Strategy by Given ID: Method: get
Path: /api/1.0/strategymaintenance/{id}/history
Retrieve Strategy by Given ID: Method: get
Path: /api/1.0/strategymaintenance/{id}/unauthorized
Retrieve the Strategy by ID: Method: get
Path: /api/1.0/strategymaintenance/{id}
Retrieve Workflow Status by Given Workflow code.: Method: get
Path: /api/1.0/strategymaintenance/getWorkflow/{taskCd}
Update Existing Strategy: Method: put
Path: /api/1.0/strategymaintenance/{id}

Strategy Services/Strategy service

This service is used to check the health check for the Strategy services.

Health Check of Strategy Services: Method: get
Path: /obcr-strategy-services/healthcheck

Strategy Services/Task Type Service

Task Type maintenance APIs.

Add New Task Type: Method: post
Path: /api/1.0/tasktype
Authorize Task Type by Given ID: Method: patch
Path: /api/1.0/tasktype/{id}/approve
Close Task Type by Given ID: Method: patch
Path: /api/1.0/tasktype/{id}/close
Delete Task Type Identified by Given ID: Method: delete
Path: /api/1.0/tasktype/{id}
Get All Valid Task Type: Method: get
Path: /api/1.0/tasktype
Reopen Task Type by Given ID: Method: patch
Path: /api/1.0/tasktype/{id}/reopen
Retrieve Task Type by ID: Method: get
Path: /api/1.0/tasktype/{id}
Retrieve Task Type History by Given ID: Method: get
Path: /api/1.0/tasktype/{id}/history
Retrieve Unauthorized Task Type by Given ID: Method: get
Path: /api/1.0/tasktype/{id}/unauthorized
Update Existing Task Type: Method: put
Path: /api/1.0/tasktype/{id}

Task Workflow Services/Ad Hoc Task Service

This service is used to create ad hoc tasks.

Retrieve Ad hoc Task Onload: Method: get
Path: /api/1.0/onloadadhoctask/{accountId}
Save Ad hoc Task Data: Method: post
Path: /api/1.0/adhocktask

Task Workflow Services/Collector Dashboard Service

This service is used to perform Collector Dashboard Transaction Service operations..

Get all segments associated with the logged in user: Method: get
Path: /api/1.0/collectordashboard/currenttasks/segments
Get all task related KPI information: Method: get
Path: /api/1.0/collectordashboard/kpi/all
Get task Count based on the age of tasks: Method: get
Path: /api/1.0/collectordashboard/currenttasks/ageing/{segmentCode}
Get task Count of all tasks associated with logged in user: Method: get
Path: /api/1.0/collectordashboard/currenttasks/count/{segmentCode}
Get task history data: Method: get
Path: /api/1.0/collectordashboard/taskhistory/{timeFrame}

Task Workflow Services/Task Summary Service

Task Summary Service to display Tasks and Accounts assigned to the logged in user.

Escalate Tasks By Task ID: Method: put
Path: /api/1.0/taskSummary/task/escalate
Get all Accounts with Open/WIP tasks.: Method: get
Path: /api/1.0/taskSummary/fetchAccountsForDialerExtract
Get All count of Communication History details: Method: get
Path: /api/1.0/taskSummary/taskCommunicationHistCount
Get all task details associated with Ai User Id: Method: get
Path: /api/1.0/taskSummary/aiTaskDetailsForUserId
Get Existing Created Flag Details or Create/Update Flag Details for specific task: Method: put
Path: /api/1.0/taskSummary/flaggedTasks
Get Initial or Filtered Task Summary for Account: Method: post
Path: /api/1.0/taskSummary/account
Get Initial or Filtered Task Summary for Specialized Cases: Method: post
Path: /api/1.0/taskSummary/specializedcase
Get Initial or Filtered Task Summary for Task: Method: post
Path: /api/1.0/taskSummary/task
Get the Users Assigned if the Logged in User is a Supervisor: Method: get
Path: /api/1.0/taskSummary/account/usersAssigned
Reassign Accounts Based on Segment Codes: Method: put
Path: /api/1.0/taskSummary/accounts/reassign/{reassignUserId}
Reassign Accounts Based on Segment Codes: Method: put
Path: /api/1.0/taskSummary/specializedTab/reassign

Task Workflow Services/Task Workflow Batch Service

Task Workflow Batch Service to update or insert Task related details based on rule.

Get filtered Task details: Method: get
Path: /api/1.0/getFilteredTaskSummaryDetails
Get Task Details Based on Task ID: Method: get
Path: /api/1.0/taskWorkFlow/getTaskDetailsById
Get Task Status: Method: get
Path: /api/1.0/taskWorkFlow/getNextTaskStatus
Get Work Flow Status: Method: get
Path: /api/1.0/taskWorkFlow/getWorkflowStatusDetails
Remove Task for given Account ID: Method: post
Path: /api/1.0/taskWorkFlow/removeTasksByAcctId/{acctId}
Update Assignee for Task: Method: put
Path: /api/1.0/taskWorkFlow/assignTask
Update Task Status and Followup Date: Method: put
Path: /api/1.0/taskWorkFlow/updateTaskStatusAndFollowUpDate

Task Workflow Services/Task Workflow Maintenance Service

This service is used to maintain Task Workflow configuration.

Add New Task Workflow: Method: post
Path: /api/1.0/taskworkflow
Authorize Task Workflow by Given ID: Method: patch
Path: /api/1.0/taskworkflow/{id}/approve
Close Task Workflow by Given ID: Method: patch
Path: /api/1.0/taskworkflow/{id}/close
Delete Task Workflow Identified by Given ID: Method: delete
Path: /api/1.0/taskworkflow/{id}
Get All Valid Task Workflow: Method: get
Path: /api/1.0/taskworkflow
Reopen Task Workflow by Given ID: Method: patch
Path: /api/1.0/taskworkflow/{id}/reopen
Retrieve Task Workflow by ID: Method: get
Path: /api/1.0/taskworkflow/{id}
Retrieve Task Workflow History by Given ID: Method: get
Path: /api/1.0/taskworkflow/{id}/history
Retrieve Unauthorized Task Workflow by Given ID: Method: get
Path: /api/1.0/taskworkflow/{id}/unauthorized
Update Existing Task Workflow: Method: put
Path: /api/1.0/taskworkflow/{id}

User Management Services/User Assignment Maintenance Service

This service is used to perform user assignment Maintenance operations.

Add a New User Assignment: Method: post
Path: /api/1.0/userassignment
Authorize The user assignment By Given ID: Method: patch
Path: /api/1.0/userassignment/{id}/approve
Close The user assignment By Given ID: Method: patch
Path: /api/1.0/userassignment/{id}/close
Delete The user assignment Identified By Given ID: Method: delete
Path: /api/1.0/userassignment/{id}
Get All Valid User Assignment: Method: get
Path: /api/1.0/userassignment
Health Check Of User Management Service: Method: get
Path: /api/1.0/userassignment/healthcheck
Reopen The user assignment By Given ID: Method: patch
Path: /api/1.0/userassignment/{id}/reopen
Retrieve The user assignment By Given ID: Method: get
Path: /api/1.0/userassignment/{id}/history
Retrieve The user assignment By Given ID: Method: get
Path: /api/1.0/userassignment/{id}/unauthorized
Retrieve The user assignment By ID: Method: get
Path: /api/1.0/userassignment/{id}
Update An Existing User Assignment: Method: put
Path: /api/1.0/userassignment/{id}

User Management Services/User Assignment Transaction Service

This service is used to perform User Assignment Transaction operations.

Check if user is a supervisor: Method: get
Path: /api/1.0/user/isSupervisor/{userId}
De allocate User By Account ID: Method: post
Path: /api/1.0/user/deAllocateUser
Get All Account IDs And User Mapping: Method: post
Path: /api/1.0/user/userAccountmapping
Get Strategy Assign data based on users that belong to Vendor type User groups: Method: get
Path: /api/1.0/user/getStrategyAssignForVendors
Get Strategy Assign Data By Account ID: Method: get
Path: /api/1.0/user/getStrategyAssignDataByAcctId/{acctId}
Get Strategy Assign History data based on users that belong to Vendor type User groups: Method: get
Path: /api/1.0/user/getStrategyAssignHistForVendors
Get Subordinate Users By Supervisor ID: Method: get
Path: /api/1.0/user/getSubordinateUsers
Reassign Accounts Based On Segment Codes: Method: put
Path: /api/1.0/user/accounts/reassign/{reassignUserId}
Reassign Accounts Based On Segment Codes and Strategy Codes: Method: put
Path: /api/1.0/user/reassign

User Management Services/User Group Maintenance Service

This service is used to perform User Group Maintenance operations.

Add a New user group: Method: post
Path: /api/1.0/usergroup
Authorize The user group By Given ID: Method: patch
Path: /api/1.0/usergroup/{id}/approve
Close The user group By Given ID: Method: patch
Path: /api/1.0/usergroup/{id}/close
Delete the user group Identified By Given ID: Method: delete
Path: /api/1.0/usergroup/{id}
Fetch list of users that may or may not be a vendor: Method: get
Path: /api/1.0/usergroup/fetchUsers
Get All Valid user group: Method: get
Path: /api/1.0/usergroup
Reopen The user group By Given ID: Method: patch
Path: /api/1.0/usergroup/{id}/reopen
Retrieve The Unauthorized user group By Given ID: Method: get
Path: /api/1.0/usergroup/{id}/unauthorized
Retrieve the user group By ID: Method: get
Path: /api/1.0/usergroup/{id}
Retrieve The user group History By Given ID: Method: get
Path: /api/1.0/usergroup/{id}/history
Update an Existing user group: Method: put
Path: /api/1.0/usergroup/{id}

Vendor Management Services/Vendor Management Batch Service

This service describes the API information for Vendor Management Batch Service.

Fetches a Vendor Account Association.: Method: get
Path: /api/1.0/vendorAccount

Vendor Management Services/Vendor Management Maintenance Service

This service describes the API information for Vendor Management Maintenance Service.

Adds a new vendor.: Method: post
Path: /api/1.0/vendor
Authorize the vendor by given ID.: Method: patch
Path: /api/1.0/vendor/{id}/approve
Close the vendor by given ID.: Method: patch
Path: /api/1.0/vendor/{id}/close
Deletes the vendor identified by given ID.: Method: delete
Path: /api/1.0/vendor/{id}
Get all valid vendor.: Method: get
Path: /api/1.0/vendor
reopen the vendor by given ID.: Method: patch
Path: /api/1.0/vendor/{id}/reopen
Retrieves the vendor by ID.: Method: get
Path: /api/1.0/vendor/{id}
Retrives the vendor by given ID.: Method: get
Path: /api/1.0/vendor/{id}/history
Retrives the vendor by given ID.: Method: get
Path: /api/1.0/vendor/{id}/unauthorized
Update an existing vendor.: Method: put
Path: /api/1.0/vendor/{id}