Overview
This web service inserts or updates a single client based on a detailed client structure (PwsClientDetail). The service returns the identity (PwsClientRef) of the client that has been inserted or updated. The caller can optionally request that the full client detail (PwsClientDetail) be included in the response.
| Panel |
|---|
|
- PwsSaveClientRq
- Client: PwsClientDetail [1]
- FullDetailFlag: Boolean
- ParentClientClearFlag: Boolean
|
Request Elements
| Element | Data Type | Required? | Default | Description |
|---|
| Client Detail | PwsClientDetail [1] |
|
|
|
| FullDetailFlag | Boolean | No | false | Valid values include "true" or "false". If set to "true" include full detailed client element in response |
| ParentClientClearFlag | Boolean | No | false | Valid values include "true" or "false". If set to "true" null out parent client |
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 |
|---|
| collapse | true |
|---|
|
<PwsSaveClient>
<serviceRequest>
<!--RequestId>?</RequestId-->
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
<Client>
<!--ClientId>?</ClientId-->
<!--ClientNumber>?</ClientNumber-->
<!--ClientUid>?</ClientUid-->
<ClientName>Acme 1000-01</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity>
<!--ClientId>?</ClientId-->
<!--ClientNumber>?</ClientNumber-->
<!--ClientUid>?</ClientUid-->
</ParentClientIdentity>
<Address>
<AddressLine1>123 Main Street</AddressLine1>
<AddressLine2>Suite 100</AddressLine2>
<Attention>Jane Smith</Attention>
<City>Boston</City>
<CompanyName>Acme 1000-01</CompanyName>
<Country>USA</Country>
<StateOrProvince>MA</StateOrProvince>
<ZipOrPostalCode>02114</ZipOrPostalCode>
</Address>
<BillingCycleIdentity>
<!--BillingCycleId>?</BillingCycleId-->
<BillingCycleName>Monthly</BillingCycleName>
<!--BillingCycleUid>?</BillingCycleUid-->
</BillingCycleIdentity>
<BillingInstructions>Bill on the last day of the 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>false</InheritStandardRatesFlag>
<InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>
<InvoiceContent>B</InvoiceContent>
<InvoiceScope>E</InvoiceScope>
<InvoiceTemplateIdentity>
<!--InvoiceTemplateId>?</InvoiceTemplateId-->
<InvoiceTemplateName>A200</InvoiceTemplateName>
<!--InvoiceTemplateUid>?</InvoiceTemplateUid-->
</InvoiceTemplateIdentity>
<NewClientNumber>C001001</NewClientNumber>
<PaymentTermIdentity>
<!--PaymentTermId>?</PaymentTermId-->
<PaymentTermName>Net 60</PaymentTermName>
<!--PaymentTermUid>?</PaymentTermUid-->
</PaymentTermIdentity>
<PurchaseOrderNumber>C001000</PurchaseOrderNumber>
<StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent>
<StandardContractDiscountPercent>0</StandardContractDiscountPercent>
<StandardRateCardIdentity>
<!--RateCardId>?</RateCardId-->
<RateCardName>USA Rate Card</RateCardName>
<RateCardType>R</RateCardType>
<!--RateCardUid>?</RateCardUid-->
</StandardRateCardIdentity>
<TimeBillingType>H</TimeBillingType>
<!--Timestamp>?</Timestamp-->
<UserDefinedFields>
<PwsUserDefinedFieldDetail>
<!--UdfId>?</UdfId-->
<UdfName>Account Owner</UdfName>
<!--UdfUid>?</UdfUid-->
<!--BooleanValue>?</BooleanValue-->
<DataType>R</DataType>
<!--DateValue>?</DateValue-->
<!--IntegerValue>?</IntegerValue-->
<ResourceIdentityValue>
<ResourceDisplayName>Jack Spratt</ResourceDisplayName>
<!--ResourceId>?</ResourceId-->
<ResourceReferenceSystemId>E123</ResourceReferenceSystemId>
<!--ResourceUid>?</ResourceUid-->
</ResourceIdentityValue>
<!--TextValue>?</TextValue-->
<UdfTreatment>A</UdfTreatment>
<!--StoplightValues-->
<!--PwsStoplightValue-->
<!--AsOfDate>?</AsOfDate-->
<!--SortOrder>?</SortOrder-->
<!--/PwsStoplightValue-->
<!--/StoplightValues-->
<!--NumericValue>?</NumericValue-->
<!--RelationValue-->
<!--CodeValue>?</CodeValue-->
<!--TextValue>?</TextValue-->
<!--UidValue>?</UidValue-->
<!--/RelationValue-->
</PwsUserDefinedFieldDetail>
</UserDefinedFields>
<InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>
<InvoiceEmailSettings>
<EmailFromUserIdentity>
<UserDisplayName>Bettina Borces</UserDisplayName>
<!--UserId>?</UserId-->
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
<!--UserUid>?</UserUid-->
</EmailFromUserIdentity>
<EmailInvoiceTemplateIdentity>
<!--InvoiceTemplateId>?</InvoiceTemplateId-->
<InvoiceTemplateName>E004</InvoiceTemplateName>
<!--InvoiceTemplateUid>?</InvoiceTemplateUid-->
</EmailInvoiceTemplateIdentity>
<InvoiceEmailEnabledFlag>false</InvoiceEmailEnabledFlag>
<InvoiceEmailType>P</InvoiceEmailType>
<Recipients>
<PwsInvoiceEmailRecipient>
<RecipientType>T</RecipientType>
<UserIdentity>
<UserDisplayName>Jane Doe</UserDisplayName>
<!--UserId>?</UserId-->
<UserReferenceSystemId>E124</UserReferenceSystemId>
<!--UserUid>?</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>?</TaxTypeId-->
<!--TaxTypeUid>?</TaxTypeUid-->
</TaxType1Identity>
<!--TaxType2Identity-->
<!--TaxTypeCode>?</TaxTypeCode-->
<!--TaxTypeId>?</TaxTypeId-->
<!--TaxTypeUid>?</TaxTypeUid-->
<!--/TaxType2Identity-->
<!--TaxType3Identity-->
<!--TaxTypeCode>?</TaxTypeCode-->
<!--TaxTypeId>?</TaxTypeId-->
<!--TaxTypeUid>?</TaxTypeUid-->
<!--/TaxType3Identity-->
</Client>
<FullDetailFlag>true</FullDetailFlag>
<ParentClientClearFlag>false</ParentClientClearFlag>
</serviceRequest>
</PwsSaveClient> |
Response Elements
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 |
|---|
| collapse | true |
|---|
|
<PwsSaveClientResponse>
<PwsSaveClientResult>
<Messages>
<PwsMessage>
<AdditionalErrorText i:nil="true"/>
<ErrorCode i:nil="true"/>
<ErrorNumber i:nil="true"/>
<ErrorText i:nil="true"/>
<Type i:nil="true"/>
<ReferenceId1 i:nil="true"/>
<ReferenceId2 i:nil="true"/>
</PwsMessage>
</Messages>
<ResponseId>0</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2017-12-27T16:48:52.6790058Z</ServerTimestampUtc>
<Client>
<ClientDetail>
<ClientId i:nil="true"/>
<ClientNumber>C001001</ClientNumber>
<ClientUid>1152921504606989819</ClientUid>
<ClientName>Acme 1000-01</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity i:nil="true"/>
<Address>
<AddressLine1>123 Main Street</AddressLine1>
<AddressLine2>Suite 100</AddressLine2>
<Attention>Jane Smith</Attention>
<City>Boston</City>
<CompanyName>Acme 1000-01</CompanyName>
<Country>USA</Country>
<StateOrProvince>MA</StateOrProvince>
<ZipOrPostalCode>02114</ZipOrPostalCode>
</Address>
<BillingCycleIdentity>
<BillingCycleId i:nil="true"/>
<BillingCycleName>Monthly</BillingCycleName>
<BillingCycleUid>1152921504606853180</BillingCycleUid>
</BillingCycleIdentity>
<BillingInstructions>Bill on the last day of the 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>false</InheritStandardRatesFlag>
<InheritTimeBillingTypeFlag>false</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 60</PaymentTermName>
<PaymentTermUid>1152921504606856055</PaymentTermUid>
</PaymentTermIdentity>
<PurchaseOrderNumber>C001000</PurchaseOrderNumber>
<StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent>
<StandardContractDiscountPercent>0</StandardContractDiscountPercent>
<StandardRateCardIdentity>
<RateCardId i:nil="true"/>
<RateCardName>USA Rate Card</RateCardName>
<RateCardType>R</RateCardType>
<RateCardUid>1152921504606860819</RateCardUid>
</StandardRateCardIdentity>
<TimeBillingType>H</TimeBillingType>
<Timestamp>AAAAAA61TDI=</Timestamp>
<UserDefinedFields>
<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>
</UserDefinedFields>
<InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>
<InvoiceEmailSettings>
<EmailFromUserIdentity>
<UserDisplayName>Bettina Borces</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
<UserUid>1152921504607011056</UserUid>
</EmailFromUserIdentity>
<EmailInvoiceTemplateIdentity>
<InvoiceTemplateId i:nil="true"/>
<InvoiceTemplateName>E004</InvoiceTemplateName>
<InvoiceTemplateUid>1152921504606878909</InvoiceTemplateUid>
</EmailInvoiceTemplateIdentity>
<InvoiceEmailEnabledFlag>false</InvoiceEmailEnabledFlag>
<InvoiceEmailType>P</InvoiceEmailType>
<Recipients>
<PwsInvoiceEmailRecipient>
<RecipientType>T</RecipientType>
<UserIdentity>
<UserDisplayName>Jane Doe</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>E124</UserReferenceSystemId>
<UserUid>1152921504607112368</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>
</Client>
<ClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>C001001</ClientNumber>
<ClientUid>1152921504606989819</ClientUid>
</ClientIdentity>
</PwsSaveClientResult>
</PwsSaveClientResponse> |
Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText | Type |
|---|
| 105 | AtLeastOneItemNotFound | At least one client was not found | Warning |
| 11038 | NoClientsSpecified | No clients specified for retrieval | Error |
| 11040 | MaximumClientIdentitiesExceeded | Attempt to retrieve more than the maximum allowable number of clients at once | Error |
| 50045 | ViewPermissionDenied | Permission denied | Error |
| 57631 | ClientNotSpecified | A specified client reference was incomplete | Error |
| 57634 | UnexpectedErrorRetrievingClients | Unexpected error retrieving clients | Error |