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
- ClientId: Int32
- ClientNumber: String (20)
- ClientUid: Int64
- ClientName: String (50)
- InactiveFlag: Boolean
- ParentClientIdentity: PwsClientRef
- Address: PwsAddress
- BillingCycleIdentity: PwsBillingCycleRef
- BillingInstructions: String (1000)
- ClientMessage: String (4000)
- ClientMessagePlain: String (4000)
- InheritAddressFlag: Boolean
- InheritBillingCycleFlag: Boolean
- InheritBillingInstructionsFlag: Boolean
- InheritClientMessageFlag: Boolean
- InheritInvoiceContentFlag: Boolean
- InheritInvoiceScopeFlag: Boolean
- InheritInvoiceTemplateFlag: Boolean
- InheritPaymentTermFlag: Boolean
- InheritPurchaseOrderNumberFlag: Boolean
- InheritStandardRatesFlag: Boolean
- InheritTimeBillingTypeFlag: Boolean
- InvoiceContent: String (1)
- InvoiceScope: String (1)
- InvoiceTemplateIdentity: PwsInvoiceTemplateRef
- NewClientNumber: String (20)
- PaymentTermIdentity: PwsPaymentTermRef
- PurchaseOrderNumber: String (50)
- StandardBillingAdjustedDiscountPercent: Double
- StandardContractDiscountPercent: Double
- StandardRateCardIdentity: PwsRateCardRef
- TimeBillingType: String (1)
- 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	Required?	Default	Description	Sample Data
ClientId	Int32	On Insert: No On Update: No		The client Id is a unique identifier for a client. For internal use only.
ClientNumber	String (20)	On Insert: No On Update: Yes (if ClientUid is not supplied)		The client number is a unique identifier for a client	C000117
ClientUid	Int64	On Insert: No On Update: Yes (if ClientNumber is not supplied)		The client Uid is a unique and immutable identifier for a client	1152921504606961482
ClientName	String (50)	On Insert: Yes On Update: No		The client name	Projector PSA
InactiveFlag	Boolean	On Insert: No On Update: No	false	If set to "true", the client is marked as inactive	true / false
ParentClientIdentity	PwsClientRef	On Insert: No On Update: No		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	On Insert: No On Update: No		The billing address for the client
BillingCycleIdentity	PwsBillingCycleRef	On Insert: No On Update: No		The billing cycle set up for the client
BillingInstructions	String (1000)	On Insert: No On Update: No		The billing instructions associated with the client
ClientMessage	String (4000)	On Insert: No On Update: No		A per-invoice message to appear on the invoice. This may include RTF markup.	Thank you for choosing Projector PSA
ClientMessagePlain	String (4000)	On Insert: No On Update: No		A per-invoice message to appear on the invoice. This is in plain text format.	Thank you for choosing Projector PSA
InheritAddressFlag	Boolean	On Insert: No On Update: No	false	Inherit address from the parent client (if any). Please see Inheritance for more information.	true / false
InheritBillingCycleFlag	Boolean	On Insert: No On Update: No	false	Inherit billing cycle from the parent client (if any). Please see Inheritance for more information.	true / false
InheritBillingInstructionsFlag	Boolean	On Insert: No On Update: No	false	Inherit billing instruction from the parent client (if any). Please see Inheritance for more information.	true / false
InheritClientMessageFlag	Boolean	On Insert: No On Update: No	false	Inherit client message from the parent client (if any). Please see Inheritance for more information.	true / false
InheritInvoiceContentFlag	Boolean	On Insert: No On Update: No	false	Inherit invoice content from the parent client (if any). Please see Inheritance for more information.	true / false
InheritInvoiceScopeFlag	Boolean	On Insert: No On Update: No	false	Inherit invoice scope from the parent client (if any). Please see Inheritance for more information.	true / false
InheritInvoiceTemplateFlag	Boolean	On Insert: No On Update: No	false	Inherit invoice template from the parent client (if any). Please see Inheritance for more information.	true / false
InheritPaymentTermFlag	Boolean	On Insert: No On Update: No	false	Inherit invoice template from the parent client (if any). Please see Inheritance for more information.	true / false
InheritPurchaseOrderNumberFlag	Boolean	On Insert: No On Update: No	false	Inherit purchase order number from the parent client (if any). Please see Inheritance for more information.	true / false
InheritStandardRatesFlag	Boolean	On Insert: No On Update: No	true	Inherit standard rates flag from the parent client (if any). Please see Inheritance for more information.	true / false
InheritTimeBillingTypeFlag	Boolean	On Insert: No On Update: No	false	Inherit time billing type from the parent client (if any). Please see Inheritance for more information.	true / false
InvoiceContent	String (1)	On Insert: Yes On Update: No	B	The invoice content associated with the client. "B" for time and cost together "S" for separately	B
InvoiceScope	String (1)	On Insert: Yes On Update: No	E	The invoice content associated with the client. "C" for client "N" for purchase order number "E" for engagement "P" for project	E
InvoiceTemplateIdentity	PwsInvoiceTemplateRef	On Insert: No On Update: No		The invoice template id associated with the client
NewClientNumber	String (20)	On Insert: No On Update: No		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.
PaymentTermIdentity	PwsPaymentTermRef	On Insert: No On Update: No		The payment terms set up for the client
PurchaseOrderNumber	String (50)	On Insert: No On Update: No		The purchase order number for the client	Acme 123
StandardBillingAdjustedDiscountPercent	Double	On Insert: No On Update: No		The standard billing adjusted discount percent for the client	10
StandardContractDiscountPercent	Double	On Insert: No On Update: No		The standard contract discount percent for the client	5
StandardRateCardIdentity	PwsRateCardRef	On Insert: Yes On Update: No		The standard rate card identity for the client
TimeBillingType	String (1)	On Insert: No On Update: No	H	The time billing type: "D" for daily "H" for hourly
Timestamp	String	On Insert: No On Update: No		The row version in Base64 format
UserDefinedFields	PwsUserDefinedFieldDetail	On Insert: Dependent on UDF Definition On Update: No		The client user defined field values associated with this client
InheritInvoiceEmailSettingsFlag	Boolean	On Insert: No On Update: No	false	Inherit invoice email settings from the parent client (if any). Please see Inheritance for more information.	true / false
InvoiceEmailSettings	PwsInvoiceEmailSettings	On Insert: No On Update: No		The 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	On Insert: No On Update: No	false	Inherit render receipts setting from the parent client (if any). Please see Inheritance for more information.	true / false
RenderReceiptsFlag	Boolean	On Insert: No On Update: No	false	If set to "true" receipts will be rendered on the invoice	true / false
AutoApplyAvailableBalanceFlag	Boolean	On Insert: No On Update: No	false	For clients with a pre-payment balance, if set to "true" automatically apply the balance to new invoices.	true / false
InheritAutoApplyAvailableBalanceFlag	Boolean	On Insert: No On Update: No	false	Inherit auto apply available flag from the parent client (if any). Please see Inheritance for more information.	true / false
InheritTaxTypesFlag	Boolean	On Insert: No On Update: No	false	Inherit tax types flag from the 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

                   <ClientDetail>
                     <ClientId i:nil="true"/>
                     <ClientNumber>PR-PSA(W)</ClientNumber>
                     <ClientUid>1152921504606989822</ClientUid>
                     <ClientName>Projector PSA - West</ClientName>
                     <InactiveFlag>false</InactiveFlag>
                     <ParentClientIdentity>
                        <ClientId i:nil="true"/>
                        <ClientNumber>PR-PSA</ClientNumber>
                        <ClientUid>1152921504606961482</ClientUid>
                     </ParentClientIdentity>
                     <Address>
                        <AddressLine1>85 Merrimac Street</AddressLine1>
                        <AddressLine2>200</AddressLine2>
                        <Attention>Finance</Attention>
                        <City>Boston</City>
                        <CompanyName>Projector PSA</CompanyName>
                        <Country>USA</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 each month.</BillingInstructions>
                     <ClientMessage>{\rtf1\ansi\ansicpg1252\deff0{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}
\viewkind4\uc1\pard\lang1033\f0\fs17 Thank you for your business!\par
}</ClientMessage>
                     <ClientMessagePlain>Thank you for your business!</ClientMessagePlain>
                     <InheritAddressFlag>true</InheritAddressFlag>
                     <InheritBillingCycleFlag>true</InheritBillingCycleFlag>
                     <InheritBillingInstructionsFlag>true</InheritBillingInstructionsFlag>
                     <InheritClientMessageFlag>true</InheritClientMessageFlag>
                     <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>
                     <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>
                     <InheritInvoiceTemplateFlag>true</InheritInvoiceTemplateFlag>
                     <InheritPaymentTermFlag>true</InheritPaymentTermFlag>
                     <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
                     <InheritStandardRatesFlag>true</InheritStandardRatesFlag>
                     <InheritTimeBillingTypeFlag>true</InheritTimeBillingTypeFlag>
                     <InvoiceContent>B</InvoiceContent>
                     <InvoiceScope>E</InvoiceScope>
                     <InvoiceTemplateIdentity>
                        <InvoiceTemplateId i:nil="true"/>
                        <InvoiceTemplateName>A200</InvoiceTemplateName>
                        <InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid>
                     </InvoiceTemplateIdentity>
                     <NewClientNumber i:nil="true"/>
                     <PaymentTermIdentity>
                        <PaymentTermId i:nil="true"/>
                        <PaymentTermName>Net 30</PaymentTermName>
                        <PaymentTermUid>1152921504606856054</PaymentTermUid>
                     </PaymentTermIdentity>
                     <PurchaseOrderNumber>PR-PSA01</PurchaseOrderNumber>
                     <StandardBillingAdjustedDiscountPercent>5</StandardBillingAdjustedDiscountPercent>
                     <StandardContractDiscountPercent>10</StandardContractDiscountPercent>
                     <StandardRateCardIdentity>
                        <RateCardId i:nil="true"/>
                        <RateCardName>USA Rate Card</RateCardName>
                        <RateCardType>R</RateCardType>
                        <RateCardUid>1152921504606860819</RateCardUid>
                     </StandardRateCardIdentity>
                     <TimeBillingType>H</TimeBillingType>
                     <Timestamp>AAAAAA61kSU=</Timestamp>
                     <UserDefinedFields>
                        <PwsUserDefinedFieldDetail>
                           <UdfId i:nil="true"/>
                           <UdfName>Sign On Date</UdfName>
                           <UdfUid>1152921504606856792</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>D</DataType>
                           <DateValue>2018-01-01T00: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>Account Owner</UdfName>
                           <UdfUid>1152921504606856794</UdfUid>
                           <BooleanValue i:nil="true"/>
                           <DataType>R</DataType>
                           <DateValue i:nil="true"/>
                           <IntegerValue i:nil="true"/>
                           <ResourceIdentityValue>
                              <ResourceDisplayName>Jack Spratt</ResourceDisplayName>
                              <ResourceId i:nil="true"/>
                              <ResourceReferenceSystemId>E123</ResourceReferenceSystemId>
                              <ResourceUid>1152921504607111573</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>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-2B</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>2018-01-12T00:00:00Z</AsOfDate>
                                 <SortOrder>2</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>Racepoint, CA</TextValue>
                           <UdfTreatment>A</UdfTreatment>
                           <StoplightValues/>
                           <NumericValue i:nil="true"/>
                           <RelationValue i:nil="true"/>
                        </PwsUserDefinedFieldDetail>
                     </UserDefinedFields>
                     <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>
                     <InvoiceEmailSettings>
                        <EmailFromUserIdentity>
                           <UserDisplayName>Bob Smith</UserDisplayName>
                           <UserId i:nil="true"/>
                           <UserReferenceSystemId>Partner - 01</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>Jack Spratt</UserDisplayName>
                                 <UserId i:nil="true"/>
                                 <UserReferenceSystemId>E123</UserReferenceSystemId>
                                 <UserUid>1152921504607112369</UserUid>
                              </UserIdentity>
                           </PwsInvoiceEmailRecipient>
                        </Recipients>
                     </InvoiceEmailSettings>
                     <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag>
                     <RenderReceiptsFlag>false</RenderReceiptsFlag>
                     <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag>
                     <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag>
                     <InheritTaxTypesFlag>false</InheritTaxTypesFlag>
                     <TaxType1Identity i:nil="true"/>
                     <TaxType2Identity i:nil="true"/>
                     <TaxType3Identity i:nil="true"/>
                  </ClientDetail>