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

« Previous Version 6 Next »

Overview

This data structure is part of the method PwsCreateInvoice. It captures the information that is used to create an invoice such as time and cost cards date range, client, engagement and project data. 

Format


PwsCandidateInvoiceSpec
  • PwsCandidateInvoiceSpec
    • ApprovedByFinanceFlag: Boolean
    • ApprovedByManagementFlag: Boolean
    • ApprovedByProjectManagerFlag: Boolean
    • BillingCultureIdentity: PwsCultureRef
    • CardBeginDate: DateTime
    • CardEndDate: DateTime
    • ClientIdentity: PwsClientRef
    • CostCenterIdentity: PwsCostCenterRef
    • EngagementCurrencyIdentity: PwsCurrencyRef
    • EngagementIdentity: PwsEngagementRef
    • EngagementInvoiceContent: String
    • InvoiceContent: String
    • InvoiceName: String
    • InvoiceScope: String
    • ProjectIdentity: PwsProjectRef
    • PurchaseOrderNumber: String

Elements

Element

Data Type

Required?

Description

ApprovedByFinanceFlag

Boolean

No

If this flag is set to true, it indicates that the Finance team has approved the invoice.

ApprovedByManagementFlag

Boolean

No

If this flag is set to true, it indicates that the Management team has approved the invoice.  This flag can only be set to true when both ApprovedByFinanceFlag and ApprovedByProjectManagerFlag are set to true first. 

ApprovedByProjectManagerFlag

Boolean

No

If this flag is set to true, it indicates that the Project Manager has approved the invoice.

BillingCultureIdentity

PwsCultureRef

Yes

This structure represents the unique key fields associated with identifying a culture.  For example, en-US is a valid culture name for invoice issued in USD. 

CardBeginDate

DateTime

No

The begin date of a range.  Any time card with work date or cost card with incurred date within this date range could be included on the invoice. 

CardEndDate

DateTime

No

The end date of a range.  Any time card with work date or cost card with incurred date within this date range could be included on the invoice. 

ClientIdentity

PwsClientRef

Yes

This structure is used to uniquely identify a client.

CostCenterIdentity

PwsCostCenterRef

Yes

This structure is used to uniquely identify a cost center.

EngagementCurrencyIdentity

PwsCurrencyRef

Yes

This structure is used to uniquely identify a currency.

EngagementIdentity

PwsEngagementRef

Yes

This structure is used to uniquely identify an engagement. 

EngagementInvoiceContent

String

???

Valid values are B (blank), S (???).

InvoiceContent

String

Yes

Valid values are B (blank), F (???), A (all included), M (milestone only), S (???), C (cost only), T (time only).

InvoiceName

String

Yes

The name of the invoice with maximum length at 100 char. 

InvoiceScope

String

Yes

The scope of the invoice. Valid values are C (client), E (engagement), N (purchase order), P (project).

ProjectIdentity

PwsProjectRef

Yes (if  invoice scope is P)

This structure is used to uniquely identify a project. 

PurchaseOrderNumber

String

???

The purchase order number of the invoice. 

Usage Example(s)


Request 01 
			<bil:InvoiceSpec>
               <bil:ApprovedByFinanceFlag>false</bil:ApprovedByFinanceFlag>
               <bil:ApprovedByManagementFlag>false</bil:ApprovedByManagementFlag>
               <bil:ApprovedByProjectManagerFlag>false</bil:ApprovedByProjectManagerFlag>
               <bil:BillingCultureIdentity>
                  <com:CultureName>en-US</com:CultureName>
               </bil:BillingCultureIdentity>
               <bil:CardBeginDate>2022-07-01T00:00:00.000Z</bil:CardBeginDate>
               <bil:CardEndDate>2022-07-05T00:00:00.000Z</bil:CardEndDate>
               <bil:ClientIdentity>
                  <com:ClientNumber>Amazon</com:ClientNumber>
               </bil:ClientIdentity>
               <bil:CostCenterIdentity>
                  <com:CostCenterName>Executive Team (USA)</com:CostCenterName>
               </bil:CostCenterIdentity>
               <bil:EngagementCurrencyIdentity>
                  <com:CurrencyCode>USD</com:CurrencyCode>
               </bil:EngagementCurrencyIdentity>
               <bil:EngagementIdentity>
                  <com:EngagementCode>P001666</com:EngagementCode>
               </bil:EngagementIdentity>
               <bil:EngagementInvoiceContent>B</bil:EngagementInvoiceContent>
               <bil:InvoiceContent>B</bil:InvoiceContent>
               <bil:InvoiceName>Invoice - WS</bil:InvoiceName>
               <bil:InvoiceScope>P</bil:InvoiceScope>
               <bil:ProjectIdentity>
                  <com:ProjectCode>P001666-001</com:ProjectCode>
               </bil:ProjectIdentity>
               <bil:PurchaseOrderNumber>Invoice - WS</bil:PurchaseOrderNumber>
            </bil:InvoiceSpec>
  • No labels