...
| 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>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<req:Client>
<com:ClientName>Web Services Inc.</com:ClientName>
<com:InactiveFlag>false</com:InactiveFlag>
<com:Address>
<com:AddressLine1>123 Main Street</com:AddressLine1>
<com:AddressLine2>Suite 100</com:AddressLine2>
<com:Attention>Billing</com:Attention>
<com:City>Boston</com:City>
<com:CompanyName>Acme Inc.</com:CompanyName>
<com:Country>USA</com:Country>
<com:StateOrProvince>MA</com:StateOrProvince>
<com:ZipOrPostalCode>02114</com:ZipOrPostalCode>
</com:Address>
<com:BillingCycleIdentity>
<com:BillingCycleName>Monthly</com:BillingCycleName>
</com:BillingCycleIdentity>
<com:BillingInstructions>Please bill on the last day of the month.</com:BillingInstructions>
<com:ClientMessage>We appreciate your business.</com:ClientMessage>
<com:ClientMessagePlain>We appreciate your business.</com:ClientMessagePlain>
<com:InheritAddressFlag>false</com:InheritAddressFlag>
<com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
<com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
<com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
<com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
<com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
<com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
<com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
<com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
<com:InheritStandardRatesFlag>false</com:InheritStandardRatesFlag>
<com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
<com:InvoiceContent>B</com:InvoiceContent>
<com:InvoiceScope>E</com:InvoiceScope>
<com:InvoiceTemplateIdentity>
<com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
</com:InvoiceTemplateIdentity>
<com:PaymentTermIdentity>
<com:PaymentTermName>Net 60</com:PaymentTermName>
</com:PaymentTermIdentity>
<com:PurchaseOrderNumber>WS-001</com:PurchaseOrderNumber>
<com:StandardBillingAdjustedDiscountPercent>15</com:StandardBillingAdjustedDiscountPercent>
<com:StandardContractDiscountPercent>10</com:StandardContractDiscountPercent>
<com:StandardRateCardIdentity>
<com:RateCardName>USA Rate Card</com:RateCardName>
<com:RateCardType>R</com:RateCardType>
</com:StandardRateCardIdentity>
<com:TimeBillingType>H</com:TimeBillingType>
<com:UserDefinedFields>
<com:PwsUserDefinedFieldDetail>
<com:UdfName>CL-Text</com:UdfName>
<com:TextValue>Created on January 18th, 2018</com:TextValue>
<com:UdfTreatment>A</com:UdfTreatment>
</com:PwsUserDefinedFieldDetail>
</com:UserDefinedFields>
<com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
<com:InvoiceEmailSettings>
<com:EmailFromUserIdentity>
<com:UserDisplayName>Bettina Borces</com:UserDisplayName>
<com:UserReferenceSystemId>Partner - 01</com:UserReferenceSystemId>
</com:EmailFromUserIdentity>
<com:EmailInvoiceTemplateIdentity>
<com:InvoiceTemplateName>E004</com:InvoiceTemplateName>
</com:EmailInvoiceTemplateIdentity>
<com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
<com:InvoiceEmailType>W</com:InvoiceEmailType>
<com:Recipients>
<com:PwsInvoiceEmailRecipient>
<com:RecipientType>T</com:RecipientType>
<com:UserIdentity>
<com:UserDisplayName>John Doe</com:UserDisplayName>
<com:UserReferenceSystemId>E123</com:UserReferenceSystemId>
</com:UserIdentity>
</com:PwsInvoiceEmailRecipient>
</com:Recipients>
</com:InvoiceEmailSettings>
<com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
<com:RenderReceiptsFlag>true</com:RenderReceiptsFlag>
<com:AutoApplyAvailableBalanceFlag>true</com:AutoApplyAvailableBalanceFlag>
<com:InheritAutoApplyAvailableBalanceFlag>false</com:InheritAutoApplyAvailableBalanceFlag>
<com:InheritTaxTypesFlag>false</com:InheritTaxTypesFlag>
<com:TaxType1Identity>
<com:TaxTypeCode>VAT</com:TaxTypeCode>
</com:TaxType1Identity>
</req:Client>
<req:FullDetailFlag>true</req:FullDetailFlag>
<req:ParentClientClearFlag>false</req:ParentClientClearFlag>
</pws:serviceRequest>
</pws:PwsSaveClient>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
- This response also includes the Common Output Elements
Response Elements
...
2017-12-27T16:48:52.6790058Z
...
Response Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 |
|---|
| collapse | true |
|---|
|
<PwsSaveClientResponse>| 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>
<pws:serviceRequest>
<req:RequestId>2</req:RequestId>
<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<req:Client>
<com:ClientName>Web Services Inc. - extended</com:ClientName>
<com:InactiveFlag>false</com:InactiveFlag>
<com:ParentClientIdentity>
<com:ClientNumber>C000124</com:ClientNumber>
</com:ParentClientIdentity>
<com:InheritAddressFlag>true</com:InheritAddressFlag>
<com:InheritBillingCycleFlag>true</com:InheritBillingCycleFlag>
<com:InheritBillingInstructionsFlag>true</com:InheritBillingInstructionsFlag>
<com:InheritClientMessageFlag>true</com:InheritClientMessageFlag>
<com:InheritInvoiceContentFlag>true</com:InheritInvoiceContentFlag>
<com:InheritInvoiceScopeFlag>true</com:InheritInvoiceScopeFlag>
<com:InheritInvoiceTemplateFlag>true</com:InheritInvoiceTemplateFlag>
<com:InheritPaymentTermFlag>true</com:InheritPaymentTermFlag>
<com:InheritPurchaseOrderNumberFlag>true</com:InheritPurchaseOrderNumberFlag>
<com:InheritStandardRatesFlag>true</com:InheritStandardRatesFlag>
<com:InheritTimeBillingTypeFlag>true</com:InheritTimeBillingTypeFlag>
<com:UserDefinedFields>
<com:PwsUserDefinedFieldDetail>
<com:UdfName>CL-Date</com:UdfName>
<com:DateValue>2018-02-28T00:00:00Z</com:DateValue>
</com:PwsUserDefinedFieldDetail>
<com:PwsUserDefinedFieldDetail>
<com:UdfName>CL-Text</com:UdfName>
<com:TextValue>Child of Client C00124</com:TextValue>
</com:PwsUserDefinedFieldDetail>
</com:UserDefinedFields>
<com:InheritInvoiceEmailSettingsFlag>true</com:InheritInvoiceEmailSettingsFlag>
<com:InheritRenderReceiptsFlag>true</com:InheritRenderReceiptsFlag>
<com:InheritAutoApplyAvailableBalanceFlag>true</com:InheritAutoApplyAvailableBalanceFlag>
<com:InheritTaxTypesFlag>true</com:InheritTaxTypesFlag>
</req:Client>
<req:FullDetailFlag>true</req:FullDetailFlag>
<req:ParentClientClearFlag>false</req:ParentClientClearFlag>
</pws:serviceRequest>
</pws:PwsSaveClient>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
- This response also includes the Common Output Elements
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)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 |
|---|
| collapse | true |
|---|
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveClientResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">2</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T20:27:35.3803633Z</ServerTimestampUtc>
<a:Client xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ClientDetail>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000126</b:ClientNumber>
<b:ClientUid>1152921504606998467</b:ClientUid>
<b:ClientName>Web Services Inc. - extended</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000124</b:ClientNumber>
<b:ClientUid>1152921504606998465</b:ClientUid>
</b:ParentClientIdentity>
<b:Address>
<b:AddressLine1>123 Main Street</b:AddressLine1>
<b:AddressLine2>Suite 100</b:AddressLine2>
<b:Attention>Billing</b:Attention>
<b:City>Boston</b:City>
<b:CompanyName>Acme Inc.</b:CompanyName>
<PwsSaveClientResult> <b:Country>USA</b:Country>
<Messages i:nil="true"/> <ResponseId>0</ResponseId><b:StateOrProvince>MA</b:StateOrProvince>
<Status>Ok</Status> <ServerTimestampUtc>2017-12-27T16:48:52.6790058Z</ServerTimestampUtc><b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
<Client> </b:Address>
<ClientDetail> <b:BillingCycleIdentity>
<ClientId i:nil="true"/> <b:BillingCycleId i:nil="true"/>
<ClientNumber>C001001</ClientNumber> <b:BillingCycleName>Monthly</b:BillingCycleName>
<ClientUid>1152921504606989819</ClientUid> <ClientName>Acme 1000-01</ClientName> <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
<InactiveFlag>false<</InactiveFlag>b:BillingCycleIdentity>
<ParentClientIdentity i:nil="true"/>
<b:BillingInstructions>Please bill on the last day of the month.</b:BillingInstructions>
<Address> <b:ClientMessage>We appreciate <AddressLine1>123 Main Street</AddressLine1>
your business.</b:ClientMessage>
<b:ClientMessagePlain>We appreciate <AddressLine2>Suiteyour 100</AddressLine2>business.</b:ClientMessagePlain>
<Attention>Jane Smith</Attention><b:InheritAddressFlag>true</b:InheritAddressFlag>
<City>Boston</City><b:InheritBillingCycleFlag>true</b:InheritBillingCycleFlag>
<CompanyName>Acme 1000-01</CompanyName><b:InheritBillingInstructionsFlag>true</b:InheritBillingInstructionsFlag>
<Country>USA</Country><b:InheritClientMessageFlag>true</b:InheritClientMessageFlag>
<StateOrProvince>MA</StateOrProvince><b:InheritInvoiceContentFlag>true</b:InheritInvoiceContentFlag>
<ZipOrPostalCode>02114</ZipOrPostalCode><b:InheritInvoiceScopeFlag>true</b:InheritInvoiceScopeFlag>
</Address><b:InheritInvoiceTemplateFlag>true</b:InheritInvoiceTemplateFlag>
<BillingCycleIdentity><b:InheritPaymentTermFlag>true</b:InheritPaymentTermFlag>
<BillingCycleId i:nil="true"/><b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
<BillingCycleName>Monthly</BillingCycleName><b:InheritStandardRatesFlag>true</b:InheritStandardRatesFlag>
<BillingCycleUid>1152921504606853180</BillingCycleUid><b:InheritTimeBillingTypeFlag>true</b:InheritTimeBillingTypeFlag>
</BillingCycleIdentity><b:InvoiceContent>B</b:InvoiceContent>
<BillingInstructions>Bill on the last day of the month</BillingInstructions>
<b:InvoiceScope>E</b:InvoiceScope>
<ClientMessage>We appreciate<b:InvoiceTemplateIdentity>
your business!</ClientMessage> <ClientMessagePlain>We appreciate your business!</ClientMessagePlain><b:InvoiceTemplateId i:nil="true"/>
<InheritAddressFlag>false</InheritAddressFlag> <b:InvoiceTemplateName>A200</b:InvoiceTemplateName>
<InheritBillingCycleFlag>false</InheritBillingCycleFlag> <b:InvoiceTemplateUid>1152921504606878904</b:InvoiceTemplateUid>
<InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag> </b:InvoiceTemplateIdentity>
<InheritClientMessageFlag>false</InheritClientMessageFlag> <b:NewClientNumber i:nil="true"/>
<InheritInvoiceContentFlag>false</InheritInvoiceContentFlag> <b:PaymentTermIdentity>
<InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag> <b:PaymentTermId i:nil="true"/>
<InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag> <b:PaymentTermName>Net 60</b:PaymentTermName>
<InheritPaymentTermFlag>false</InheritPaymentTermFlag> <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag><b:PaymentTermUid>1152921504606856055</b:PaymentTermUid>
<InheritStandardRatesFlag>false<</InheritStandardRatesFlag>b:PaymentTermIdentity>
<InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag><b:PurchaseOrderNumber>WS-001</b:PurchaseOrderNumber>
<InvoiceContent>B</InvoiceContent><b:StandardBillingAdjustedDiscountPercent>15</b:StandardBillingAdjustedDiscountPercent>
<InvoiceScope>E</InvoiceScope><b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent>
<InvoiceTemplateIdentity><b:StandardRateCardIdentity>
<InvoiceTemplateId<b:RateCardId i:nil="true"/>
>
<InvoiceTemplateName>A200</InvoiceTemplateName> <b:RateCardName>USA Rate Card</b:RateCardName>
<InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid> <b:RateCardType>R</b:RateCardType>
</InvoiceTemplateIdentity> <NewClientNumber i:nil="true"/><b:RateCardUid>1152921504606860819</b:RateCardUid>
<PaymentTermIdentity></b:StandardRateCardIdentity>
<PaymentTermId i:nil="true"/><b:TimeBillingType>H</b:TimeBillingType>
<b:Timestamp>AAAAAA97YIg=</b:Timestamp>
<PaymentTermName>Net 60</PaymentTermName> <b:UserDefinedFields>
<PaymentTermUid>1152921504606856055</PaymentTermUid> <b:PwsUserDefinedFieldDetail>
</PaymentTermIdentity> <PurchaseOrderNumber>C001000</PurchaseOrderNumber> <b:UdfId i:nil="true"/>
<StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent> <b:UdfName>CL-Date</b:UdfName>
<StandardContractDiscountPercent>0</StandardContractDiscountPercent> <b:UdfUid>1152921504606856792</b:UdfUid>
<StandardRateCardIdentity> <RateCardId<b:BooleanValue i:nil="true"/>
<RateCardName>USA Rate Card</RateCardName><b:DataType>D</b:DataType>
<RateCardType>R</RateCardType> <b:DateValue>2018-02-28T00:00:00Z</b:DateValue>
<RateCardUid>1152921504606860819</RateCardUid> </StandardRateCardIdentity><b:IntegerValue i:nil="true"/>
<TimeBillingType>H</TimeBillingType> <b:ResourceIdentityValue i:nil="true"/>
<Timestamp>AAAAAA61TDI=</Timestamp> <b:TextValue i:nil="true"/>
<UserDefinedFields> <PwsUserDefinedFieldDetail><b:UdfTreatment>A</b:UdfTreatment>
<UdfId i:nil="true"<b:StoplightValues/>
<UdfName>Account Owner</UdfName>
<b:NumericValue i:nil="true"/>
<UdfUid>1152921504606856794</UdfUid> <b:RelationValue i:nil="true"/>
<BooleanValue i:nil="true"/></b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<DataType>R</DataType> <DateValue <b:UdfId i:nil="true"/>
<IntegerValue i:nil="true"/><b:UdfName>CL-Text</b:UdfName>
<ResourceIdentityValue><b:UdfUid>1152921504606856795</b:UdfUid>
<ResourceDisplayName>Jack Spratt</ResourceDisplayName>
<b:BooleanValue i:nil="true"/>
<ResourceId i:nil="true"/><b:DataType>T</b:DataType>
<b:DateValue i:nil="true"/>
<ResourceReferenceSystemId>E123</ResourceReferenceSystemId> <b:IntegerValue i:nil="true"/>
<ResourceUid>1152921504607111573</ResourceUid> <b:ResourceIdentityValue i:nil="true"/>
</ResourceIdentityValue> <b:TextValue>Child of <TextValueClient i:nil="true"/>C00124</b:TextValue>
<UdfTreatment>A<<b:UdfTreatment>A</b:UdfTreatment>
<StoplightValues<b:StoplightValues/>
<NumericValue<b:NumericValue i:nil="true"/>
<RelationValue<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
</b:UserDefinedFields>
<InheritInvoiceEmailSettingsFlag>false<<b:InheritInvoiceEmailSettingsFlag>true</b:InheritInvoiceEmailSettingsFlag>
<InvoiceEmailSettings><b:InvoiceEmailSettings>
<EmailFromUserIdentity><b:EmailFromUserIdentity>
<UserDisplayName>Bettina<b:UserDisplayName>Bettina Borces</b:UserDisplayName>
<UserId<b:UserId i:nil="true"/>
<UserReferenceSystemId>Partner<b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
<UserUid>1152921504607011056<<b:UserUid>1152921504607011056</b:UserUid>
</b:EmailFromUserIdentity>
<EmailInvoiceTemplateIdentity><b:EmailInvoiceTemplateIdentity>
<InvoiceTemplateId<b:InvoiceTemplateId i:nil="true"/>
<InvoiceTemplateName>E004<<b:InvoiceTemplateName>E004</b:InvoiceTemplateName>
<InvoiceTemplateUid>1152921504606878909<<b:InvoiceTemplateUid>1152921504606878909</b:InvoiceTemplateUid>
</b:EmailInvoiceTemplateIdentity>
<InvoiceEmailEnabledFlag>false<<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
<InvoiceEmailType>P</<b:InvoiceEmailType>W</b:InvoiceEmailType>
<Recipients><b:Recipients>
<PwsInvoiceEmailRecipient><b:PwsInvoiceEmailRecipient>
<RecipientType>T<<b:RecipientType>T</b:RecipientType>
<UserIdentity><b:UserIdentity>
<UserDisplayName>Jane<b:UserDisplayName>John Doe</b:UserDisplayName>
<UserId<b:UserId i:nil="true"/>
<UserReferenceSystemId>E124<<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<UserUid>1152921504607112368<<b:UserUid>1152921504607054221</b:UserUid>
</b:UserIdentity>
</b:PwsInvoiceEmailRecipient>
</b:Recipients>
</b:InvoiceEmailSettings>
<InheritRenderReceiptsFlag>false<<b:InheritRenderReceiptsFlag>true</b:InheritRenderReceiptsFlag>
<RenderReceiptsFlag>false<<b:RenderReceiptsFlag>true</b:RenderReceiptsFlag>
<AutoApplyAvailableBalanceFlag>false<<b:AutoApplyAvailableBalanceFlag>true</b:AutoApplyAvailableBalanceFlag>
<InheritAutoApplyAvailableBalanceFlag>false<<b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
<InheritTaxTypesFlag>false<<b:InheritTaxTypesFlag>true</b:InheritTaxTypesFlag>
<TaxType1Identity><b:TaxType1Identity>
<TaxTypeCode>VAT<<b:TaxTypeCode>VAT</b:TaxTypeCode>
<TaxTypeId<b:TaxTypeId i:nil="true"/>
<TaxTypeUid>1152921504606868258<<b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
</b:TaxType1Identity>
<TaxType2Identity<b:TaxType2Identity i:nil="true"/>
<TaxType3Identity<b:TaxType3Identity i:nil="true"/>
</b:ClientDetail>
</a:Client>
<ClientIdentity><a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<ClientId<b:ClientId i:nil="true"/>
<ClientNumber>C001001<<b:ClientNumber>C000126</b:ClientNumber>
<ClientUid>1152921504606989819<<b:ClientUid>1152921504606998467</b:ClientUid>
</a:ClientIdentity>
</PwsSaveClientResult>
</PwsSaveClientResponse>
</s:Body>
</s:Envelope> |
PwsSaveClient - Common Errors and Warnings
...