Overview

This structure contains the complete set of information about a Client (less any subordinate entities). The structure is used both to retrieve detailed Client information and to pass information about a Client back to the server to get updated.

Format

PwsClientDetail

PwsClientDetail
- ClientName: String
- InactiveFlag: Boolean
- ClientId: Int32
- ClientNumber: String
- ClientUid: Int64
- ParentClientIdentity: PwsClientRef
- Address: PwsAddress
- BillingCycleIdentity: PwsBillingCycleRef
- BillingInstructions: String
- ClientMessage: String
- ClientMessagePlain: String
- InheritAddressFlag: Boolean
- InheritBillingCycleFlag: Boolean
- InheritBillingInstructionsFlag: Boolean
- InheritClientMessageFlag: Boolean
- InheritInvoiceContentFlag: Boolean
- InheritInvoiceScopeFlag: Boolean
- InheritInvoiceTemplateFlag: Boolean
- InheritPaymentTermFlag: Boolean
- InheritPurchaseOrderNumberFlag: Boolean
- InheritStandardRatesFlag: Boolean
- InheritTimeBillingTypeFlag: Boolean
- InvoiceContent: String
- InvoiceScope: String
- InvoiceTemplateIdentity: PwsInvoiceTemplateRef
- NewClientNumber: String
- PaymentTermIdentity: PwsPaymentTermRef
- PurchaseOrderNumber: String
- StandardBillingAdjustedDiscountPercent: Double
- StandardContractDiscountPercent: Double
- StandardRateCardIdentity: PwsRateCardRef
- TimeBillingType: String
- Timestamp: String
- UserDefinedFields: PwsUserDefinedFieldDetail
- InheritInvoiceEmailSettingsFlag: Boolean
- InvoiceEmailSettings: PwsInvoiceEmailSettings
- InheritRenderReceiptsFlag: Boolean
- RenderReceiptsFlag: Boolean
- AutoApplyAvailableBalanceFlag: Boolean
- InheritAutoApplyAvailableBalanceFlag: Boolean
- InheritTaxTypesFlag: Boolean
- TaxType1Identity: PwsTaxTypeRef
- TaxType2Identity: PwsTaxTypeRef
- TaxType3Identity: PwsTaxTypeRef

Elements

Element	Data Type	Description	Sample Data
ClientName	String	Client Name	Projector PSA
InactiveFlag	Boolean	If set to "true", the Client has a status of inactive.	true / false
ClientId	Int32	The Client Id is a unique identifier for a Client. For internal use only.
ClientNumber	String	The Client Number is a unique identifier for a Client. See "NewClientNumber" for guidance on how to change the client number of an existing client.	C000117
ClientUid	Int64	The Client Uid is a unique and immutable identifier for a Client.	1152921504606961482
ParentClientIdentity	PwsClientRef	The identity of this client's parent, if any. Circular relationships are not permitted (a client cannot be it's own parent, nor can a client's parent refer back to the client as it's parent, and so forth.).
Address	PwsAddress	The billing address for the client.
BillingCycleIdentity	PwsBillingCycleRef	The billing cycle set up for the client.
BillingInstructions	String	Billing instructions associated with the Client.	Please bill on the 15th of every month
ClientMessage	String	A per-invoice message to appear on the invoice. This may include RTF markup.	Thank you for choosing Projector PSA
ClientMessagePlain	String	A per-invoice message to appear on the invoice in plain text format.	Thank you for choosing Projector PSA
InheritAddressFlag	Boolean	Inherit Address from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritBillingCycleFlag	Boolean	Inherit Billing Cycle from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritBillingInstructionsFlag	Boolean	Inherit Billing Instructions from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritClientMessageFlag	Boolean	Inherit Client Message from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritInvoiceContentFlag	Boolean	Inherit Invoice Content from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritInvoiceScopeFlag	Boolean	Inherit Invoice Scope from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritInvoiceTemplateFlag	Boolean	Inherit invoice Template from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritPaymentTermFlag	Boolean	Inherit Payment Term from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritPurchaseOrderNumberFlag	Boolean	Inherit Purchase Order Number from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritStandardRatesFlag	Boolean	Inherit Standard Rates Flag from Parent Client (if any). Please see Inheritance for more information.	true / false
InheritTimeBillingTypeFlag	Boolean	Inherit Time Billing Type from Parent Client (if any). Please see Inheritance for more information.	true / false
InvoiceContent	String	Invoice Content "B" for time and cost together "S" for separately	B
InvoiceScope	String	Invoice Scope "C" for client "N" for purchase order number "E" for engagement "P" for project	C
InvoiceTemplateIdentity	PwsInvoiceTemplateRef	The invoice template id associated with the client.
NewClientNumber	String	This is used by PwsSaveClient to support re-numbering clients. You can both identify a client by client number and modify the client number by specifying the original client number in ClientNumber and the new value in NewClientNumber. NewClientNumber will always be null in responses from PwsGetClient. Note that the client number may only be changed if numbering for clients is configured as Manual or Hybrid.	C000117-New
PaymentTermIdentity	PwsPaymentTermRef	The payment terms set up for the client.
PurchaseOrderNumber	String	Purchase Order Number	PO-1234
StandardBillingAdjustedDiscountPercent	Double	Standard Billing Adjusted Discount Percent	0.725
StandardContractDiscountPercent	Double	Standard Contract Discount Percent	.10
StandardRateCardIdentity	PwsRateCardRef	Standard Rate Card Identity	SR2018-2019
TimeBillingType	String	Time Billing Type "D" for daily "H" for hourly	H
Timestamp	String	Row version in Base64 format	AAAAAA9Dhpo=
UserDefinedFields	PwsUserDefinedFieldDetail	Client user defined field values associated with this client.
InheritInvoiceEmailSettingsFlag	Boolean	Inherit Invoice Email Settings from Parent Client (if any). Please see Inheritance for more information.	true/false
InvoiceEmailSettings	PwsInvoiceEmailSettings	Settings that control whether email distribution of invoices is enabled for this client, and if so, who the sender and recipients of the email are, the subject line, the email template and other related settings that are in effect.
InheritRenderReceiptsFlag	Boolean	Inherit Render Receipts Settings from Parent Client (if any). Please see Inheritance for more information.
RenderReceiptsFlag	Boolean	If set to "true" Receipts will be rendered on the invoice	true/false
AutoApplyAvailableBalanceFlag	Boolean	For engagements with a pre-payment balance, if set to "true" automatically apply the balance to new invoices.	true/false
InheritAutoApplyAvailableBalanceFlag	Boolean	Inherit Auto Apply Available Balance flag from Parent Client (if any). Please see Inheritance for more information.	true/false
InheritTaxTypesFlag	Boolean	Inherit Tax Types flag from Parent Client (if any). Please see Inheritance for more information.	true/false
TaxType1Identity	PwsTaxTypeRef	The tax types that apply for invoices under this client.
TaxType2Identity	PwsTaxTypeRef	The tax types that apply for invoices under this client.
TaxType3Identity	PwsTaxTypeRef	The tax types that apply for invoices under this client.

Usage Example(s)

Example 01

                <PwsClientElement>
                  <ClientDetail>
                     <ClientId i:nil="true"/>
                     <ClientNumber>C000117</ClientNumber>
                     <ClientUid>1152921504606989806</ClientUid>
                     <ClientName>Projector PSA</ClientName>
                     <InactiveFlag>false</InactiveFlag>
                     <ParentClientIdentity i:nil="true"/>
                     <Address>
                        <AddressLine1>85 Merrimac Street</AddressLine1>
                        <AddressLine2>Suite 200</AddressLine2>
                        <Attention>Finance</Attention>
                        <City>Boston</City>
                        <CompanyName>Acme 123</CompanyName>
                        <Country>MA</Country>
                        <StateOrProvince>MA</StateOrProvince>
                        <ZipOrPostalCode>02114</ZipOrPostalCode>
                     </Address>
                     <BillingCycleIdentity>
                        <BillingCycleId i:nil="true"/>
                        <BillingCycleName>Monthly</BillingCycleName>
                        <BillingCycleUid>1152921504606853180</BillingCycleUid>
                     </BillingCycleIdentity>
                     <BillingInstructions>This client should be billed on the 15th of every month</BillingInstructions>
                     <ClientMessage>We appreciate your business!</ClientMessage>
                     <ClientMessagePlain>We appreciate your business!</ClientMessagePlain>
                     <InheritAddressFlag>false</InheritAddressFlag>
                     <InheritBillingCycleFlag>false</InheritBillingCycleFlag>
                     <InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag>
                     <InheritClientMessageFlag>false</InheritClientMessageFlag>
                     <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>
                     <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>
                     <InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>
                     <InheritPaymentTermFlag>false</InheritPaymentTermFlag>
                     <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>
                     <InheritStandardRatesFlag>true</InheritStandardRatesFlag>
                     <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>
                     <InvoiceContent>B</InvoiceContent>
                     <InvoiceScope>E</InvoiceScope>
                     <InvoiceTemplateIdentity>
                        <InvoiceTemplateId i:nil="true"/>
                        <InvoiceTemplateName>A100</InvoiceTemplateName>
                        <InvoiceTemplateUid>1152921504606878901</InvoiceTemplateUid>
                     </InvoiceTemplateIdentity>
                     <NewClientNumber i:nil="true"/>
                     <PaymentTermIdentity>
                        <PaymentTermId i:nil="true"/>
                        <PaymentTermName>Net 15</PaymentTermName>
                        <PaymentTermUid>1152921504606856053</PaymentTermUid>
                     </PaymentTermIdentity>
                     <PurchaseOrderNumber>Acme 123</PurchaseOrderNumber>
                     <StandardBillingAdjustedDiscountPercent i:nil="true"/>
                     <StandardContractDiscountPercent i:nil="true"/>
                     <StandardRateCardIdentity i:nil="true"/>
                     <TimeBillingType>H</TimeBillingType>
                     <Timestamp>AAAAAA61PAw=</Timestamp>
                     <UserDefinedFields>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Sign On Date</UdfName>
                           <UdfUid>1152921504606856792</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>D</DataType>
                           <DateValue>2017-12-21T00:00:00Z</DateValue>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Contact Name</UdfName>
                           <UdfUid>1152921504606856794</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>R</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue>
                              <ResourceDisplayName>John Smith</ResourceDisplayName>
                              <ResourceId i:nil="true"/>
                              <ResourceReferenceSystemId>SL (USA) - 03</ResourceReferenceSystemId>
                              <ResourceUid>1152921504607062225</ResourceUid>
                           </ResourceIdentityValue>
                           <TextValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Additional Info</UdfName>
                           <UdfUid>1152921504606856795</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>T</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue>Client Info pending</TextValue>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Grade</UdfName>
                           <UdfUid>1152921504606856796</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>L</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue>CL-1A</TextValue>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Category</UdfName>
                           <UdfUid>1152921504606856797</UdfUid>
                           <BooleanValue>true</BooleanValue>
                           <DataType>Y</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Satisfaction</UdfName>
                           <UdfUid>1152921504606856814</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>S</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues>
                              <PwsStoplightValue>
                                 <AsOfDate>2017-12-21T00:00:00Z</AsOfDate>
                                 <SortOrder>3</SortOrder>
                              </PwsStoplightValue>
                           </StoplightValues>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Headquarters</UdfName>
                           <UdfUid>1152921504606858027</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>T</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue i:nil="true"/>
                           <TextValue>This cllient has an additional location in San Francisco, CA.</TextValue>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                     </UserDefinedFields>
                     <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>
                     <InvoiceEmailSettings>
                        <EmailFromUserIdentity>
                           <UserDisplayName>Jane Doe</UserDisplayName>
                           <UserId i:nil="true"/>
                           <UserReferenceSystemId>Employee - 123</UserReferenceSystemId>
                           <UserUid>1152921504607011056</UserUid>
                        </EmailFromUserIdentity>
                        <EmailInvoiceTemplateIdentity>
                           <InvoiceTemplateId i:nil="true"/>
                           <InvoiceTemplateName>E001</InvoiceTemplateName>
                           <InvoiceTemplateUid>1152921504606878906</InvoiceTemplateUid>
                        </EmailInvoiceTemplateIdentity>
                        <InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag>
                        <InvoiceEmailType>P</InvoiceEmailType>
                        <Recipients>
                           <PwsInvoiceEmailRecipient>
                              <RecipientType>T</RecipientType>
                              <UserIdentity>
                                 <UserDisplayName>Web Services</UserDisplayName>
                                 <UserId i:nil="true"/>
                                 <UserReferenceSystemId>WS01</UserReferenceSystemId>
                                 <UserUid>1152921504607067736</UserUid>
                              </UserIdentity>
                           </PwsInvoiceEmailRecipient>
                        </Recipients>
                     </InvoiceEmailSettings>
                     <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag>
                     <RenderReceiptsFlag>false</RenderReceiptsFlag>
                     <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag>
                     <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag>
                     <InheritTaxTypesFlag>false</InheritTaxTypesFlag>
                     <TaxType1Identity>
                        <TaxTypeCode>VAT</TaxTypeCode>
                        <TaxTypeId i:nil="true"/>
                        <TaxTypeUid>1152921504606868258</TaxTypeUid>
                     </TaxType1Identity>
                     <TaxType2Identity i:nil="true"/>
                     <TaxType3Identity i:nil="true"/>
                  </ClientDetail>
               </PwsClientElement>