Jump to

• Request
• Response

Get All Promise to Pay Detail by Account ID

get

/obedm-ptp-services/ptp/{type}

This endpoint is used to Get all Promise to Pay details by account ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• type: string
  Type to define detail or history.

Query Parameters

• accountId: string
  Account ID for getting all Promise To Pay detail.

Header Parameters

• appId: string
  Application ID for getting all Promise To Pay detail.
• branchCode: string
  Branch Code for getting all Promise To Pay detail.
• contentType(optional): string
  Content Type for getting all Promise To Pay detail.
• tenantId(optional): string
  Tenant ID for getting all Promise To Pay detail.
• userId: string
  User ID for getting all Promise To Pay detail.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the quick Promise To Pay detail based on given account id.

Body ()

Root Schema : PTPCollection

Type: object

Collection of Promise to Pay.

Show Source

• data(optional): array data
• lookupDtoMap(optional): object lookupDtoMap
  Additional Properties Allowed: DmTmLookupTypeDTO

{
    "description":"Collection of Promise to Pay.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmPTPDto"
            }
        },
        "lookupDtoMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/DmTmLookupTypeDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmPTPDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmPTPDto"
    }
}

Nested Schema : lookupDtoMap

Type: object

Additional Properties Allowed

Show Source

• object DmTmLookupTypeDTO

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/DmTmLookupTypeDTO"
    }
}

Nested Schema : DmPTPDto

Type: object

Show Source

• accountId(optional): string
  Account ID for DM PTP DTO
• cancelReasonCode(optional): string
  Cancelled Reason code for PTP
• createdBy(optional): string
  PTP Created by user id
• createdDtTm(optional): string
  Created PTP date and time
• currencyCode(optional): string
  Currency Code for PTP DTO
• id(optional): string
  ID of DM PTP DTO
• lastBy(optional): string
  Last updated PTP user
• lastUpdateDtTm(optional): string
  Last time and date update PTP
• notes(optional): string
  Notes of PTP
• promiseAmount(optional): string
  Promise amount for PTP DTO
• promiseDate(optional): string
  Promise date for PTP
• ptpTransactionDto(optional): array ptpTransactionDto
  PTP transactional DTO
• ptpTypeCode(optional): string
  PTP type code for PTP DTO
• receivedAmount(optional): string
  Received amount for PTP DTO
• status(optional): string
  Status of PTP
• taskId(optional): string
  Task ID for DM PTP DTO

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of DM PTP DTO",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID for DM PTP DTO",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID for DM PTP DTO",
            "type":"string"
        },
        "ptpTypeCode":{
            "description":"PTP type code for PTP DTO",
            "type":"string"
        },
        "promiseAmount":{
            "description":"Promise amount for PTP DTO",
            "type":"string"
        },
        "receivedAmount":{
            "description":"Received amount for PTP DTO",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency Code for PTP DTO",
            "type":"string"
        },
        "status":{
            "description":"Status of PTP",
            "type":"string"
        },
        "promiseDate":{
            "description":"Promise date for PTP",
            "type":"string"
        },
        "cancelReasonCode":{
            "description":"Cancelled Reason code for PTP",
            "type":"string"
        },
        "notes":{
            "description":"Notes of PTP",
            "type":"string"
        },
        "createdBy":{
            "description":"PTP Created by user id",
            "type":"string"
        },
        "createdDtTm":{
            "description":"Created PTP date and time ",
            "type":"string"
        },
        "lastBy":{
            "description":"Last updated PTP user",
            "type":"string"
        },
        "lastUpdateDtTm":{
            "description":"Last time and date update PTP",
            "type":"string"
        },
        "ptpTransactionDto":{
            "type":"array",
            "description":"PTP transactional DTO",
            "items":{
                "$ref":"#/definitions/PTPTransactionDto"
            }
        }
    }
}

Nested Schema : ptpTransactionDto

Type: array

PTP transactional DTO

Show Source

• Array of: object PTPTransactionDto

{
    "type":"array",
    "description":"PTP transactional DTO",
    "items":{
        "$ref":"#/definitions/PTPTransactionDto"
    }
}

Nested Schema : PTPTransactionDto

Type: object

Show Source

• id(optional): string
  The unique identifier for the PTP Transaction.
• origReferenceNumber(optional): string
  The original reference number for the PTP transaction.
• ptpMasterId(optional): string
  The unique identifier for the PTP master record.
• referenceNumber(optional): string
  The reference number for the PTP transaction.
• transactionAmount(optional): string
  The amount of the PTP transaction.
• transactionDate(optional): string
  The date the PTP transaction occurred.
• transactionType(optional): string
  The type of PTP transaction that occurred.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the PTP Transaction.",
            "type":"string"
        },
        "transactionDate":{
            "description":"The date the PTP transaction occurred.",
            "type":"string"
        },
        "transactionType":{
            "description":"The type of PTP transaction that occurred.",
            "type":"string"
        },
        "transactionAmount":{
            "description":"The amount of the PTP transaction.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"The reference number for the PTP transaction.",
            "type":"string"
        },
        "origReferenceNumber":{
            "description":"The original reference number for the PTP transaction.",
            "type":"string"
        },
        "ptpMasterId":{
            "description":"The unique identifier for the PTP master record.",
            "type":"string"
        }
    }
}

Nested Schema : DmTmLookupTypeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmLookupTypeDTO-allOf[1]

{
    "type":"object",
    "required":[
        "lookupTypeCd",
        "lookupTypeDesc",
        "sysDefFlg"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "lookupTypeCd":{
                    "description":"The code representing the type of the lookup.",
                    "type":"string"
                },
                "lookupTypeDesc":{
                    "description":"A description of the type of the lookup.",
                    "type":"string"
                },
                "sysDefFlg":{
                    "description":"A flag indicating whether this lookup is a system default.",
                    "type":"boolean"
                },
                "sysDefStatus":{
                    "description":"The status of the system default lookup.",
                    "type":"string"
                },
                "DmTmLookupCodeDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmLookupCodeDTO"
                    }
                }
            }
        }
    ]
}

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 : DmTmLookupTypeDTO-allOf[1]

Type: object

Show Source

• DmTmLookupCodeDTO(optional): array DmTmLookupCodeDTO
• lookupTypeCd(optional): string
  The code representing the type of the lookup.
• lookupTypeDesc(optional): string
  A description of the type of the lookup.
• sysDefFlg(optional): boolean
  A flag indicating whether this lookup is a system default.
• sysDefStatus(optional): string
  The status of the system default lookup.

{
    "type":"object",
    "properties":{
        "lookupTypeCd":{
            "description":"The code representing the type of the lookup.",
            "type":"string"
        },
        "lookupTypeDesc":{
            "description":"A description of the type of the lookup.",
            "type":"string"
        },
        "sysDefFlg":{
            "description":"A flag indicating whether this lookup is a system default.",
            "type":"boolean"
        },
        "sysDefStatus":{
            "description":"The status of the system default lookup.",
            "type":"string"
        },
        "DmTmLookupCodeDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmLookupCodeDTO"
            }
        }
    }
}

Nested Schema : DmTmLookupCodeDTO

Type: array

Show Source

• Array of: object DmTmLookupCodeDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmLookupCodeDTO"
    }
}

Nested Schema : DmTmLookupCodeDTO

Type: object

Show Source

• enabledFlg(optional): boolean
  The flag indicating if the lookup is enabled.
• id(optional): string
  The unique identifier for the lookup.
• lookupCd(optional): string
  The code for the lookup.
• lookupDesc(optional): string
  The description for the lookup.
• lookupTypeMasterId(optional): string
  The unique identifier for the lookup type of this lookup.
• seqNo(optional): integer
  Minimum Value: 0

  Maximum Value: 999

  The sequence number of the lookup.
• subCodeOne(optional): string
  The first sub-code for the lookup.
• subCodeTwo(optional): string
  The second sub-code for the lookup.
• sysDefFlg(optional): boolean
  The flag indicating if the lookup is system-defined.

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"The code for the lookup.",
            "type":"string"
        },
        "lookupDesc":{
            "description":"The description for the lookup.",
            "type":"string"
        },
        "seqNo":{
            "description":"The sequence number of the lookup.",
            "type":"integer",
            "minimum":0,
            "maximum":999
        },
        "sysDefFlg":{
            "description":"The flag indicating if the lookup is system-defined.",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"The first sub-code for the lookup.",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"The second sub-code for the lookup.",
            "type":"string"
        },
        "enabledFlg":{
            "description":"The flag indicating if the lookup is enabled.",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"The unique identifier for the lookup."
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":"The unique identifier for the lookup type of this lookup."
        }
    }
}

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