Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the Promise To Pay Type based on given id.

Body ()

Root Schema : DmTmPTPTypeWrapperDTO

Type: object

Wrapper DTO for PTP Type.

Show Source

• data(optional): object DmTmPTPTypeDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/DmTmPTPTypeDTO"
        }
    },
    "description":"Wrapper DTO for PTP Type."
}

Nested Schema : DmTmPTPTypeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmPTPTypeDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "ptpTypeCd":{
                    "description":"The code for the PTP (Promise to Pay) type.",
                    "type":"string"
                },
                "ptpTypeDescr":{
                    "description":"The description for the PTP (Promise to Pay) type.",
                    "type":"string"
                },
                "graceDays":{
                    "description":"The number of grace days allowed for the PTP (Promise to Pay) type.",
                    "type":"integer"
                },
                "thresholdPer":{
                    "description":"The threshold percentage for the PTP (Promise to Pay) type.",
                    "type":"number"
                },
                "ruleCd":{
                    "description":"The code for the rule associated with the PTP (Promise to Pay) type.",
                    "type":"string"
                },
                "DmTmPtpTypeSegmentsDTO":{
                    "type":"array",
                    "description":"An array of segments associated with the PTP (Promise to Pay) type.",
                    "items":{
                        "$ref":"#/definitions/DmTmPtpTypeSegmentsDTO"
                    }
                },
                "DmTmPtpTypeAlertConfigDTO":{
                    "type":"array",
                    "description":"An array of alert configurations associated with the PTP (Promise to Pay) type.",
                    "items":{
                        "$ref":"#/definitions/DmTmPtpTypeAlertConfigDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmPTPTypeDTO-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ptpTypeCd":{
            "description":"The code for the PTP (Promise to Pay) type.",
            "type":"string"
        },
        "ptpTypeDescr":{
            "description":"The description for the PTP (Promise to Pay) type.",
            "type":"string"
        },
        "graceDays":{
            "description":"The number of grace days allowed for the PTP (Promise to Pay) type.",
            "type":"integer"
        },
        "thresholdPer":{
            "description":"The threshold percentage for the PTP (Promise to Pay) type.",
            "type":"number"
        },
        "ruleCd":{
            "description":"The code for the rule associated with the PTP (Promise to Pay) type.",
            "type":"string"
        },
        "DmTmPtpTypeSegmentsDTO":{
            "type":"array",
            "description":"An array of segments associated with the PTP (Promise to Pay) type.",
            "items":{
                "$ref":"#/definitions/DmTmPtpTypeSegmentsDTO"
            }
        },
        "DmTmPtpTypeAlertConfigDTO":{
            "type":"array",
            "description":"An array of alert configurations associated with the PTP (Promise to Pay) type.",
            "items":{
                "$ref":"#/definitions/DmTmPtpTypeAlertConfigDTO"
            }
        }
    }
}

Nested Schema : DmTmPtpTypeAlertConfigDTO

Type: array

An array of alert configurations associated with the PTP (Promise to Pay) type.

Show Source

• Array of: object DmTmPtpTypeAlertConfigDTO

{
    "type":"array",
    "description":"An array of alert configurations associated with the PTP (Promise to Pay) type.",
    "items":{
        "$ref":"#/definitions/DmTmPtpTypeAlertConfigDTO"
    }
}

Nested Schema : DmTmPtpTypeSegmentsDTO

Type: array

An array of segments associated with the PTP (Promise to Pay) type.

Show Source

• Array of: object DmTmPtpTypeSegmentsDTO

{
    "type":"array",
    "description":"An array of segments associated with the PTP (Promise to Pay) type.",
    "items":{
        "$ref":"#/definitions/DmTmPtpTypeSegmentsDTO"
    }
}

Nested Schema : DmTmPtpTypeAlertConfigDTO

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "eventType":{
            "description":"Event type",
            "type":"string"
        },
        "remDays":{
            "description":"Remaining days",
            "type":"integer"
        },
        "sequence":{
            "description":"Sequence",
            "type":"integer"
        },
        "recipientType":{
            "description":"Recipient type",
            "type":"string"
        },
        "commMode":{
            "description":"Communication mode",
            "type":"string"
        },
        "templateCd":{
            "description":"Template code",
            "type":"string"
        },
        "ruleCd":{
            "description":"Rule code",
            "type":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "ptpTypeMasterId":{
            "description":"PTP type master ID",
            "type":"string"
        }
    }
}

Nested Schema : DmTmPtpTypeSegmentsDTO

Type: object

Show Source

• id(optional): string
  ID
• ptpTypeMasterId(optional): string
  PTP type master ID.
• segmentCd(optional): string
  Segment code

{
    "type":"object",
    "properties":{
        "segmentCd":{
            "description":"Segment code",
            "type":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "ptpTypeMasterId":{
            "description":"PTP type master ID.",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top