Read a progress pay event - Intergraph Smart Materials - Help - Hexagon

This API retrieves the details of all types of progress pay event present in the given agreement from a project. You can retrieve a single event using Id or multiple events from an agreement.

Required Privilege: API_AGREEMENT

Headers

Body

URL Format: Get https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/PurchaseOrders(‘:key1’)/ProgressPayEvents(':key2')

Specify values for the project, discipline, language, and key parameters in the URL. The project, discipline, and language together, define the project environment. The key1 parameter defines the purchase order ID (PohId) and key2 defines the progress pay events ID (AttpId).

To retrieve all the payment events, use the following URL.

Get https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/PurchaseOrders(‘:key1’)/ProgressPayEvents

Sample Code

GET http://localhost:63180/SMAT/V1/Projects('RS')/Disciplines('PIPING')/Nls('English')/PurchaseOrders(10000142039)/ProgressPayEvents(10000137116)

Success Response

Status: 200 OK

{

    "@odata.context": "http://localhost:57101/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/PurchaseOrders(10000142039)/ProgressPayEvents/$entity",

    "AttpId": 10000137116,

    "PohId": 10000142039,

    "DpId": 5020,

    "ProjId": "RS",

    "OrderSeq": 1,

    "PpeId": 10000004855,

    "PpeCode": "DEMO_PPE",

    "ShortDesc": null,

    "Description": null,

    "PlanCompletionDate": null,

    "PaymentPercent": 0,

    "PaymentWeeks": 0,

    "CostValue": 0,

    "PaymentDate": null,

    "LockedInd": "N",

    "ManualInd": "N",

    "DeliveryInd": "N",

    "ActualPaymentDate": null

}