...
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 (PwsClientDetailPwsClientElement) be included in the response.
Request Format
| Panel |
|---|
| title | PwsSaveClient Request |
|---|
|
| |
...
Request Elements
| Element | Data Type | Required? | Default | Description | Sample Data |
|---|
| RequestId | Int32 | No |
| Click here for more information | 1 |
| SessionTicket | Client Detail | PwsClientDetail [1]String (50) | Yes |
| Click here for more information | AavFwbZgVb9V4tr3R7BbzQ== |
| Client | PwsClientDetail | Yes |
| The detailed client information to be inserted or updated |
|
| FullDetailFlag | Boolean | No | false | Valid values include "true" or "false". If set to " true" , include full detailed client element in response | true/false |
| ParentClientClearFlag | Boolean | No | false | Valid values include "true" or "false". If set to " true" null out , the parent client will be set to null | true/false |
Request Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01New Client |
|---|
| collapse | true |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" <PwsSaveClient>
xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<serviceRequest> <pws:PwsSaveClient>
<!--RequestId>?</RequestId--><pws:serviceRequest>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket><req:RequestId>1</req:RequestId>
<Client><req:SessionTicket>AVPtg8pZ/KFy3PWleHmQEw==</req:SessionTicket>
<req:Client>
<!--ClientId>?</ClientId--> <com:ClientName>SOAP UI A</com:ClientName>
<!--ClientNumber>?</ClientNumber--> <!--ClientUid>?</ClientUid--><com:InactiveFlag>false</com:InactiveFlag>
<ClientName>Acme 1000-01</ClientName><com:Address>
<InactiveFlag>false</InactiveFlag> <com:AddressLine1>311 South Wacker</com:AddressLine1>
<ParentClientIdentity> <com:AddressLine2>Suite 2300</com:AddressLine2>
<!--ClientId>?</ClientId--> <com:City>Chicago</com:City>
<!--ClientNumber>?</ClientNumber--> <com:CompanyName>SOAP UI A</com:CompanyName>
<!--ClientUid>?</ClientUid--> <com:Country>USA</com:Country>
</ParentClientIdentity> <com:StateOrProvince>Illinois</com:StateOrProvince>
<Address> <com:ZipOrPostalCode>60601</com:ZipOrPostalCode>
<AddressLine1>123 Main Street</AddressLine1> </com:Address>
<AddressLine2>Suite 100</AddressLine2> <com:BillingCycleIdentity>
<Attention>Jane Smith</Attention> <com:BillingCycleName>Monthly</com:BillingCycleName>
<City>Boston</City> </com:BillingCycleIdentity>
<CompanyName>Acme 1000-01</CompanyName>
<com:BillingInstructions>Please bill at the end of each month</com:BillingInstructions>
<Country>USA</Country> <com:ClientMessage>Thank you for your business!</com:ClientMessage>
<StateOrProvince>MA</StateOrProvince> <com:ClientMessagePlain>Thank you for your business!</com:ClientMessagePlain>
<ZipOrPostalCode>02114</ZipOrPostalCode> <com:InheritAddressFlag>false</com:InheritAddressFlag>
</Address> <com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
<BillingCycleIdentity> <com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
<!--BillingCycleId>?</BillingCycleId--> <com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
<BillingCycleName>Monthly</BillingCycleName><com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
<!--BillingCycleUid>?</BillingCycleUid--><com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
</BillingCycleIdentity><com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
<BillingInstructions>Bill on the last day of the month</BillingInstructions><com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
<ClientMessage>We appreciate your business!</ClientMessage><com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
<ClientMessagePlain>We appreciate your business!</ClientMessagePlain><com:InheritStandardRatesFlag>false</com:InheritStandardRatesFlag>
<InheritAddressFlag>false</InheritAddressFlag><com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
<InheritBillingCycleFlag>false</InheritBillingCycleFlag><com:InvoiceContent>B</com:InvoiceContent>
<InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag><com:InvoiceScope>E</com:InvoiceScope>
<InheritClientMessageFlag>false</InheritClientMessageFlag><com:InvoiceTemplateIdentity>
<InheritInvoiceContentFlag>false</InheritInvoiceContentFlag> <com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
<InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag> </com:InvoiceTemplateIdentity>
<InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag> <com:PaymentTermIdentity>
<InheritPaymentTermFlag>false</InheritPaymentTermFlag> <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag><com:PaymentTermName>Net 30</com:PaymentTermName>
<InheritStandardRatesFlag>false</InheritStandardRatesFlag></com:PaymentTermIdentity>
<com:PurchaseOrderNumber>SOAP <InheritTimeBillingTypeFlag>false<UI</InheritTimeBillingTypeFlag>com:PurchaseOrderNumber>
<InvoiceContent>B</InvoiceContent><com:StandardBillingAdjustedDiscountPercent>10</com:StandardBillingAdjustedDiscountPercent>
<InvoiceScope>E</InvoiceScope><com:StandardContractDiscountPercent>5</com:StandardContractDiscountPercent>
<InvoiceTemplateIdentity><com:StandardRateCardIdentity>
<!--InvoiceTemplateId>?</InvoiceTemplateId--><com:RateCardName>USA</com:RateCardName>
<InvoiceTemplateName>A200</InvoiceTemplateName>
<com:RateCardType>R</com:RateCardType>
<!--InvoiceTemplateUid>?</InvoiceTemplateUid-->com:StandardRateCardIdentity>
</InvoiceTemplateIdentity><com:TimeBillingType>H</com:TimeBillingType>
<NewClientNumber>C001001</NewClientNumber><com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
<com:InvoiceEmailSettings>
<PaymentTermIdentity> <com:EmailFromUserIdentity>
<!--PaymentTermId>?</PaymentTermId--> <PaymentTermName>Net 60</PaymentTermName><com:UserDisplayName>Bettina</com:UserDisplayName>
<!--PaymentTermUid>?</PaymentTermUid-->
/com:EmailFromUserIdentity>
</PaymentTermIdentity> <com:EmailInvoiceTemplateIdentity>
<PurchaseOrderNumber>C001000</PurchaseOrderNumber> <com:InvoiceTemplateName>E002</com:InvoiceTemplateName>
<StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent> </com:EmailInvoiceTemplateIdentity>
<StandardContractDiscountPercent>0</StandardContractDiscountPercent> <StandardRateCardIdentity><com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
<!--RateCardId>?</RateCardId--><com:InvoiceEmailType>W</com:InvoiceEmailType>
<RateCardName>USA<com:Recipients>
Rate Card</RateCardName> <RateCardType>R</RateCardType> <com:PwsInvoiceEmailRecipient>
<!--RateCardUid>?</RateCardUid--> <com:RecipientType>T</com:RecipientType>
</StandardRateCardIdentity> <TimeBillingType>H</TimeBillingType><com:UserIdentity>
<!--Timestamp>?</Timestamp--> <com:UserDisplayName>SOAP UI</com:UserDisplayName>
<UserDefinedFields> <PwsUserDefinedFieldDetail> </com:UserIdentity>
<!--UdfId>?</UdfId--> </com:PwsInvoiceEmailRecipient>
<UdfName>Account Owner</UdfName>
</com:Recipients>
<!--UdfUid>?</UdfUid-->com:InvoiceEmailSettings>
<com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
<!--BooleanValue>?</BooleanValue--> <com:RenderReceiptsFlag>false</com:RenderReceiptsFlag>
<DataType>R</DataType> <com:AutoApplyAvailableBalanceFlag>false</com:AutoApplyAvailableBalanceFlag>
<com:InheritAutoApplyAvailableBalanceFlag>false</com:InheritAutoApplyAvailableBalanceFlag>
<!--DateValue>?</DateValue--> <com:InheritTaxTypesFlag>false</com:InheritTaxTypesFlag>
<!--IntegerValue>?</IntegerValue--> <com:InheritRenderedInvoiceFormatFlag>false</com:InheritRenderedInvoiceFormatFlag>
<com:RenderedInvoiceFormat>P</com:RenderedInvoiceFormat>
<ResourceIdentityValue> <com:Prefix>01312024</com:Prefix>
<ResourceDisplayName>Jack Spratt<</ResourceDisplayName>req:Client>
<req:FullDetailFlag>true</req:FullDetailFlag>
<!--ResourceId>?</ResourceId--> <req:ParentClientClearFlag>false</req:ParentClientClearFlag>
<ResourceReferenceSystemId>E123</ResourceReferenceSystemId><req:DisallowDuplicateNameFlag>false</req:DisallowDuplicateNameFlag>
<req:FixInheritanceFlag>false</req:FixInheritanceFlag>
<!--ResourceUid>?</ResourceUid-->/pws:serviceRequest>
</pws:PwsSaveClient>
</ResourceIdentityValue>
<!--TextValue>?</TextValue-->
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client without Parent |
|---|
| collapse | true |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsSaveClient>
<pws:serviceRequest>
<UdfTreatment>A</UdfTreatment> <req:RequestId>1</req:RequestId>
<!--StoplightValues--><req:SessionTicket>AaBd4dMYPbBiEeXoiz50NQ==</req:SessionTicket>
<req:Client>
<!--PwsStoplightValue--> <com:ClientNumber>C000158</com:ClientNumber>
<com:InactiveFlag>false</com:InactiveFlag>
<!--AsOfDate>?</AsOfDate--> <com:Address>
<!--SortOrder>?</SortOrder-->
<com:AddressLine1>98 North Washington Street</com:AddressLine1>
<!--/PwsStoplightValue--><com:AddressLine2>400</com:AddressLine2>
<!--/StoplightValues--><com:Attention>Office Administrator</com:Attention>
<!--NumericValue>?</NumericValue--><com:City>Boston</com:City>
<com:CompanyName>Projector PSA</com:CompanyName>
<!--RelationValue--> <com:Country>USA</com:Country>
<!--CodeValue>?</CodeValue--> <com:StateOrProvince>MA</com:StateOrProvince>
<!--TextValue>?</TextValue--> <com:ZipOrPostalCode>02114</com:ZipOrPostalCode>
<!--UidValue>?</UidValue-->/com:Address>
<com:BillingCycleIdentity>
<!--/RelationValue--> <com:BillingCycleName>Monthly</com:BillingCycleName>
</PwsUserDefinedFieldDetail> </com:BillingCycleIdentity>
</UserDefinedFields> <com:BillingInstructions>Please bill on the last day <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>of the month.</com:BillingInstructions>
<InvoiceEmailSettings> <com:ClientMessage>We appreciate your business.</com:ClientMessage>
<EmailFromUserIdentity> <com:ClientMessagePlain>We appreciate your business.</com:ClientMessagePlain>
<com:InheritAddressFlag>false</com:InheritAddressFlag>
<UserDisplayName>Bettina Borces</UserDisplayName> <com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
<!--UserId>?</UserId--> <com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId><com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
<com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
<!--UserUid>?</UserUid--> <com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
</EmailFromUserIdentity> <com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
<EmailInvoiceTemplateIdentity> <com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
<com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
<!--InvoiceTemplateId>?</InvoiceTemplateId--> <com:InheritStandardRatesFlag>false</com:InheritStandardRatesFlag>
<InvoiceTemplateName>E004</InvoiceTemplateName> <com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
<!--InvoiceTemplateUid>?</InvoiceTemplateUid--><com:InvoiceContent>B</com:InvoiceContent>
</EmailInvoiceTemplateIdentity><com:InvoiceScope>E</com:InvoiceScope>
<com:InvoiceTemplateIdentity>
<InvoiceEmailEnabledFlag>false</InvoiceEmailEnabledFlag> <com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
<InvoiceEmailType>P</InvoiceEmailType> </com:InvoiceTemplateIdentity>
<Recipients> <com:PaymentTermIdentity>
<PwsInvoiceEmailRecipient> <com:PaymentTermName>Net 30</com:PaymentTermName>
<RecipientType>T</RecipientType></com:PaymentTermIdentity>
<com:PurchaseOrderNumber>PPSA</com:PurchaseOrderNumber>
<UserIdentity> <com:StandardBillingAdjustedDiscountPercent>15</com:StandardBillingAdjustedDiscountPercent>
<com:StandardContractDiscountPercent>10</com:StandardContractDiscountPercent>
<UserDisplayName>Jane Doe</UserDisplayName> <com:StandardRateCardIdentity>
<!--UserId>?</UserId--><com:RateCardName>USA</com:RateCardName>
<com:RateCardType>R</com:RateCardType>
<UserReferenceSystemId>E124</UserReferenceSystemId> </com:StandardRateCardIdentity>
<com:TimeBillingType>H</com:TimeBillingType>
<!--UserUid>?</UserUid--> <com:UserDefinedFields>
</UserIdentity> <com:PwsUserDefinedFieldDetail>
</PwsInvoiceEmailRecipient> <com:UdfName>CL-Text</com:UdfName>
</Recipients> <com:TextValue>Updated on November 6th, 2023</com:TextValue>
</InvoiceEmailSettings> <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag></com:PwsUserDefinedFieldDetail>
<RenderReceiptsFlag>false<</RenderReceiptsFlag>com:UserDefinedFields>
<AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag><com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
<InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag><com:InvoiceEmailSettings>
<InheritTaxTypesFlag>false</InheritTaxTypesFlag> <com:EmailFromUserIdentity>
<TaxType1Identity> <com:UserDisplayName>Bettina</com:UserDisplayName>
<TaxTypeCode>VAT</TaxTypeCode> </com:EmailFromUserIdentity>
<!--TaxTypeId>?</TaxTypeId--> <com:EmailInvoiceTemplateIdentity>
<!--TaxTypeUid>?</TaxTypeUid--> <com:InvoiceTemplateName>E002</com:InvoiceTemplateName>
</TaxType1Identity> <!--TaxType2Identity-->/com:EmailInvoiceTemplateIdentity>
<!--TaxTypeCode>?</TaxTypeCode--><com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
<!--TaxTypeId>?</TaxTypeId--><com:InvoiceEmailType>W</com:InvoiceEmailType>
<com:Recipients>
<!--TaxTypeUid>?</TaxTypeUid--> <!--/TaxType2Identity--><com:PwsInvoiceEmailRecipient>
<!--TaxType3Identity--> <com:RecipientType>T</com:RecipientType>
<!--TaxTypeCode>?</TaxTypeCode--> <com:UserIdentity>
<!--TaxTypeId>?</TaxTypeId--> <!--TaxTypeUid>?</TaxTypeUid--> <com:UserDisplayName>Template Client</com:UserDisplayName>
<!--/TaxType3Identity-->/com:UserIdentity>
</Client>com:PwsInvoiceEmailRecipient>
<FullDetailFlag>true</FullDetailFlag></com:Recipients>
<ParentClientClearFlag>false</ParentClientClearFlag></com:InvoiceEmailSettings>
</serviceRequest><com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
</PwsSaveClient> |
Response Format
- This response also includes the Common Output Elements
Response Elements
...
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 |
|---|
| collapse | true |
|---|
|
<com:RenderReceiptsFlag>true</com:RenderReceiptsFlag>
<PwsSaveClientResponse> <PwsSaveClientResult> <com:AutoApplyAvailableBalanceFlag>false</com:AutoApplyAvailableBalanceFlag>
<Messages> <com:InheritAutoApplyAvailableBalanceFlag>false</com:InheritAutoApplyAvailableBalanceFlag>
<PwsMessage> <com:InheritTaxTypesFlag>true</com:InheritTaxTypesFlag>
<AdditionalErrorText i:nil="true"/><com:InheritRenderedInvoiceFormatFlag>false</com:InheritRenderedInvoiceFormatFlag>
<com:RenderedInvoiceFormat>P</com:RenderedInvoiceFormat>
<ErrorCode>NonProductionEnvironment</ErrorCode> <com:Prefix>11062023</com:Prefix>
<ErrorNumber>136</ErrorNumber> </req:Client>
<ErrorText i:nil="true"/><req:FullDetailFlag>true</req:FullDetailFlag>
<req:ParentClientClearFlag>false</req:ParentClientClearFlag>
<Type>Information</Type> <req:DisallowDuplicateNameFlag>true</req:DisallowDuplicateNameFlag>
<ReferenceId1 i:nil="true"/><req:FixInheritanceFlag>false</req:FixInheritanceFlag>
</pws:serviceRequest>
<ReferenceId2 i:nil="true"/>
</pws:PwsSaveClient>
</PwsMessage>
</Messages>
<ResponseId>0</ResponseId>
soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| language | xml |
|---|
| title | Example 02 - Client with parent |
|---|
| collapse | true |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsSaveClient>
<Status>Ok</Status> <pws:serviceRequest>
<ServerTimestampUtc>2017-12-27T16:48:52.6790058Z</ServerTimestampUtc> <req:RequestId>2</req:RequestId>
<Client> <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<ClientDetail> <req:Client>
<ClientId i:nil="true"/>
<com:ClientName>Web Services Inc. - extended</com:ClientName>
<ClientNumber>C001001</ClientNumber><com:InactiveFlag>false</com:InactiveFlag>
<com:ParentClientIdentity>
<ClientUid>1152921504606989819</ClientUid> <com:ClientNumber>C000124</com:ClientNumber>
<ClientName>Acme 1000-01</ClientName> </com:ParentClientIdentity>
<InactiveFlag>false</InactiveFlag> <com:InheritAddressFlag>true</com:InheritAddressFlag>
<ParentClientIdentity i:nil="true"/> <com:InheritBillingCycleFlag>true</com:InheritBillingCycleFlag>
<Address> <com:InheritBillingInstructionsFlag>true</com:InheritBillingInstructionsFlag>
<com:InheritClientMessageFlag>true</com:InheritClientMessageFlag>
<AddressLine1>123 Main Street</AddressLine1> <com:InheritInvoiceContentFlag>true</com:InheritInvoiceContentFlag>
<AddressLine2>Suite 100</AddressLine2> <com:InheritInvoiceScopeFlag>true</com:InheritInvoiceScopeFlag>
<com:InheritInvoiceTemplateFlag>true</com:InheritInvoiceTemplateFlag>
<Attention>Jane Smith</Attention> <com:InheritPaymentTermFlag>true</com:InheritPaymentTermFlag>
<City>Boston</City> <com:InheritPurchaseOrderNumberFlag>true</com:InheritPurchaseOrderNumberFlag>
<CompanyName>Acme 1000-01</CompanyName><com:InheritStandardRatesFlag>true</com:InheritStandardRatesFlag>
<com:InheritTimeBillingTypeFlag>true</com:InheritTimeBillingTypeFlag>
<Country>USA</Country> <com:UserDefinedFields>
<StateOrProvince>MA</StateOrProvince> <com:PwsUserDefinedFieldDetail>
<ZipOrPostalCode>02114</ZipOrPostalCode><com:UdfName>CL-Date</com:UdfName>
</Address> <com:DateValue>2018-02-28T00:00:00Z</com:DateValue>
<BillingCycleIdentity> </com:PwsUserDefinedFieldDetail>
<BillingCycleId i:nil="true"/><com:PwsUserDefinedFieldDetail>
<BillingCycleName>Monthly</BillingCycleName><com:UdfName>CL-Text</com:UdfName>
<com:TextValue>Child of <BillingCycleUid>1152921504606853180</BillingCycleUid>Client C00124</com:TextValue>
</BillingCycleIdentity>com:PwsUserDefinedFieldDetail>
</com:UserDefinedFields>
<BillingInstructions>Bill on the last day of the month</BillingInstructions> <com:InheritInvoiceEmailSettingsFlag>true</com:InheritInvoiceEmailSettingsFlag>
<ClientMessage>We appreciate your business!</ClientMessage> <com:InheritRenderReceiptsFlag>true</com:InheritRenderReceiptsFlag>
<com:InheritAutoApplyAvailableBalanceFlag>true</com:InheritAutoApplyAvailableBalanceFlag>
<ClientMessagePlain>We appreciate your business!</ClientMessagePlain> <com:InheritTaxTypesFlag>true</com:InheritTaxTypesFlag>
<InheritAddressFlag>false</InheritAddressFlag> </req:Client>
<InheritBillingCycleFlag>false</InheritBillingCycleFlag><req:FullDetailFlag>true</req:FullDetailFlag>
<InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag><req:ParentClientClearFlag>false</req:ParentClientClearFlag>
</pws:serviceRequest>
<InheritClientMessageFlag>false</InheritClientMessageFlag></pws:PwsSaveClient>
<InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>
<InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>
<InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>
<InheritPaymentTermFlag>false</InheritPaymentTermFlag>
<InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
Response Elements
Response Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 |
|---|
| collapse | true |
|---|
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<InheritStandardRatesFlag>false</InheritStandardRatesFlag><PwsSaveClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveClientResult <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<InvoiceContent>B</InvoiceContent><Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<InvoiceScope>E</InvoiceScope><ResponseId xmlns="http://projectorpsa.com/CommonServices/">2</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<InvoiceTemplateIdentity> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T20:37:34.987952Z</ServerTimestampUtc>
<InvoiceTemplateId i:nil="true"/> <a:Client xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<InvoiceTemplateName>A200</InvoiceTemplateName> <b:ClientDetail>
<InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid><b:ClientId i:nil="true"/>
</InvoiceTemplateIdentity><b:ClientNumber>C000127</b:ClientNumber>
<NewClientNumber i:nil="true"/><b:ClientUid>1152921504606998468</b:ClientUid>
<PaymentTermIdentity><b:ClientName>Web Services Inc. - extended</b:ClientName>
<PaymentTermId i:nil="true"/><b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<PaymentTermName>Net 60</PaymentTermName> <b:ClientId i:nil="true"/>
<PaymentTermUid>1152921504606856055</PaymentTermUid> </PaymentTermIdentity><b:ClientNumber>C000124</b:ClientNumber>
<PurchaseOrderNumber>C001000</PurchaseOrderNumber><b:ClientUid>1152921504606998465</b:ClientUid>
<StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent></b:ParentClientIdentity>
<b:Address>
<StandardContractDiscountPercent>0</StandardContractDiscountPercent> <StandardRateCardIdentity><b:AddressLine1>123 Main Street</b:AddressLine1>
<RateCardId i:nil="true"/><b:AddressLine2>Suite 100</b:AddressLine2>
<RateCardName>USA Rate Card</RateCardName><b:Attention>Billing</b:Attention>
<RateCardType>R</RateCardType><b:City>Boston</b:City>
<RateCardUid>1152921504606860819</RateCardUid><b:CompanyName>Acme Inc.</b:CompanyName>
</StandardRateCardIdentity><b:Country>USA</b:Country>
<TimeBillingType>H</TimeBillingType> <b:StateOrProvince>MA</b:StateOrProvince>
<Timestamp>AAAAAA61TDI=</Timestamp> <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
<UserDefinedFields> </b:Address>
<PwsUserDefinedFieldDetail> <b:BillingCycleIdentity>
<UdfId<b:BillingCycleId i:nil="true"/>
<UdfName>Account Owner</UdfName><b:BillingCycleName>Monthly</b:BillingCycleName>
<b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
<UdfUid>1152921504606856794</UdfUid> </b:BillingCycleIdentity>
<BooleanValue i:nil="true"/> <b:BillingInstructions>Please bill on the last day of the month.</b:BillingInstructions>
<DataType>R</DataType> <b:ClientMessage>We appreciate your business.</b:ClientMessage>
<DateValue i:nil="true"/> <b:ClientMessagePlain>We appreciate your business.</b:ClientMessagePlain>
<IntegerValue i:nil="true"/><b:InheritAddressFlag>true</b:InheritAddressFlag>
<b:InheritBillingCycleFlag>true</b:InheritBillingCycleFlag>
<ResourceIdentityValue> <b:InheritBillingInstructionsFlag>true</b:InheritBillingInstructionsFlag>
<ResourceDisplayName>Jack Spratt</ResourceDisplayName><b:InheritClientMessageFlag>true</b:InheritClientMessageFlag>
<b:InheritInvoiceContentFlag>true</b:InheritInvoiceContentFlag>
<ResourceId i:nil="true"/> <b:InheritInvoiceScopeFlag>true</b:InheritInvoiceScopeFlag>
<ResourceReferenceSystemId>E123</ResourceReferenceSystemId><b:InheritInvoiceTemplateFlag>true</b:InheritInvoiceTemplateFlag>
<b:InheritPaymentTermFlag>true</b:InheritPaymentTermFlag>
<ResourceUid>1152921504607111573</ResourceUid> <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
</ResourceIdentityValue> <b:InheritStandardRatesFlag>true</b:InheritStandardRatesFlag>
<b:InheritTimeBillingTypeFlag>true</b:InheritTimeBillingTypeFlag>
<TextValue i:nil="true"/> <b:InvoiceContent>B</b:InvoiceContent>
<UdfTreatment>A</UdfTreatment> <b:InvoiceScope>E</b:InvoiceScope>
<StoplightValues/> <b:InvoiceTemplateIdentity>
<NumericValue<b:InvoiceTemplateId i:nil="true"/>
<RelationValue i:nil="true"/><b:InvoiceTemplateName>A200</b:InvoiceTemplateName>
</PwsUserDefinedFieldDetail><b:InvoiceTemplateUid>1152921504606878904</b:InvoiceTemplateUid>
</UserDefinedFields>b:InvoiceTemplateIdentity>
<InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag><b:NewClientNumber i:nil="true"/>
<InvoiceEmailSettings><b:PaymentTermIdentity>
<EmailFromUserIdentity>
<b:PaymentTermId i:nil="true"/>
<UserDisplayName>Bettina Borces</UserDisplayName><b:PaymentTermName>Net 60</b:PaymentTermName>
<UserId i:nil="true"/><b:PaymentTermUid>1152921504606856055</b:PaymentTermUid>
</b:PaymentTermIdentity>
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId> <b:PurchaseOrderNumber>WS-001</b:PurchaseOrderNumber>
<UserUid>1152921504607011056</UserUid> <b:StandardBillingAdjustedDiscountPercent>15</b:StandardBillingAdjustedDiscountPercent>
</EmailFromUserIdentity> <b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent>
<b:StandardRateCardIdentity>
<EmailInvoiceTemplateIdentity> <InvoiceTemplateId <b:RateCardId i:nil="true"/>
<b:RateCardName>USA Rate <InvoiceTemplateName>E004</InvoiceTemplateName>Card</b:RateCardName>
<b:RateCardType>R</b:RateCardType>
<InvoiceTemplateUid>1152921504606878909</InvoiceTemplateUid> <b:RateCardUid>1152921504606860819</b:RateCardUid>
</EmailInvoiceTemplateIdentity> </b:StandardRateCardIdentity>
<InvoiceEmailEnabledFlag>false</InvoiceEmailEnabledFlag> <b:TimeBillingType>H</b:TimeBillingType>
<InvoiceEmailType>P</InvoiceEmailType> <b:Timestamp>AAAAAA97Yvs=</b:Timestamp>
<Recipients> <b:UserDefinedFields>
<PwsInvoiceEmailRecipient> <b:PwsUserDefinedFieldDetail>
<RecipientType>T</RecipientType><b:UdfId i:nil="true"/>
<b:UdfName>CL-Date</b:UdfName>
<UserIdentity> <b:UdfUid>1152921504606856792</b:UdfUid>
<UserDisplayName>Jane Doe</UserDisplayName> <b:BooleanValue i:nil="true"/>
<UserId i:nil="true"/> <b:DataType>D</b:DataType>
<UserReferenceSystemId>E124</UserReferenceSystemId> <b:DateValue>2018-02-28T00:00:00Z</b:DateValue>
<b:IntegerValue i:nil="true"/>
<UserUid>1152921504607112368</UserUid> <b:ResourceIdentityValue i:nil="true"/>
</UserIdentity> <b:TextValue i:nil="true"/>
</PwsInvoiceEmailRecipient> </Recipients><b:UdfTreatment>A</b:UdfTreatment>
</InvoiceEmailSettings> <b:StoplightValues/>
<InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag> <b:NumericValue i:nil="true"/>
<RenderReceiptsFlag>false</RenderReceiptsFlag> <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag><b:RelationValue i:nil="true"/>
<InheritAutoApplyAvailableBalanceFlag>false<</InheritAutoApplyAvailableBalanceFlag>b:PwsUserDefinedFieldDetail>
<InheritTaxTypesFlag>false</InheritTaxTypesFlag> <b:PwsUserDefinedFieldDetail>
<TaxType1Identity> <b:UdfId i:nil="true"/>
<TaxTypeCode>VAT</TaxTypeCode> <b:UdfName>CL-Text</b:UdfName>
<TaxTypeId i:nil="true"/> <b:UdfUid>1152921504606856795</b:UdfUid>
<TaxTypeUid>1152921504606868258</TaxTypeUid> <b:BooleanValue i:nil="true"/>
</TaxType1Identity> <TaxType2Identity i:nil="true"/><b:DataType>T</b:DataType>
<TaxType3Identity<b:DateValue i:nil="true"/>
</ClientDetail> </Client><b:IntegerValue i:nil="true"/>
<ClientIdentity> <ClientId <b:ResourceIdentityValue i:nil="true"/>
<ClientNumber>C001001</ClientNumber> <b:TextValue>Child of Client C00124</b:TextValue>
<ClientUid>1152921504606989819</ClientUid> <b:UdfTreatment>A</b:UdfTreatment>
</ClientIdentity><b:StoplightValues/>
</PwsSaveClientResult><b:NumericValue i:nil="true"/>
</PwsSaveClientResponse> <b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
</b:UserDefinedFields>
<b:InheritInvoiceEmailSettingsFlag>true</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>E004</b:InvoiceTemplateName>
<b:InvoiceTemplateUid>1152921504606878909</b:InvoiceTemplateUid>
</b:EmailInvoiceTemplateIdentity>
<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
<b:InvoiceEmailType>W</b:InvoiceEmailType>
<b:Recipients>
<b:PwsInvoiceEmailRecipient>
<b:RecipientType>T</b:RecipientType>
<b:UserIdentity>
<b:UserDisplayName>John Doe</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607054221</b:UserUid>
</b:UserIdentity>
</b:PwsInvoiceEmailRecipient>
</b:Recipients>
</b:InvoiceEmailSettings>
<b:InheritRenderReceiptsFlag>true</b:InheritRenderReceiptsFlag>
<b:RenderReceiptsFlag>true</b:RenderReceiptsFlag>
<b:AutoApplyAvailableBalanceFlag>true</b:AutoApplyAvailableBalanceFlag>
<b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
<b:InheritTaxTypesFlag>true</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>
</a:Client>
<a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000127</b:ClientNumber>
<b:ClientUid>1152921504606998468</b:ClientUid>
</a:ClientIdentity>
</PwsSaveClientResult>
</PwsSaveClientResponse>
</s:Body>
</s:Envelope> |
PwsSaveClient - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|
| 105 | AtLeastOneItemNotFound | At least one requested item was not found. The remaining items, if any, were returned. |
| 11038 | NoClientsSpecified | No clients were specified for retrieval by this request. |
| 11040 | MaximumClientIdentitiesExceeded | Please specify between 1 and 100 client identities for retrieval. |
| 11042 | InappropriateStandardRateCardSpecified | The specified standard rate card is not appropriate (it is likely an RDC rate card). |
| 50045 | ViewPermissionDenied | You do not have permission to view this item. |
| 57631 | ClientNotSpecified | A specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number. |
| 57634 | UnexpectedErrorRetrievingClients | There was an unexpected error while trying to retrieve a client. |