This API creates the details of all types of Progress Pay Events (PPEs) in a given agreement of a project in Smart Materials.
This API creates a new PPE as well as return all the existing PPEs of the given agreement.
Required Privilege: API_AGREEMENT
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: POST https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/PurchaseOrders(‘:key’)/CreateUpdateProgressPayEvents
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment. The key parameter defines the purchase order ID (PohId).
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
OrderSeq |
Order sequence. |
Integer |
Required |
Maximum allowed value is 99999 |
|
PpeId |
Unique ID of the progress pay event. |
Integer |
Optional |
|
|
PpeCode |
Name (code) of the progress pay event. |
Integer |
Required |
Maximum allowed length is 10 |
|
PaymentPercent |
Payment percentage associated with the progress pay event. It is related to the payment weeks.
|
Integer |
Required/ Optional |
Default value is 0. |
|
PaymentWeeks |
Refers to the number of weeks for payment related to the progress pay event. |
Integer |
Optional |
|
|
CostValue |
The cost value of the progress pay event. It provides information about the financial value associated with the PPE.
|
Integer |
Required/ Optional |
|
|
PlanCompletiondate |
Planned completion date for the progress pay event. |
DateTimeOffset |
Optional |
|
|
PaymentDate |
Represents the date when the payment for the progress pay event is scheduled or made.
|
DateTimeOffset |
Optional |
|
|
LockedInd |
Indicates whether the progress pay event is locked or not. Available values are Y and N and default value is N. |
String |
Optional |
|
|
DeliveryInd |
Indicates whether the progress pay event is successfully delivered or not. Available values are Y and N and default value is N. |
String |
Optional |
|
|
ManualInd |
Indicates whether the progress pay event is manually managed or automated. Available values are Y and N and default value is N.
|
String |
Optional |
|
|
ShortDescription |
Language dependent short description of progress pay event.
|
String |
Optional |
|
|
Description |
Language dependent description of the progress pay event.
|
String |
Optional |
Maximum allowed length is 500. |
|
ActualPaymentDate |
The actual date when the payment for the pay event will be made. |
DateTimeOffset |
Optional |
|
|
PaidInd |
Indicates whether the progress pay event is paid or not. Available values are Y and N and default value is N.
|
String |
Optional |
Sample Code
POST http://localhost:63180/SMAT/V1/Projects('RS')/Disciplines('PIPING')/Nls('English')/PurchaseOrders(10000133309)/CreateUpdateProgressPayEvents
{
"PPE":
[
{
"OrderSeq": 1,
"PpeCode": "PPE1",
"PaymentPercent":50,
"CostValue": 0,
"PpeId":null,
"ShortDesc": null,
"Description": null,
"PlanCompletionDate": null,
"PaymentWeeks": null,
"PaymentDate": null,
"LockedInd": "N",
"DeliveryInd": "N",
"ActualPaymentDate": null,
"PaidInd":"N"
},
{
"OrderSeq": 2,
"PpeCode": "PPE2",
"PaymentPercent":0,
"CostValue": 10,
"PpeId":null,
"ShortDesc": null,
"Description": null,
"PlanCompletionDate": null,
"PaymentWeeks": null,
"PaymentDate": null,
"LockedInd": "N",
"DeliveryInd": "Y",
"ActualPaymentDate": null,
"PaidInd":"Y"
},
{
"OrderSeq": 3,
"PpeCode": "INSTALL",
"PaymentPercent":0,
"CostValue": 80,
"PpeId":null,
"ShortDesc": null,
"Description": null,
"PlanCompletionDate": null,
"PaymentWeeks": null,
"PaymentDate": "2024-01-05",
"LockedInd": "N",
"DeliveryInd": "N",
"ActualPaymentDate": null,
"PaidInd":"N"
},
{
"OrderSeq": 4,
"PpeCode": "H-1",
"PaymentPercent":5,
"CostValue": 0,
"PpeId":null,
"ShortDesc": null,
"Description": null,
"PlanCompletionDate": null,
"PaymentWeeks": null,
"PaymentDate": null,
"LockedInd": "N",
"DeliveryInd": "N",
"ActualPaymentDate": null,
"PaidInd":"N"
}
]
}
Success Response
Status: 200 OK
{
"@odata.context": "http://localhost:57101/SMAT/V1/$metadata#bindingParamater",
"value": [
{
"AttpId": 10000143438,
"PohId": 10000133309,
"DpId": 5020,
"ProjId": "RS",
"OrderSeq": 1,
"PpeId": 10000005555,
"PpeCode": "PPE1",
"ShortDesc": null,
"Description": null,
"PlanCompletionDate": null,
"PaymentPercent": 50,
"PaymentWeeks": null,
"CostValue": 100,
"PaymentDate": null,
"LockedInd": "N",
"ManualInd": "N",
"DeliveryInd": "N",
"ActualPaymentDate": null,
"PaidInd": "N"
},
{
"AttpId": 10000143439,
"PohId": 10000133309,
"DpId": 5020,
"ProjId": "RS",
"OrderSeq": 2,
"PpeId": 10000005556,
"PpeCode": "PPE2",
"ShortDesc": null,
"Description": null,
"PlanCompletionDate": null,
"PaymentPercent": 5,
"PaymentWeeks": null,
"CostValue": 10,
"PaymentDate": null,
"LockedInd": "N",
"ManualInd": "N",
"DeliveryInd": "Y",
"ActualPaymentDate": "2024-01-06T15:46:46+05:30",
"PaidInd": "Y"
},
{
"AttpId": 10000143440,
"PohId": 10000133309,
"DpId": 5020,
"ProjId": "RS",
"OrderSeq": 3,
"PpeId": 5204,
"PpeCode": "INSTALL",
"ShortDesc": "Installation",
"Description": "Installation completed",
"PlanCompletionDate": null,
"PaymentPercent": 40,
"PaymentWeeks": null,
"CostValue": 80,
"PaymentDate": "2024-01-05T00:00:00+05:30",
"LockedInd": "N",
"ManualInd": "Y",
"DeliveryInd": "N",
"ActualPaymentDate": null,
"PaidInd": "N"
},
{
"AttpId": 10000143441,
"PohId": 10000133309,
"DpId": 5020,
"ProjId": "RS",
"OrderSeq": 4,
"PpeId": 5323,
"PpeCode": "H-1",
"ShortDesc": "H-1",
"Description": "H-1",
"PlanCompletionDate": null,
"PaymentPercent": 5,
"PaymentWeeks": null,
"CostValue": 10,
"PaymentDate": null,
"LockedInd": "N",
"ManualInd": "N",
"DeliveryInd": "N",
"ActualPaymentDate": null,
"PaidInd": "N"
}
]
}