Jump to

• Request
• Response

Add New Promise to Pay

post

/obedm-ptp-services/ptp

This endpoint is used to add a new Promise to Pay.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request Body that contains data required for creating a new Promise To Pay.

Root Schema : DmPTPDtoCollection

Type: object

Show Source

• dmPtpDtoList(optional): array dmPtpDtoList

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

Nested Schema : dmPtpDtoList

Type: array

Show Source

• Array of: object DmPTPDto

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

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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of Promise To Pay is success or failure.

Headers

• Location: string
  URL of newly created Promise To Pay

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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

Back to Top