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 92
Next »
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.
| Element | Data Type | Description | Default (on insert/update) | Sample Data |
|---|
| ClientId | Int32 | Client ID. For internal use only. |
|
|
| ClientNumber | String | Client Number. Unique ID associated with the client record. |
| C000117 |
| ClientUid | Int64 | The Client UID is a unique and immutable identifier for a client. |
| 1152921504606961482 |
| ClientName | String | Client Name |
| Acme 123 |
| InactiveFlag | Boolean | Inactive Flag |
| "true" or "false" |
| ParentClientIdentity | Int32 | Parent Client ID. For internal use only. |
| 114505 |
| Address | PwsAddress | Client Address |
|
|
| BillingCycleIdentity | PwsBillingCycleRef | Billing Cycle Identity. |
|
|
| BillingInstructions | String | Billing instructions |
| Please bill on the 15th of every month |
| ClientMessage | String | A client message to appear on the invoice. |
| We appreciate your business! |
| ClientMessagePlain | String | A per-invoice message to appear on the invoice in plain text format. |
| We appreciate your business! |
| InheritAddressFlag | Boolean | Inherit address from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritBillingCycleFlag | Boolean | Inherit billing cycle from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritBillingInstructionsFlag | Boolean | Inherit billing instructions from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritClientMessageFlag | Boolean | Inherit client message from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
InheritInvoiceContentFlag | Boolean | Inherit invoice content from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritInvoiceScopeFlag | Boolean | Inherit invoice scope from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritInvoiceTemplateFlag | Boolean | Inherit invoice template from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritPaymentTermFlag | Boolean | Inherit parent term from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritPurchaseOrderNumberFlag | Boolean | Inherit purchase order number from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritStandardRatesFlag | Boolean | Inherit standard rates from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritTimeBillingTypeFlag | Boolean | Inherit time billing type from parent client (if any). Please see Inheritance for more information. |
| "true" or "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 | Invoice Template Identity |
|
|
| NewClientNumber | String | New Client Number |
|
|
| PaymentTermIdentity | PwsPaymentTermRef | Payment Term Identity |
|
|
| PurchaseOrderNumber | String | Purchase Order Number |
| PO-1234 |
| StandardBillingAdjustedDiscountPercent |
| Standard Billing Adjusted Discount Percent |
| 7.25 |
| StandardContractDiscountPercent | Double | Standard Contract Discount Percent |
| 0 |
| StandardRateCardIdentity | PwsStandardRateCardRef | Standard Rate Card Identity |
|
|
| TimeBillingType | String | Time Billing Type "D" for daily "H" for hourly |
| D |
| Timestamp | String | Row version in Base64 format |
| AAAAAA9Dhpo= |
UserDefinedFields | PwsUserDefinedFieldDetail | Client User Defined Fields |
|
|
| InheritInvoiceEmailSettingsFlag | Boolean | Inherit invoice email setting from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InvoiceEmailSettings | PwsInvoiceEmailSettings | Invoice Email Settings |
|
|
| InheritRenderReceiptsFlag | Boolean | Inherit render receipts flag from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| RenderReceiptsFlag | Boolean | Render receipts flag |
| "true" or "false" |
| AutoApplyAvailableBalanceFlag | Boolean | For engagements with a pre-payment balance, if set to "true" automatically apply the balance to new invoices. |
| "true" or "false" |
| InheritAutoApplyAvailableBalanceFlag | Boolean | Inherit auto apply available balance flag from parent client (if any). Please see Inheritance for more information. |
| "true" or "false" |
| InheritTaxTypesFlag | Boolean | Inherit tax types flag from parent client (if any) |
| "true" or "false" |
| TaxType1Identity | PwsTaxTypeRef |
|
|
|
| TaxType2Identity | PwsTaxTypeRef |
|
|
|
| TaxType3Identity | PwsTaxTypeRef |
|
|
|
Usage Example(s)
<PwsClientElement>
<ClientDetail>
<ClientId i:nil="true"/>
<ClientNumber>C000117</ClientNumber>
<ClientUid>1152921504606989806</ClientUid>
<ClientName>Acme 123</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity i:nil="true"/>
<Address>
<AddressLine1>100 Main Street</AddressLine1>
<AddressLine2 i:nil="true"/>
<Attention>Jane Doe</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>