CustomerService Web Service

CustomerService

Click here for a complete list of operations.

CustomerHistoryAccountDetailSearch

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /RoseComServicesTest/RoseCommServiceV3/APIV1/CustomerService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CustomerHistoryAccountDetailSearch"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CustomerHistoryAccountDetailSearch xmlns="http://tempuri.org/">
      <pSearchParams>
        <CustomerID>int</CustomerID>
        <IsCustomerBasicDataNeeded>boolean</IsCustomerBasicDataNeeded>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <EmployeeID>int</EmployeeID>
      </pSearchParams>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </CustomerHistoryAccountDetailSearch>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CustomerHistoryAccountDetailSearchResponse xmlns="http://tempuri.org/">
      <CustomerHistoryAccountDetailSearchResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Invoice>
            <InvoiceReference>string</InvoiceReference>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceSite xsi:nil="true" />
            <SaleOrder xsi:nil="true" />
            <Customer xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <ContactPerson>string</ContactPerson>
            <Note>string</Note>
            <GUID>string</GUID>
            <Currency xsi:nil="true" />
            <PaymentTerm xsi:nil="true" />
            <InvoiceAmount>decimal</InvoiceAmount>
            <InvoiceDiscount>decimal</InvoiceDiscount>
            <InvoiceTax>decimal</InvoiceTax>
            <InvoiceTotal>decimal</InvoiceTotal>
            <PaidAmount>decimal</PaidAmount>
            <CardProcessingFee>decimal</CardProcessingFee>
            <ShippingFee>decimal</ShippingFee>
            <InvoiceStatus xsi:nil="true" />
            <GPEffectiveDate>dateTime</GPEffectiveDate>
            <Despatch xsi:nil="true" />
            <Channel2 xsi:nil="true" />
            <Employee xsi:nil="true" />
            <IsNotConsiderForGP>boolean</IsNotConsiderForGP>
            <InvoicePostingStatus xsi:nil="true" />
            <PostingError>string</PostingError>
            <PostingDate>dateTime</PostingDate>
            <IsExportedToGFK>boolean</IsExportedToGFK>
            <ExportedDate>dateTime</ExportedDate>
            <IsCashBackRedemptionInvoice>boolean</IsCashBackRedemptionInvoice>
            <IsPrinted>boolean</IsPrinted>
            <ExchangeRate>decimal</ExchangeRate>
            <bMergedInvoice>boolean</bMergedInvoice>
            <DealerTaxRate>decimal</DealerTaxRate>
            <DealerTaxGroup xsi:nil="true" />
            <TotalinForiegnCurrency>decimal</TotalinForiegnCurrency>
            <InvoiceTaxinForiegnCurrency>decimal</InvoiceTaxinForiegnCurrency>
            <InvoiceAmountinForiegnCurrency>decimal</InvoiceAmountinForiegnCurrency>
            <InvoiceDiscountinForiegnCurrency>decimal</InvoiceDiscountinForiegnCurrency>
            <InvoiceRestockingFeeinForiegnCurrency>decimal</InvoiceRestockingFeeinForiegnCurrency>
            <IsImportedFromFulfilmentSale>boolean</IsImportedFromFulfilmentSale>
            <Company xsi:nil="true" />
            <Consignee>string</Consignee>
            <IsMergedInvoice>boolean</IsMergedInvoice>
            <FulFilOrderReference>string</FulFilOrderReference>
            <CompanyAddressForFormat4 xsi:nil="true" />
            <SiteAddressForFormat4 xsi:nil="true" />
            <IsPrintInvoicePaymentTerm>boolean</IsPrintInvoicePaymentTerm>
            <IsPrintTrackableDataOnInvoice>boolean</IsPrintTrackableDataOnInvoice>
            <DueDate>dateTime</DueDate>
            <InvoiceDetails xsi:nil="true" />
            <bCashBackRedemptionInvoice>boolean</bCashBackRedemptionInvoice>
            <bKitFund>boolean</bKitFund>
            <bCreateKitFundPaymentAllocation>boolean</bCreateKitFundPaymentAllocation>
          </Invoice>
          <Invoice>
            <InvoiceReference>string</InvoiceReference>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceSite xsi:nil="true" />
            <SaleOrder xsi:nil="true" />
            <Customer xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <ContactPerson>string</ContactPerson>
            <Note>string</Note>
            <GUID>string</GUID>
            <Currency xsi:nil="true" />
            <PaymentTerm xsi:nil="true" />
            <InvoiceAmount>decimal</InvoiceAmount>
            <InvoiceDiscount>decimal</InvoiceDiscount>
            <InvoiceTax>decimal</InvoiceTax>
            <InvoiceTotal>decimal</InvoiceTotal>
            <PaidAmount>decimal</PaidAmount>
            <CardProcessingFee>decimal</CardProcessingFee>
            <ShippingFee>decimal</ShippingFee>
            <InvoiceStatus xsi:nil="true" />
            <GPEffectiveDate>dateTime</GPEffectiveDate>
            <Despatch xsi:nil="true" />
            <Channel2 xsi:nil="true" />
            <Employee xsi:nil="true" />
            <IsNotConsiderForGP>boolean</IsNotConsiderForGP>
            <InvoicePostingStatus xsi:nil="true" />
            <PostingError>string</PostingError>
            <PostingDate>dateTime</PostingDate>
            <IsExportedToGFK>boolean</IsExportedToGFK>
            <ExportedDate>dateTime</ExportedDate>
            <IsCashBackRedemptionInvoice>boolean</IsCashBackRedemptionInvoice>
            <IsPrinted>boolean</IsPrinted>
            <ExchangeRate>decimal</ExchangeRate>
            <bMergedInvoice>boolean</bMergedInvoice>
            <DealerTaxRate>decimal</DealerTaxRate>
            <DealerTaxGroup xsi:nil="true" />
            <TotalinForiegnCurrency>decimal</TotalinForiegnCurrency>
            <InvoiceTaxinForiegnCurrency>decimal</InvoiceTaxinForiegnCurrency>
            <InvoiceAmountinForiegnCurrency>decimal</InvoiceAmountinForiegnCurrency>
            <InvoiceDiscountinForiegnCurrency>decimal</InvoiceDiscountinForiegnCurrency>
            <InvoiceRestockingFeeinForiegnCurrency>decimal</InvoiceRestockingFeeinForiegnCurrency>
            <IsImportedFromFulfilmentSale>boolean</IsImportedFromFulfilmentSale>
            <Company xsi:nil="true" />
            <Consignee>string</Consignee>
            <IsMergedInvoice>boolean</IsMergedInvoice>
            <FulFilOrderReference>string</FulFilOrderReference>
            <CompanyAddressForFormat4 xsi:nil="true" />
            <SiteAddressForFormat4 xsi:nil="true" />
            <IsPrintInvoicePaymentTerm>boolean</IsPrintInvoicePaymentTerm>
            <IsPrintTrackableDataOnInvoice>boolean</IsPrintTrackableDataOnInvoice>
            <DueDate>dateTime</DueDate>
            <InvoiceDetails xsi:nil="true" />
            <bCashBackRedemptionInvoice>boolean</bCashBackRedemptionInvoice>
            <bKitFund>boolean</bKitFund>
            <bCreateKitFundPaymentAllocation>boolean</bCreateKitFundPaymentAllocation>
          </Invoice>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </CustomerHistoryAccountDetailSearchResult>
    </CustomerHistoryAccountDetailSearchResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /RoseComServicesTest/RoseCommServiceV3/APIV1/CustomerService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CustomerHistoryAccountDetailSearch xmlns="http://tempuri.org/">
      <pSearchParams>
        <CustomerID>int</CustomerID>
        <IsCustomerBasicDataNeeded>boolean</IsCustomerBasicDataNeeded>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <EmployeeID>int</EmployeeID>
      </pSearchParams>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </CustomerHistoryAccountDetailSearch>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CustomerHistoryAccountDetailSearchResponse xmlns="http://tempuri.org/">
      <CustomerHistoryAccountDetailSearchResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Invoice>
            <InvoiceReference>string</InvoiceReference>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceSite xsi:nil="true" />
            <SaleOrder xsi:nil="true" />
            <Customer xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <ContactPerson>string</ContactPerson>
            <Note>string</Note>
            <GUID>string</GUID>
            <Currency xsi:nil="true" />
            <PaymentTerm xsi:nil="true" />
            <InvoiceAmount>decimal</InvoiceAmount>
            <InvoiceDiscount>decimal</InvoiceDiscount>
            <InvoiceTax>decimal</InvoiceTax>
            <InvoiceTotal>decimal</InvoiceTotal>
            <PaidAmount>decimal</PaidAmount>
            <CardProcessingFee>decimal</CardProcessingFee>
            <ShippingFee>decimal</ShippingFee>
            <InvoiceStatus xsi:nil="true" />
            <GPEffectiveDate>dateTime</GPEffectiveDate>
            <Despatch xsi:nil="true" />
            <Channel2 xsi:nil="true" />
            <Employee xsi:nil="true" />
            <IsNotConsiderForGP>boolean</IsNotConsiderForGP>
            <InvoicePostingStatus xsi:nil="true" />
            <PostingError>string</PostingError>
            <PostingDate>dateTime</PostingDate>
            <IsExportedToGFK>boolean</IsExportedToGFK>
            <ExportedDate>dateTime</ExportedDate>
            <IsCashBackRedemptionInvoice>boolean</IsCashBackRedemptionInvoice>
            <IsPrinted>boolean</IsPrinted>
            <ExchangeRate>decimal</ExchangeRate>
            <bMergedInvoice>boolean</bMergedInvoice>
            <DealerTaxRate>decimal</DealerTaxRate>
            <DealerTaxGroup xsi:nil="true" />
            <TotalinForiegnCurrency>decimal</TotalinForiegnCurrency>
            <InvoiceTaxinForiegnCurrency>decimal</InvoiceTaxinForiegnCurrency>
            <InvoiceAmountinForiegnCurrency>decimal</InvoiceAmountinForiegnCurrency>
            <InvoiceDiscountinForiegnCurrency>decimal</InvoiceDiscountinForiegnCurrency>
            <InvoiceRestockingFeeinForiegnCurrency>decimal</InvoiceRestockingFeeinForiegnCurrency>
            <IsImportedFromFulfilmentSale>boolean</IsImportedFromFulfilmentSale>
            <Company xsi:nil="true" />
            <Consignee>string</Consignee>
            <IsMergedInvoice>boolean</IsMergedInvoice>
            <FulFilOrderReference>string</FulFilOrderReference>
            <CompanyAddressForFormat4 xsi:nil="true" />
            <SiteAddressForFormat4 xsi:nil="true" />
            <IsPrintInvoicePaymentTerm>boolean</IsPrintInvoicePaymentTerm>
            <IsPrintTrackableDataOnInvoice>boolean</IsPrintTrackableDataOnInvoice>
            <DueDate>dateTime</DueDate>
            <InvoiceDetails xsi:nil="true" />
            <bCashBackRedemptionInvoice>boolean</bCashBackRedemptionInvoice>
            <bKitFund>boolean</bKitFund>
            <bCreateKitFundPaymentAllocation>boolean</bCreateKitFundPaymentAllocation>
          </Invoice>
          <Invoice>
            <InvoiceReference>string</InvoiceReference>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceSite xsi:nil="true" />
            <SaleOrder xsi:nil="true" />
            <Customer xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <ContactPerson>string</ContactPerson>
            <Note>string</Note>
            <GUID>string</GUID>
            <Currency xsi:nil="true" />
            <PaymentTerm xsi:nil="true" />
            <InvoiceAmount>decimal</InvoiceAmount>
            <InvoiceDiscount>decimal</InvoiceDiscount>
            <InvoiceTax>decimal</InvoiceTax>
            <InvoiceTotal>decimal</InvoiceTotal>
            <PaidAmount>decimal</PaidAmount>
            <CardProcessingFee>decimal</CardProcessingFee>
            <ShippingFee>decimal</ShippingFee>
            <InvoiceStatus xsi:nil="true" />
            <GPEffectiveDate>dateTime</GPEffectiveDate>
            <Despatch xsi:nil="true" />
            <Channel2 xsi:nil="true" />
            <Employee xsi:nil="true" />
            <IsNotConsiderForGP>boolean</IsNotConsiderForGP>
            <InvoicePostingStatus xsi:nil="true" />
            <PostingError>string</PostingError>
            <PostingDate>dateTime</PostingDate>
            <IsExportedToGFK>boolean</IsExportedToGFK>
            <ExportedDate>dateTime</ExportedDate>
            <IsCashBackRedemptionInvoice>boolean</IsCashBackRedemptionInvoice>
            <IsPrinted>boolean</IsPrinted>
            <ExchangeRate>decimal</ExchangeRate>
            <bMergedInvoice>boolean</bMergedInvoice>
            <DealerTaxRate>decimal</DealerTaxRate>
            <DealerTaxGroup xsi:nil="true" />
            <TotalinForiegnCurrency>decimal</TotalinForiegnCurrency>
            <InvoiceTaxinForiegnCurrency>decimal</InvoiceTaxinForiegnCurrency>
            <InvoiceAmountinForiegnCurrency>decimal</InvoiceAmountinForiegnCurrency>
            <InvoiceDiscountinForiegnCurrency>decimal</InvoiceDiscountinForiegnCurrency>
            <InvoiceRestockingFeeinForiegnCurrency>decimal</InvoiceRestockingFeeinForiegnCurrency>
            <IsImportedFromFulfilmentSale>boolean</IsImportedFromFulfilmentSale>
            <Company xsi:nil="true" />
            <Consignee>string</Consignee>
            <IsMergedInvoice>boolean</IsMergedInvoice>
            <FulFilOrderReference>string</FulFilOrderReference>
            <CompanyAddressForFormat4 xsi:nil="true" />
            <SiteAddressForFormat4 xsi:nil="true" />
            <IsPrintInvoicePaymentTerm>boolean</IsPrintInvoicePaymentTerm>
            <IsPrintTrackableDataOnInvoice>boolean</IsPrintTrackableDataOnInvoice>
            <DueDate>dateTime</DueDate>
            <InvoiceDetails xsi:nil="true" />
            <bCashBackRedemptionInvoice>boolean</bCashBackRedemptionInvoice>
            <bKitFund>boolean</bKitFund>
            <bCreateKitFundPaymentAllocation>boolean</bCreateKitFundPaymentAllocation>
          </Invoice>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </CustomerHistoryAccountDetailSearchResult>
    </CustomerHistoryAccountDetailSearchResponse>
  </soap12:Body>
</soap12:Envelope>