Jump to

• Request
• Response

Get All promise Detail by Account ID

get

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

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

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• type(required): string
  Type to define detail or history.

Query Parameters

• accountId(required): string
  Account ID for getting all promise detail.

Header Parameters

• appId(required): string
  Application ID for getting all promise detail.
• branchCode(required): string
  Branch Code for getting all promise detail.
• contentType: string
  Content Type for getting all promise detail.
• tenantId: string
  Tenant ID for getting all promise detail.
• userId(required): string
  User ID for getting all promise detail.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the quick promise detail based on given account id.

Body ()

Root Schema : PTPCollection

Type: object

Collection of Promise to Pay.

Show Source

• data: array data
• lookupDtoMap: 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: string
  Account ID for promise
• cancelReasonCode: string
  Cancelled Reason code for PTP
• caseId: string
  Case ID for promise
• createdBy: string
  PTP Created by user id
• createdDtTm: string
  Created PTP date and time
• currencyCode: string
  Currency Code promise
• id: string
  ID of promise
• lastBy: string
  Last updated PTP user
• lastUpdateDtTm: string
  Last time and date update PTP
• notes: string
  Notes of PTP
• promiseAmount: string
  Promise amount promise
• promiseDate: string
  Promise date for PTP
• ptpTransactionDto: array ptpTransactionDto
  PTP transactional Object
• ptpTypeCode: string
  PTP type code promise
• receivedAmount: string
  Received amount promise
• status: string
  Status of PTP
• taskId: string
  Task ID for promise
• taskTypeCd: string
  Task Type Code of the associated task.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of promise",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID for promise",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID for promise",
            "type":"string"
        },
        "ptpTypeCode":{
            "description":"PTP type code promise",
            "type":"string"
        },
        "promiseAmount":{
            "description":"Promise amount promise",
            "type":"string"
        },
        "receivedAmount":{
            "description":"Received amount promise",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency Code promise",
            "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"
        },
        "taskTypeCd":{
            "description":"Task Type Code of the associated task.",
            "type":"string"
        },
        "caseId":{
            "description":"Case ID for promise",
            "type":"string"
        },
        "ptpTransactionDto":{
            "type":"array",
            "description":"PTP transactional Object",
            "items":{
                "$ref":"#/definitions/PTPTransactionDto"
            }
        }
    }
}

Nested Schema : ptpTransactionDto

Type: array

PTP transactional Object

Show Source

• Array of: object PTPTransactionDto

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

Nested Schema : PTPTransactionDto

Type: object

Show Source

• id: string
  The unique identifier for the PTP Transaction.
• origReferenceNumber: string
  The original reference number for the PTP transaction.
• ptpMasterId: string
  The unique identifier for the PTP master record.
• referenceNumber: string
  The reference number for the PTP transaction.
• transactionAmount: string
  The amount of the PTP transaction.
• transactionDate: string
  The date the PTP transaction occurred.
• transactionType: 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

Show Source

• DmTmLookupCodeDTO: array DmTmLookupCodeDTO
• lookupTypeCd: string
  The lookup type code.
• lookupTypeDesc: string
  The lookup type description.

{
    "type":"object",
    "properties":{
        "lookupTypeCd":{
            "description":"The lookup type code.",
            "type":"string"
        },
        "lookupTypeDesc":{
            "description":"The lookup type description.",
            "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: boolean
  Enabled Flag
• id: string
  ID
• lookupCd: string
  Lookup Code
• lookupDesc: string
  Lookup Description
• lookupTypeMasterId: string
  Lookup Type Master ID
• seqNo: integer
  Minimum Value: 0

  Maximum Value: 999

  Sequence Number
• subCodeOne: string
  Sub Code One
• subCodeTwo: string
  Sub Code Two
• sysDefFlg: boolean
  System Def Flag

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"Lookup Code",
            "type":"string"
        },
        "lookupDesc":{
            "description":"Lookup Description",
            "type":"string"
        },
        "seqNo":{
            "description":"Sequence Number",
            "type":"integer",
            "minimum":0,
            "maximum":999
        },
        "sysDefFlg":{
            "description":"System Def Flag",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"Sub Code One",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"Sub Code Two",
            "type":"string"
        },
        "enabledFlg":{
            "description":"Enabled Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":"Lookup Type Master ID"
        }
    }
}

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