Subcontract

Endpoints

SubContractClaimApprovalApi

[Description]

/api/SubContractClaimApprovalApi

/api/SubContractClaimApprovalApi

Operation

Logged in User

Parameters

Body

Response

POST

 

 

 

 

 

SubContractClaimDetailApi

[Description]

/api/SubContractClaimDetailApi

/api/SubContractClaimDetailApi

Operation

Logged in User

Parameters

Body

Response

GET

 

subContractCode *
aPInvoiceID *
jobCode
subContractCompID
subContractClaimTabs

 

 

POST

 

 

 

 

 

SubContractClaimEntryApi

[Description]

/api/SubContractClaimEntryApi

/api/SubContractClaimEntryApi

Operation

Logged in User

Parameters

Body

Response

DELETE

 

 

 

 

GET

 

 

 

 

POST

 

 

 

 

 

SubContractClaimListApi

[Description]

/api/SubContractClaimListApi

/api/SubContractClaimListApi

Operation

Logged in User

Parameters

Body

Response

POST

 

 

 

 

 

SubContractClaimUnapprovalApi

[Description]

/api/SubContractClaimUnapprovalApi

/api/SubContractClaimUnapprovalApi

Operation

Logged in User

Parameters

Body

Response

POST

 

 

 

 

 

SubContractListApi

[Description]

/api/SubContractListApi

/api/SubContractListApi

Operation

Logged in User

Parameters

Body

Response

POST

 

 

 

 

 

Models

 

SubContractClaimApiFields

Property

Data Type

Description

Property

Data Type

Description

Key

SubContractsSubContractClaimKey

 

SubContractCode

StringViewData

Subcontract code.

JobCode

StringViewData

Job code.

CompanyID

StringViewData

Company id.

InvoiceNumber

StringViewData

Invoice number.

SubContractClaimNo

DecimalViewData

Subcontract claim number.

Details

StringViewData

Details

FinalClaim

BoolViewData

Final claim status.

OnHold

BoolViewData

On hold.

InvoiceDate

DateViewData

Invoice date.

PaymentDate

DateViewData

Payment date.

ReceivedDate

DateViewData

Receive date.

ApprovedDate

DateViewData

Approve date.

CurrencyCode

DropdownViewData

Code of currency.

FCFixed

DropdownViewData

Foreign currency.

FCConversionRate

DecimalViewData

Foreign currency rate.

ApprovedBy

PickerViewData

Approved by

VoucherID

DecimalViewData

Voucher id.

RetentionType

DropdownViewData

Type of retention.

ApprovalRequiredBy

PickerViewData

 

ApprovalNotify

BoolViewData

Approval notification.

Back to top

 

SubContractClaimApiModel

Property

Data Type

Description

Property

Data Type

Description

Key

SubContractsSubContractClaimKey

 

SubContractClaimFields

SubContractClaimApiFields

 

SubContractDetailsFields

SubContractDetailsApiFields

 

SubContractWorkOrderEntries

GridResult_SubContractsSubContractWorkOrderEntryLine

 

Back to top

 

SubContractsClaimableFields

Property

Data Type

Description

Property

Data Type

Description

ExpandAll

ButtonViewData

 

CollapseAll

ButtonViewData

 

NewWorkOrder

ButtonViewData

 

Filter

DropdownViewData

 

Layout

Layout

 

Back to top

 

SubContractDetailsApiFields

Property

Data Type

Description

Property

Data Type

Description

Status

DropdownViewData

 

Back to top

 

SubContractClaimEntryApiModel

Property

Data Type

Description

Property

Data Type

Description

Key

SubContractsSubContractClaimEntryKey

 

MainFields

SubContractsMainFields

 

ClaimableFields

SubContractsClaimableFields

 

SuccessMessage

String

 

AlertMessage

String

 

ValidationErrors

Array[MvcValidationError]

 

Back to top

 

SubContractsMainFields

Property

Data Type

Description

Property

Data Type

Description

SubContract

StringViewData

 

Job

StringViewData

Job.

Contractor

StringViewData

Contractor.

ClaimNo

StringViewData

Claim number.

Reference

StringViewData

Reference text.

Details

StringViewData

Details.

Status

DropdownViewData

Status.

SecuritiesAct

DropdownViewData

 

ValueAsRecorded

DecimalViewData

 

FinalClaim

BoolViewData

Final Claim.

ClaimDate

DateViewData

Claim date.

ReceivedDate

DateViewData

Received date.

ClaimToDate

DateViewData

Claim to date.

ProcessDate

DateViewData

Process date.

CertificationDue

DateViewData

Certificate due on.

EditablePaymentDue

DateViewData

 

DefaultPaymentDue

String

Default payment due

ResetDueDate

ButtonViewData

Reset the due date.

Approved

DateViewData

 

Currency

StringViewData

The currency.

Rate

DecimalViewData

Rate

Fixed

BoolViewData

 

AssignedApprover

DropdownViewData

Assigned person as approver.

RetentionTrustAccount

PickerViewData

Retention Trust Account

ApprovedBy

DropdownViewData

Person made approval.

ApprovedByDisplay

StringViewData

Person made approval.

Approvers

Array[string]

Approvers person.

PaymentDate

DateViewData

Payment date.

WorkflowStatus

StringViewData

Workflow status.

WorkflowType

PickerViewData

Workflow type.

BatchNo

StringViewData

Batch number.

IsApproved

Boolean

Approval status.

ApprovalAuditInfo

String

Approval status info.

Layout

Layout.

Layout.

Back to top

 

SubContractsSubContractClaimKey

Property

Data Type

Description

Property

Data Type

Description

SubContractCode

String

Subcontract code.

APInvoiceID

Integer

AP Invoice id

JobCode

String

Job code.

SubContractCompID

Integer

Subcontract company id.

SubContractClaimTabs

String

 

Back to top

 

SubContractsSubContractClaimLine

Property

Data Type

Description

Property

Data Type

Description

No

CellData

Line number.

InvoiceNo

CellData

Invoice number

Date

String

Date

Batched

CellData

Batched status.

BatchNo

CellData

Batch number.

SubClaimedThisClaim

CellData

Sub claimed this claim amount.

SubClaimedToDate

CellData

Sub claimed to date amount.

CertifiedToDate

CellData

Certified to date amount.

CertifiedThisClaim

CellData

Certified this claim amount.

NetRetentions

CellData

Net retention amount.

RetentionRelease

CellData

Retention release amount.

NetCertified

CellData

Net certified amount.

GST

CellData

Tax.

GrossCertified

CellData

Gross certified amount

Notes

CellData

Comment.

ApprovalRequiredBy

CellData

Required approval by person.

ApprovedBy

CellData

Person made approval.

VoucherValue

CellData

Voucher value.

PaidTotal

CellData

Total paid amount.

HasDatasheet

CellData

Datasheet.

Status

String

Status.

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

SubContractsSubContractClaimKey

 

CurrentKey

SubContractsSubContractClaimKey

 

Key

SubContractsSubContractClaimKey

 

Index

Integer

 

Back to top

 

SubContractsSubContractClaimEntryKey

Property

Data Type

Description

Property

Data Type

Description

SubContractCode

String

Subcontract code.

ApInvoiceId

Integer

AP invoice id.

IsRetentionRelease

Boolean

Retention release status.

IsPtaJob

Boolean

PTA job status.

Back to top

 

SubContractsSubContractClaimSaveResult

Property

Data Type

Description

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

 

Back to top

 

SubContractsSubContractKey

Property

Data Type

Description

Property

Data Type

Description

SubContractCode

String

Subcontract code.

Back to top

 

SubContractsSubContractWorkOrderEntryLine

Property

Data Type

Description

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

CellData

Claimed quantity.

ClaimedValue

CellData

Claimed value.

CertifiedToDateQuantity

CellData

Quanity certified to date.

CertifiedToDateValue

CellData

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

CellData

Unapproved reason.

InternalNotes

CellData

Note.

DeclineValue

CellData

Decline value.

Status

String

Status.

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

SubContractsSubContractWorkOrderKey

 

CurrentKey

SubContractsSubContractWorkOrderKey

 

Key

SubContractsSubContractWorkOrderKey

 

Index

Integer

 

Back to top

 

SubContractsSubContractWorkOrderKey

Property

Data Type

Description

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 .

Back to top

 

SubContractsSubContractWorkOrderEntryLine

Property

Data Type

Description

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

CellData

Claimed quanity.

ClaimedValue

CellData

Claimed value.

CertifiedToDateQuantity

CellData

Quanity certified to date.

CertifiedToDateValue

CellData

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

CellData

Unapproved reason.

InternalNotes

CellData

Internal note.

DeclineValue

CellData

Decline value.

Status

String

Status

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

SubContractsSubContractWorkOrderKey

 

CurrentKey

SubContractsSubContractWorkOrderKey

 

Key

SubContractsSubContractWorkOrderKey

 

Index

Integer

 

Back to top

Example

%title

Request

Response

Response sample

Top of page