Retrieve Promise to Pay Type by ID
get
/obedm-ptp-services/ptptype/{id}
This endpoint is used to retrieve Promise to Pay Type by ID.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: string
The ID of the user that needs to be fetched.
Query Parameters
-
version: string
The version of the user that needs to be fetched.
Header Parameters
-
appId: string
The ID of the application making the request.
-
branchCode: string
The code of the branch the user belongs to.
-
contentType(optional): string
The content type of the request.
-
tenantId(optional): string
The ID of the tenant.
-
userId: string
The ID of the user making the request.
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the Promise To Pay Type based on given id.
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : DmTmPTPTypeDTO-allOf[1]
Type:
Show Source
object
-
DmTmPtpTypeAlertConfigDTO(optional):
array DmTmPtpTypeAlertConfigDTO
An array of alert configurations associated with the PTP (Promise to Pay) type.
-
DmTmPtpTypeSegmentsDTO(optional):
array DmTmPtpTypeSegmentsDTO
An array of segments associated with the PTP (Promise to Pay) type.
-
graceDays(optional):
integer
The number of grace days allowed for the PTP (Promise to Pay) type.
-
ptpTypeCd(optional):
string
The code for the PTP (Promise to Pay) type.
-
ptpTypeDescr(optional):
string
The description for the PTP (Promise to Pay) type.
-
ruleCd(optional):
string
The code for the rule associated with the PTP (Promise to Pay) type.
-
thresholdPer(optional):
number
The threshold percentage for the PTP (Promise to Pay) type.
Nested Schema : DmTmPtpTypeAlertConfigDTO
Type:
array
An array of alert configurations associated with the PTP (Promise to Pay) type.
Show Source
Nested Schema : DmTmPtpTypeSegmentsDTO
Type:
array
An array of segments associated with the PTP (Promise to Pay) type.
Show Source
Nested Schema : DmTmPtpTypeAlertConfigDTO
Type:
Show Source
object
-
commMode(optional):
string
Communication mode
-
eventType(optional):
string
Event type
-
id(optional):
string
ID
-
ptpTypeMasterId(optional):
string
PTP type master ID
-
recipientType(optional):
string
Recipient type
-
remDays(optional):
integer
Remaining days
-
ruleCd(optional):
string
Rule code
-
sequence(optional):
integer
Sequence
-
templateCd(optional):
string
Template code
Nested Schema : DmTmPtpTypeSegmentsDTO
Type:
Show Source
object
-
id(optional):
string
ID
-
ptpTypeMasterId(optional):
string
PTP type master ID.
-
segmentCd(optional):
string
Segment code
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error