Subcontract
Endpoints
SubContractClaimApprovalApi
[Description]
/api/SubContractClaimApprovalApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
|
|
|
|
SubContractClaimDetailApi
[Description]
/api/SubContractClaimDetailApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| subContractCode * |
|
|
POST |
|
|
|
|
SubContractClaimEntryApi
[Description]
/api/SubContractClaimEntryApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
DELETE |
|
|
|
|
GET |
|
|
|
|
POST |
|
|
|
|
SubContractClaimListApi
[Description]
/api/SubContractClaimListApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
|
|
|
|
SubContractClaimUnapprovalApi
[Description]
/api/SubContractClaimUnapprovalApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
|
|
|
|
SubContractListApi
[Description]
/api/SubContractListApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
|
|
|
|
Models
SubContractClaimApiFields
Property | Data Type | Description |
---|---|---|
Key |
| |
SubContractCode | Subcontract code. | |
JobCode | Job code. | |
CompanyID | Company id. | |
InvoiceNumber | Invoice number. | |
SubContractClaimNo | Subcontract claim number. | |
Details | Details | |
FinalClaim | Final claim status. | |
OnHold | On hold. | |
InvoiceDate | Invoice date. | |
PaymentDate | Payment date. | |
ReceivedDate | Receive date. | |
ApprovedDate | Approve date. | |
CurrencyCode | Code of currency. | |
FCFixed | Foreign currency. | |
FCConversionRate | Foreign currency rate. | |
ApprovedBy | Approved by | |
VoucherID | Voucher id. | |
RetentionType | Type of retention. | |
ApprovalRequiredBy |
| |
ApprovalNotify | Approval notification. |
SubContractClaimApiModel
Property | Data Type | Description |
---|---|---|
Key |
| |
SubContractClaimFields |
| |
SubContractDetailsFields |
| |
SubContractWorkOrderEntries |
|
SubContractsClaimableFields
Property | Data Type | Description |
---|---|---|
ExpandAll |
| |
CollapseAll |
| |
NewWorkOrder |
| |
Filter |
| |
Layout | Layout |
|
SubContractDetailsApiFields
Property | Data Type | Description |
---|---|---|
Status |
|
SubContractClaimEntryApiModel
Property | Data Type | Description |
---|---|---|
Key |
| |
MainFields |
| |
ClaimableFields |
| |
SuccessMessage | String |
|
AlertMessage | String |
|
ValidationErrors | Array[MvcValidationError] |
|
SubContractsMainFields
Property | Data Type | Description |
---|---|---|
SubContract |
| |
Job | Job. | |
Contractor | Contractor. | |
ClaimNo | Claim number. | |
Reference | Reference text. | |
Details | Details. | |
Status | Status. | |
SecuritiesAct |
| |
ValueAsRecorded |
| |
FinalClaim | Final Claim. | |
ClaimDate | Claim date. | |
ReceivedDate | Received date. | |
ClaimToDate | Claim to date. | |
ProcessDate | Process date. | |
CertificationDue | Certificate due on. | |
EditablePaymentDue |
| |
DefaultPaymentDue | String | Default payment due |
ResetDueDate | Reset the due date. | |
Approved |
| |
Currency | The currency. | |
Rate | Rate | |
Fixed |
| |
AssignedApprover | Assigned person as approver. | |
RetentionTrustAccount | ||
ApprovedBy | Person made approval. | |
ApprovedByDisplay | Person made approval. | |
Approvers | Array[string] | Approvers person. |
PaymentDate | Payment date. | |
WorkflowStatus | Workflow status. | |
WorkflowType | Workflow type. | |
BatchNo | Batch number. | |
IsApproved | Boolean | Approval status. |
ApprovalAuditInfo | String | Approval status info. |
Layout | Layout. | Layout. |
SubContractsSubContractClaimKey
Property | Data Type | Description |
---|---|---|
SubContractCode | String | Subcontract code. |
APInvoiceID | Integer | AP Invoice id |
JobCode | String | Job code. |
SubContractCompID | Integer | Subcontract company id. |
SubContractClaimTabs | String |
|
SubContractsSubContractClaimLine
Property | Data Type | Description |
---|---|---|
No | Line number. | |
InvoiceNo | Invoice number | |
Date | String | Date |
Batched | Batched status. | |
BatchNo | Batch number. | |
SubClaimedThisClaim | Sub claimed this claim amount. | |
SubClaimedToDate | Sub claimed to date amount. | |
CertifiedToDate | Certified to date amount. | |
CertifiedThisClaim | Certified this claim amount. | |
NetRetentions | Net retention amount. | |
RetentionRelease | Retention release amount. | |
NetCertified | Net certified amount. | |
GST | Tax. | |
GrossCertified | Gross certified amount | |
Notes | Comment. | |
ApprovalRequiredBy | Required approval by person. | |
ApprovedBy | Person made approval. | |
VoucherValue | Voucher value. | |
PaidTotal | Total paid amount. | |
HasDatasheet | Datasheet. | |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
SubContractsSubContractClaimEntryKey
Property | Data Type | Description |
---|---|---|
SubContractCode | String | Subcontract code. |
ApInvoiceId | Integer | AP invoice id. |
IsRetentionRelease | Boolean | Retention release status. |
IsPtaJob | Boolean | PTA job status. |
SubContractsSubContractClaimSaveResult
Property | Data Type | Description |
---|---|---|
tabForm | Object |
|
mainGrid | Object |
|
claimableGrid | Object |
|
successMessage | String | Sucess message. |
warningMessage | String | Warning message. |
errorMessage | String | Error message. |
validationErrors | Array [MvcValidationError] |
|
KeyStr | String |
|
KeyDate | String |
|
KeyInt | Integer |
|
SubContractsSubContractKey
Property | Data Type | Description |
---|---|---|
SubContractCode | String | Subcontract code. |
SubContractsSubContractWorkOrderEntryLine
Property | Data Type | Description |
---|---|---|
LineStatusID | Integer | Line status id. |
SequenceNo | Integer | Sequence number. |
LineReference | String | Reference. |
State | String |
|
Job | String | Job |
WorkCentreCode | String | Work Centre code |
ActivityCode | String | Activity code. |
LineDescription | String | Line description. |
OrderQuantity | Number | Order quantity on the line |
OrderCost | Number | Cost (Unit Rate x Quantity) |
ClaimedQty | Claimed quantity. | |
ClaimedValue | Claimed value. | |
CertifiedToDateQuantity | Quanity certified to date. | |
CertifiedToDateValue | Value certified to date. | |
PreviouslyCertifiedQuantity | Number | Previous certified quantity. |
PreviouslyCertifiedValue | Number | Previous certified value. |
CertifiedThisClaimQuantity | Number | Quantity certified this claim. |
CertifiedThisClaimValue | Number | Value certified this claim. |
UnapprovedQuantity | Number | Unapproved quanity. |
UnapprovedValue | Number | Unapproved value. |
UnapprovedReason | Unapproved reason. | |
InternalNotes | Note. | |
DeclineValue | Decline value. | |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
SubContractsSubContractWorkOrderKey
Property | Data Type | Description |
---|---|---|
Changed | String |
|
WOType | String | Work Order type. |
JobCode | String | Job code. |
WONumber | Integer | Work Order number. |
PurchaseOrderLineID | Integer | id of Purchase Order line . |
SubContractsSubContractWorkOrderEntryLine
Property | Data Type | Description |
---|---|---|
LineStatusID | Integer | Line status id. |
SequenceNo | Integer | Sequence number. |
LineReference | String | Reference. |
State | String |
|
Job | String | Job |
WorkCentreCode | String | Work Centre code |
ActivityCode | String | Activity code. |
LineDescription | String | Line description. |
OrderQuantity | Number | Quantity ordered. |
OrderCost | Number | Order Cost |
ClaimedQty | Claimed quanity. | |
ClaimedValue | Claimed value. | |
CertifiedToDateQuantity | Quanity certified to date. | |
CertifiedToDateValue | Value certified to date. | |
PreviouslyCertifiedQuantity | Number | Previous certified quantity |
PreviouslyCertifiedValue | Number | Previous certified value. |
CertifiedThisClaimQuantity | Number |
|
CertifiedThisClaimValue | Number |
|
UnapprovedQuantity | Number | Unapproved quanity. |
UnapprovedValue | Number | Unapproved value. |
UnapprovedReason | Unapproved reason. | |
InternalNotes | Internal note. | |
DeclineValue | Decline value. | |
Status | String | Status |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
Example
%title
- 1 Endpoints
- 2 Models
- 2.1 SubContractClaimApiFields
- 2.2 SubContractClaimApiModel
- 2.3 SubContractsClaimableFields
- 2.4 SubContractDetailsApiFields
- 2.5 SubContractClaimEntryApiModel
- 2.6 SubContractsMainFields
- 2.7 SubContractsSubContractClaimKey
- 2.8 SubContractsSubContractClaimLine
- 2.9 SubContractsSubContractClaimEntryKey
- 2.10 SubContractsSubContractClaimSaveResult
- 2.11 SubContractsSubContractKey
- 2.12 SubContractsSubContractWorkOrderEntryLine
- 2.13 SubContractsSubContractWorkOrderKey
- 2.14 SubContractsSubContractWorkOrderEntryLine
- 3 Example
- 3.1 %title