Get All Valid Promise to Pay Type
get
/obedm-ptp-services/ptptype
This endpoint is used to Get all valid Promise to Pay Type maintenance records.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
authStatus(optional): string
Authorization Status.
-
includecloseandunauth(optional): boolean
Include close and unauthorised need to be set to fetch summary record, default value is false.
-
limit(optional): integer
Limit is maximum number of records to be fetched.
-
offset(optional): integer
Offset is starting number of records to be fetched.
-
ptpTypeCd(optional): string
PTP Type Code.
-
ptpTypeDescr(optional): string
PTP Type Description.
-
recordStatus(optional): string
Record Status.
Header Parameters
-
appId: string
The unique identifier for the application in the request header.
-
branchCode: string
The code of the branch in the request header.
-
contentType(optional): string
The type of content in the request header.
-
tenantId(optional): string
The tenant in the request header.
-
userId: string
The unique identifier for the user in the request header.
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
-
Location: string
Additional information of the all valid Promise To Pay Type.
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.
405 Response
Invalid input
500 Response
Internal error