- Created by Bettina Borces , last modified on Feb 05, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 20 Current »
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
- PwsClientElement
- ClientDetail: PwsClientDetail
Elements
Element | Data Type | Required? | Description | Sample Data |
---|---|---|---|---|
ClientDetail | Yes | The complete set of information about a client (less any subordinate entities) |
Usage Example(s)
<b:PwsClientElement> <b:ClientDetail> <b:ClientId i:nil="true"/> <b:ClientNumber>C000121</b:ClientNumber> <b:ClientUid>1152921504606998462</b:ClientUid> <b:ClientName>Parent Inc.</b:ClientName> <b:InactiveFlag>false</b:InactiveFlag> <b:ParentClientIdentity i:nil="true"/> <b:Address> <b:AddressLine1>100 Main Street</b:AddressLine1> <b:AddressLine2 i:nil="true"/> <b:Attention>Finance</b:Attention> <b:City>Boston</b:City> <b:CompanyName>Acme 1000</b:CompanyName> <b:Country>USA</b:Country> <b:StateOrProvince>MA</b:StateOrProvince> <b:ZipOrPostalCode>02114</b:ZipOrPostalCode> </b:Address> <b:BillingCycleIdentity> <b:BillingCycleId i:nil="true"/> <b:BillingCycleName>Monthly</b:BillingCycleName> <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid> </b:BillingCycleIdentity> <b:BillingInstructions>Please bill this client at the end of each month.</b:BillingInstructions> <b:ClientMessage>We appreciate your business!</b:ClientMessage> <b:ClientMessagePlain>We appreciate your business!</b:ClientMessagePlain> <b:InheritAddressFlag>false</b:InheritAddressFlag> <b:InheritBillingCycleFlag>false</b:InheritBillingCycleFlag> <b:InheritBillingInstructionsFlag>false</b:InheritBillingInstructionsFlag> <b:InheritClientMessageFlag>false</b:InheritClientMessageFlag> <b:InheritInvoiceContentFlag>false</b:InheritInvoiceContentFlag> <b:InheritInvoiceScopeFlag>false</b:InheritInvoiceScopeFlag> <b:InheritInvoiceTemplateFlag>false</b:InheritInvoiceTemplateFlag> <b:InheritPaymentTermFlag>false</b:InheritPaymentTermFlag> <b:InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag> <b:InheritStandardRatesFlag>false</b:InheritStandardRatesFlag> <b:InheritTimeBillingTypeFlag>false</b:InheritTimeBillingTypeFlag> <b:InvoiceContent>B</b:InvoiceContent> <b:InvoiceScope>E</b:InvoiceScope> <b:InvoiceTemplateIdentity> <b:InvoiceTemplateId i:nil="true"/> <b:InvoiceTemplateName>A100</b:InvoiceTemplateName> <b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid> </b:InvoiceTemplateIdentity> <b:NewClientNumber i:nil="true"/> <b:PaymentTermIdentity> <b:PaymentTermId i:nil="true"/> <b:PaymentTermName>Net 30</b:PaymentTermName> <b:PaymentTermUid>1152921504606856054</b:PaymentTermUid> </b:PaymentTermIdentity> <b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber> <b:StandardBillingAdjustedDiscountPercent>5</b:StandardBillingAdjustedDiscountPercent> <b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent> <b:StandardRateCardIdentity> <b:RateCardId i:nil="true"/> <b:RateCardName>USA Rate Card</b:RateCardName> <b:RateCardType>R</b:RateCardType> <b:RateCardUid>1152921504606860819</b:RateCardUid> </b:StandardRateCardIdentity> <b:TimeBillingType>H</b:TimeBillingType> <b:Timestamp>AAAAAA97WG8=</b:Timestamp> <b:UserDefinedFields> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Date</b:UdfName> <b:UdfUid>1152921504606856792</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>D</b:DataType> <b:DateValue>2018-01-17T00:00:00Z</b:DateValue> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Integer</b:UdfName> <b:UdfUid>1152921504606856793</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>I</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue>10</b:IntegerValue> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue>10</b:NumericValue> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Resource</b:UdfName> <b:UdfUid>1152921504606856794</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>R</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue> <b:ResourceDisplayName>John Doe</b:ResourceDisplayName> <b:ResourceId i:nil="true"/> <b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId> <b:ResourceUid>1152921504607062225</b:ResourceUid> </b:ResourceIdentityValue> <b:TextValue i:nil="true"/> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Text</b:UdfName> <b:UdfUid>1152921504606856795</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>T</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue>Parent Client</b:TextValue> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Text List</b:UdfName> <b:UdfUid>1152921504606856796</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>L</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue>CL-1A</b:TextValue> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Boolean</b:UdfName> <b:UdfUid>1152921504606856797</b:UdfUid> <b:BooleanValue>true</b:BooleanValue> <b:DataType>Y</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Stoplight</b:UdfName> <b:UdfUid>1152921504606856814</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>S</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues> <b:PwsStoplightValue> <b:AsOfDate>2018-01-17T00:00:00Z</b:AsOfDate> <b:SortOrder>2</b:SortOrder> </b:PwsStoplightValue> </b:StoplightValues> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> <b:PwsUserDefinedFieldDetail> <b:UdfId i:nil="true"/> <b:UdfName>CL-Multiline</b:UdfName> <b:UdfUid>1152921504606858027</b:UdfUid> <b:BooleanValue i:nil="true"/> <b:DataType>T</b:DataType> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:ResourceIdentityValue i:nil="true"/> <b:TextValue>This is a parent client.</b:TextValue> <b:UdfTreatment>A</b:UdfTreatment> <b:StoplightValues/> <b:NumericValue i:nil="true"/> <b:RelationValue i:nil="true"/> </b:PwsUserDefinedFieldDetail> </b:UserDefinedFields> <b:InheritInvoiceEmailSettingsFlag>false</b:InheritInvoiceEmailSettingsFlag> <b:InvoiceEmailSettings> <b:EmailFromUserIdentity> <b:UserDisplayName>Betty Smith</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId> <b:UserUid>1152921504607011056</b:UserUid> </b:EmailFromUserIdentity> <b:EmailInvoiceTemplateIdentity> <b:InvoiceTemplateId i:nil="true"/> <b:InvoiceTemplateName>E001</b:InvoiceTemplateName> <b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid> </b:EmailInvoiceTemplateIdentity> <b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag> <b:InvoiceEmailType>P</b:InvoiceEmailType> <b:Recipients> <b:PwsInvoiceEmailRecipient> <b:RecipientType>T</b:RecipientType> <b:UserIdentity> <b:UserDisplayName>Abby Whelan</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId> <b:UserUid>1152921504607062210</b:UserUid> </b:UserIdentity> </b:PwsInvoiceEmailRecipient> </b:Recipients> </b:InvoiceEmailSettings> <b:InheritRenderReceiptsFlag>false</b:InheritRenderReceiptsFlag> <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag> <b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag> <b:InheritAutoApplyAvailableBalanceFlag>false</b:InheritAutoApplyAvailableBalanceFlag> <b:InheritTaxTypesFlag>false</b:InheritTaxTypesFlag> <b:TaxType1Identity> <b:TaxTypeCode>VAT</b:TaxTypeCode> <b:TaxTypeId i:nil="true"/> <b:TaxTypeUid>1152921504606868258</b:TaxTypeUid> </b:TaxType1Identity> <b:TaxType2Identity i:nil="true"/> <b:TaxType3Identity i:nil="true"/> </b:ClientDetail> </b:PwsClientElement>
- No labels