Jump to

• Request
• Response

Get promise History based on account id and case id

post

/obedm-ptp-services/ptphistory

This endpoint is used to Get promise History based on account id and case id

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  Application ID for get status count for each status of promise to pay.
• branchCode(required): string
  Branch code for get status count for each status of promise to pay.
• contentType: string
  Content Type for get status count for each status of promise to pay.
• tenantId: string
  Tenant ID for get status count for each status of promise to pay.
• userId(required): string
  User ID for get status count for each status of promise to pay.

Body ()

Request Body that contains account ID case ID for getting consolidated promise history.

Root Schema : PTPHistoryRequestDto

Type: object

Show Source

• accountId: string
  The ID of the account associated with the PTP History.
• caseId: string
  The ID of the case associated with PTP History.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the PTP History."
        },
        "caseId":{
            "type":"string",
            "description":"The ID of the case associated with PTP History."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Body ()

Root Schema : ConsolidatePtpHistoryDto

Type: object

PTP History view object

Show Source

• brokenCounts: string
  Broken promise count
• collectedAmount: number
  Collected promise amount
• currencyCode: string
  Currency Code of promise amount
• keptCounts: string
  Kept promise count
• totalPromises: string
  No of Promises

{
    "description":"PTP History view object",
    "type":"object",
    "properties":{
        "totalPromises":{
            "description":"No of Promises",
            "type":"string"
        },
        "brokenCounts":{
            "description":"Broken promise count",
            "type":"string"
        },
        "keptCounts":{
            "description":"Kept promise count",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency Code of promise amount",
            "type":"string"
        },
        "collectedAmount":{
            "description":"Collected promise amount",
            "type":"number"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top