| POST,OPTIONS | /v1/projects/{ProjectID}/pay-apps/{PeriodNumber}/certify |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProjectID | path | int | No | |
| PeriodNumber | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Application | form | PayApplication | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PayApplicationID | form | int | No | |
| PayApplicationUID | form | Guid | No | |
| ProjectID | form | int | No | |
| PeriodNumber | form | int | No | |
| PeriodStart | form | DateTime? | No | |
| PeriodEnd | form | DateTime? | No | |
| Status | form | string | No | |
| BillingTemplate | form | string | No | |
| RetainagePct | form | decimal | No | |
| OriginalContractSum | form | decimal | No | |
| NetChangeByCO | form | decimal | No | |
| ContractSumToDate | form | decimal | No | |
| CompletedStoredToDate | form | decimal | No | |
| RetainageAmount | form | decimal | No | |
| EarnedLessRetainage | form | decimal | No | |
| LessPreviousCertificates | form | decimal | No | |
| CurrentPaymentDue | form | decimal | No | |
| BalanceToFinish | form | decimal | No | |
| InvoiceID | form | int? | No | |
| CertifiedAt | form | DateTime? | No | |
| CertifiedBy | form | string | No | |
| CreatedBy | form | string | No | |
| CreatedAt | form | DateTime? | No | |
| UpdatedAt | form | DateTime? | No | |
| Lines | form | List<PayApplicationLine> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PayApplicationLineID | form | int | No | |
| PayApplicationID | form | int | No | |
| CostCode | form | string | No | |
| Description | form | string | No | |
| ScheduledValue | form | decimal | No | |
| FromPreviousPct | form | decimal | No | |
| ThisPeriodPct | form | decimal | No | |
| StoredMaterials | form | decimal | No | |
| IsChangeOrder | form | bool | No | |
| ChangeOrderID | form | int? | No | |
| SortOrder | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/projects/{ProjectID}/pay-apps/{PeriodNumber}/certify HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ProjectID: 0,
PeriodNumber: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Application:
{
PayApplicationID: 0,
PayApplicationUID: 00000000000000000000000000000000,
ProjectID: 0,
PeriodNumber: 0,
PeriodStart: 0001-01-01,
PeriodEnd: 0001-01-01,
Status: String,
BillingTemplate: String,
RetainagePct: 0,
OriginalContractSum: 0,
NetChangeByCO: 0,
ContractSumToDate: 0,
CompletedStoredToDate: 0,
RetainageAmount: 0,
EarnedLessRetainage: 0,
LessPreviousCertificates: 0,
CurrentPaymentDue: 0,
BalanceToFinish: 0,
InvoiceID: 0,
CertifiedAt: 0001-01-01,
CertifiedBy: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01,
Lines:
[
{
PayApplicationLineID: 0,
PayApplicationID: 0,
CostCode: String,
Description: String,
ScheduledValue: 0,
FromPreviousPct: 0,
ThisPeriodPct: 0,
StoredMaterials: 0,
IsChangeOrder: False,
ChangeOrderID: 0,
SortOrder: 0
}
]
}
}