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
Panel | ||
---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
ClientDetail | On Insert: Yes On Update: Yes | The complete set of information about a client (less any subordinate entities). Click here for more information. |
Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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> |