Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


This structure contains the set of data that are key when managing a cost card that has been submitted for approval.

Format


PwsCostCardManagementData
  • PwsCostCardManagementData
    • AccountingPeriodClosedFlag: Boolean
    • ApprovalWorkflowFlag: Boolean
    • ApproverFlag: Boolean
    • ApproverToInvoiceFlag: Boolean
    • ApproverToPayFlag: Boolean
    • ApproversCanRejectApprovedExpensesFlag: Boolean
    • AutoApprovalFlag: Boolean
    • AutoApprovalToInvoiceFlag: Boolean
    • AutoApprovalToPayFlag: Boolean
    • AwsApprovedStatusAllowedFlag: Boolean
    • AwsDraftStatusAllowedFlag: Boolean
    • AwsRejectedStatusAllowedFlag: Boolean
    • AwsSubmittedStatusAllowedFlag: Boolean
    • CanAdjustFlag: Boolean
    • CanEditFlag: Boolean
    • ClientIdentity: PwsClientRef
    • ClientName: String
    • DisbursedCurrencyDecimalDigits: Byte
    • DisbursedCurrencyIdentity: PwsCurrencyRef
    • DisbursingCostCenterIdentity: PwsCostCenterRef
    • EditSubmitFlag: Boolean
    • ExpenseDocumentIdentity: PwsExpenseDocumentRef
    • ExpenseDocumentName: String
    • ExpenseDocumentTimestamp: String
    • ExpenseDocumentType: String
    • ExpenseDocumentVatFlag: Boolean
    • IwsApprovedStatusAllowedFlag: Boolean
    • IwsDraftInvoiceStatusAllowedFlag: Boolean
    • IwsInvoicedStatusAllowedFlag: Boolean
    • IwsUnapprovedStatusAllowedFlag: Boolean
    • MileageUom: String
    • PwsApprovedStatusAllowedFlag: Boolean
    • PwsPaidStatusAllowedFlag: Boolean
    • PwsReceivedStatusAllowedFlag: Boolean
    • PwsTransmittedStatusAllowedFlag: Boolean
    • PwsUnapprovedStatusAllowedFlag: Boolean

Elements


Element

Data Type

Required?

Default

Description

Sample Data

AccountingPeriodClosedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', the accounting period this cost card falls under is closed for cost

false

ApprovalWorkflowFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', the authenticated user can update the approval workfow status of the cost card

true 

ApproverFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', the authenticated user is an approver of the cost card

false

ApproverToInvoiceFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', the authenticated user can approve the cost card to invoice

true 

ApproverToPayFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', the authenticated user can approve the cost card to pay

false

ApproversCanRejectApprovedExpensesFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', approvers in this installation can rejected cost cards that have been approved

false 

AutoApprovalFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card is subject to auto approval

false 

AutoApprovalToInvoiceFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card is subject to auto approval to invoice

false

AutoApprovalToPayFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card is subject to auto approval to pay

false

AwsApprovedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the approval workflow status of approved

false 

AwsDraftStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the approval workflow status of draft

false

AwsRejectedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the approval workflow status of rejected

false

AwsSubmittedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the approval workflow status of submitted

false

CanAdjustFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be adjusted

true 

CanEditFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be edited

false 

ClientIdentity

PwsClientRef

On Insert: No

On Update: No

 

The client associated with this cost card

 

ClientName

String

On Insert: No

On Update: No

 

The name of the client associated with this cost card 

Projector PSA

DisbursedCurrencyDecimalDigits

Byte

On Insert: No

On Update: No

 

The number of decimal places associated with the disbursed currency. Note: Computed amounts are always rounded to the nearest minor currency unit as identified by the currency's decimalDigits property  

2 

DisbursedCurrencyIdentity

PwsCurrencyRef

On Insert: No

On Update: No

 

The disbursed currency identity 

 

DisbursingCostCenterIdentity

PwsCostCenterRef

On Insert: No

On Update: No

 

The disbursing cost center identity

 

EditSubmitFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set back to the status of submit

false 

ExpenseDocumentIdentity

PwsExpenseDocumentRef

On Insert: No

On Update: No

 

The expense document identity this cost card resides under

 

ExpenseDocumentName

String

On Insert: No

On Update: No

 

The name of the expense document this cost card resides under 

Status Report

ExpenseDocumentTimestamp

String

On Insert: No

On Update: No

 

This is a Base64 encoded timestamp utilized for expense document locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsSaveExpenseDocument (or a prior call to PwsSaveExpenseDocument). This will cause the request to fail if any change has been made between invocations of PwsGetExpenseDocument and PwsSaveExpenseDocument.

AAAAAA62IyE= 

ExpenseDocumentType

String

On Insert: No

On Update: No

 

 

The type of expense document this cost card resides under:

"E" - Expense Report

"C" - Subcontractor Invoice

"V" - Vendor Invoice

"S" - Soft Costs

E

ExpenseDocumentVatFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this expense document include value added tax (i.e. GST)

false 

IwsApprovedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the invoice workflow status of approved

false

IwsDraftInvoiceStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the invoice workflow status of draft invoiced

false

IwsInvoicedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the invoice workflow status of invoiced 

false

IwsUnapprovedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the invoice workflow status of submitted

false

MileageUom

String

On Insert: No

On Update: No

 

The mileage unit of measure associated with this cost card (i.e. M / kms)

M 

PwsApprovedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the payment workflow status of approved

false 

PwsPaidStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the payment workflow status of paid

false

PwsReceivedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the payment workflow status of received

false 

PwsTransmittedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the payment workflow status of transmitted

false 

PwsUnapprovedStatusAllowedFlag

Boolean

On Insert: No

On Update: No

 

If set to 'true', this cost card can be set to the payment workflow status of draft

false 

Usage Example(s)


Example 01 
                     <a:ManagementData>
                        <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                        <a:ApprovalWorkflowFlag>true</a:ApprovalWorkflowFlag>
                        <a:ApproverFlag>false</a:ApproverFlag>
                        <a:ApproverToInvoiceFlag>true</a:ApproverToInvoiceFlag>
                        <a:ApproverToPayFlag>false</a:ApproverToPayFlag>
                        <a:ApproversCanRejectApprovedExpensesFlag>false</a:ApproversCanRejectApprovedExpensesFlag>
                        <a:AutoApprovalFlag>false</a:AutoApprovalFlag>
                        <a:AutoApprovalToInvoiceFlag>false</a:AutoApprovalToInvoiceFlag>
                        <a:AutoApprovalToPayFlag>false</a:AutoApprovalToPayFlag>
                        <a:AwsApprovedStatusAllowedFlag>false</a:AwsApprovedStatusAllowedFlag>
                        <a:AwsDraftStatusAllowedFlag>false</a:AwsDraftStatusAllowedFlag>
                        <a:AwsRejectedStatusAllowedFlag>false</a:AwsRejectedStatusAllowedFlag>
                        <a:AwsSubmittedStatusAllowedFlag>false</a:AwsSubmittedStatusAllowedFlag>
                        <a:CanAdjustFlag>true</a:CanAdjustFlag>
                        <a:CanEditFlag>false</a:CanEditFlag>
                        <a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ClientId i:nil="true"/>
                           <b:ClientNumber>PR-PSA</b:ClientNumber>
                           <b:ClientUid>1152921504606961482</b:ClientUid>
                        </a:ClientIdentity>
                        <a:ClientName>Projector PSA</a:ClientName>
                        <a:DisbursedCurrencyDecimalDigits>2</a:DisbursedCurrencyDecimalDigits>
                        <a:DisbursedCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:CurrencyCode>USD</b:CurrencyCode>
                           <b:CurrencyId i:nil="true"/>
                           <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                        </a:DisbursedCurrencyIdentity>
                        <a:DisbursingCostCenterIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:CostCenterId i:nil="true"/>
                           <b:CostCenterName>Section B</b:CostCenterName>
                           <b:CostCenterNumber>Section B</b:CostCenterNumber>
                           <b:CostCenterUid>1152921504606884477</b:CostCenterUid>
                        </a:DisbursingCostCenterIdentity>
                        <a:EditSubmitFlag>false</a:EditSubmitFlag>
                        <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:DocumentNumber>ER00709</b:DocumentNumber>
                           <b:ExpenseDocumentId i:nil="true"/>
                           <b:ExpenseDocumentUid>1152921504607683557</b:ExpenseDocumentUid>
                        </a:ExpenseDocumentIdentity>
                        <a:ExpenseDocumentName>Status Report</a:ExpenseDocumentName>
                        <a:ExpenseDocumentTimestamp>AAAAAA62IyE=</a:ExpenseDocumentTimestamp>
                        <a:ExpenseDocumentType>E</a:ExpenseDocumentType>
                        <a:ExpenseDocumentVatFlag>false</a:ExpenseDocumentVatFlag>
                        <a:IwsApprovedStatusAllowedFlag>false</a:IwsApprovedStatusAllowedFlag>
                        <a:IwsDraftInvoiceStatusAllowedFlag>false</a:IwsDraftInvoiceStatusAllowedFlag>
                        <a:IwsInvoicedStatusAllowedFlag>false</a:IwsInvoicedStatusAllowedFlag>
                        <a:IwsUnapprovedStatusAllowedFlag>false</a:IwsUnapprovedStatusAllowedFlag>
                        <a:MileageUom>M</a:MileageUom>
                        <a:PwsApprovedStatusAllowedFlag>false</a:PwsApprovedStatusAllowedFlag>
                        <a:PwsPaidStatusAllowedFlag>false</a:PwsPaidStatusAllowedFlag>
                        <a:PwsReceivedStatusAllowedFlag>false</a:PwsReceivedStatusAllowedFlag>
                        <a:PwsTransmittedStatusAllowedFlag>false</a:PwsTransmittedStatusAllowedFlag>
                        <a:PwsUnapprovedStatusAllowedFlag>false</a:PwsUnapprovedStatusAllowedFlag>
                     </a:ManagementData>
  • No labels