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.
Request Body that contains data required for creating a new Promise To Pay.
Nested Schema : DmPTPDto
Type:
Show Source
object
-
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
Nested Schema : PTPTransactionDto
Type:
Show Source
object
-
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.
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
Nested Schema : ResponseResourceSupport
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