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 46
Next »
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.
Request Elements
| Element | Data Type | Required? | Default | Description | Sample Data |
|---|
| RequestId | Int32 | No |
| Click here for more information. | 1 |
| SessionTicket | String (50) | Yes |
| Click here for more information. | AcjOqKSXoUYG3qLkrxKQYw== |
| Client Detail | PwsClientDetail | Yes |
| The detailed client information to be inserted or updated |
|
| FullDetailFlag | Boolean | No | false | If set to true, include full detailed client element in response | true/false |
| ParentClientClearFlag | Boolean | No | false | If set to true, null out parent client | true/false |
Request Usage Example(s)
<PwsSaveClient>
<serviceRequest>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
<Client>
<ClientName>Acme 1000-01</ClientName>
<InactiveFlag>false</InactiveFlag>
<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>
<BillingCycleName>Monthly</BillingCycleName>
</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>
<InvoiceTemplateName>A200</InvoiceTemplateName>
</InvoiceTemplateIdentity>
<NewClientNumber>C001001</NewClientNumber>
<PaymentTermIdentity>
<PaymentTermName>Net 60</PaymentTermName>
</PaymentTermIdentity>
<PurchaseOrderNumber>C001000</PurchaseOrderNumber>
<StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent>
<StandardContractDiscountPercent>0</StandardContractDiscountPercent>
<StandardRateCardIdentity>
<RateCardName>USA Rate Card</RateCardName>
<RateCardType>R</RateCardType>
</StandardRateCardIdentity>
<TimeBillingType>H</TimeBillingType>
<UserDefinedFields>
<PwsUserDefinedFieldDetail>
<UdfName>Account Owner</UdfName>
<DataType>R</DataType>
<ResourceIdentityValue>
<ResourceDisplayName>Jack Spratt</ResourceDisplayName>
<ResourceReferenceSystemId>E123</ResourceReferenceSystemId>
</ResourceIdentityValue>
<UdfTreatment>A</UdfTreatment>
</PwsUserDefinedFieldDetail>
</UserDefinedFields>
<InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>
<InvoiceEmailSettings>
<EmailFromUserIdentity>
<UserDisplayName>Bettina Borces</UserDisplayName>
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
</EmailFromUserIdentity>
<EmailInvoiceTemplateIdentity>
<InvoiceTemplateName>E004</InvoiceTemplateName>
</EmailInvoiceTemplateIdentity>
<InvoiceEmailEnabledFlag>false</InvoiceEmailEnabledFlag>
<InvoiceEmailType>P</InvoiceEmailType>
<Recipients>
<PwsInvoiceEmailRecipient>
<RecipientType>T</RecipientType>
<UserIdentity>
<UserDisplayName>Jane Doe</UserDisplayName>
<UserReferenceSystemId>E124</UserReferenceSystemId>
</UserIdentity>
</PwsInvoiceEmailRecipient>
</Recipients>
</InvoiceEmailSettings>
<InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag>
<RenderReceiptsFlag>false</RenderReceiptsFlag>
<AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag>
<InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag>
<InheritTaxTypesFlag>false</InheritTaxTypesFlag>
<TaxType1Identity>
<TaxTypeCode>VAT</TaxTypeCode>
</TaxType1Identity>
</Client>
<FullDetailFlag>true</FullDetailFlag>
<ParentClientClearFlag>false</ParentClientClearFlag>
</serviceRequest>
</PwsSaveClient>
Response Elements
| Element | Data Type | Description | Sample Data |
|---|
| Messages | PwsMessage | Click here for more information |
|
| ResponseId | Int32 | Click here for more information | 0 |
| Status | String | Click here for more information | Ok |
| ServerTimestampUtc | DateTime | Click here for more information | 2017-12-27T16:48:52.6790058Z |
| ClientDetail | PwsClientDetail [1] | The complete set of information about a client (less any subordinate entities) |
|
| ClientIdentity | PwsClientRef [1] | The unique keys used to identify a client |
|
Response Usage Example(s)
<PwsSaveClientResponse>
<PwsSaveClientResult>
<Messages i:nil="true"/
<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>
PwsSaveClient - Common 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. |
| 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. |