wagefiler Web Service

wagefiler

Click here for a complete list of operations.

GetEstimatedInvoiceDetail

The GetEstimatedInvoiceDetail API retrieves an estimated price and invoice line items used to calculate that price based on batch information and form counts.

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 /WageFilerWS/WageFiler.asmx HTTP/1.1
Host: www.wagefiler.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://localhost/WageFiler/WageFiler/GetEstimatedInvoiceDetail"

<?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>
    <GetEstimatedInvoiceDetail xmlns="http://localhost/WageFiler/WageFiler/">
      <request>
        <UserID>string</UserID>
        <Password>string</Password>
        <PricingInfoForBatches>
          <BatchPricingInfo>
            <FormType>int</FormType>
            <PayersInGWXmlBatch>int</PayersInGWXmlBatch>
            <ShippingMethod>int</ShippingMethod>
            <FormTitleCounts xsi:nil="true" />
            <ForeignAddressCount>int</ForeignAddressCount>
            <Services xsi:nil="true" />
            <BundledServices xsi:nil="true" />
            <PrepaidCodes xsi:nil="true" />
            <IsPriorYear>boolean</IsPriorYear>
          </BatchPricingInfo>
          <BatchPricingInfo>
            <FormType>int</FormType>
            <PayersInGWXmlBatch>int</PayersInGWXmlBatch>
            <ShippingMethod>int</ShippingMethod>
            <FormTitleCounts xsi:nil="true" />
            <ForeignAddressCount>int</ForeignAddressCount>
            <Services xsi:nil="true" />
            <BundledServices xsi:nil="true" />
            <PrepaidCodes xsi:nil="true" />
            <IsPriorYear>boolean</IsPriorYear>
          </BatchPricingInfo>
        </PricingInfoForBatches>
        <PromoCode>string</PromoCode>
        <CustomerID>string</CustomerID>
        <ExcludeSalesTax>boolean</ExcludeSalesTax>
      </request>
    </GetEstimatedInvoiceDetail>
  </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>
    <GetEstimatedInvoiceDetailResponse xmlns="http://localhost/WageFiler/WageFiler/">
      <GetEstimatedInvoiceDetailResult>
        <ErrorCode>int</ErrorCode>
        <TotalCost>string</TotalCost>
        <InvoiceDetailForBatches>
          <BatchInvoiceDetail>
            <BatchOID>string</BatchOID>
            <Cost>string</Cost>
            <InvServices xsi:nil="true" />
          </BatchInvoiceDetail>
          <BatchInvoiceDetail>
            <BatchOID>string</BatchOID>
            <Cost>string</Cost>
            <InvServices xsi:nil="true" />
          </BatchInvoiceDetail>
        </InvoiceDetailForBatches>
        <PrepaidCodeUsage>
          <PrepaidUsage>
            <Code>string</Code>
            <Used>decimal</Used>
            <Remaining>decimal</Remaining>
            <Unlimited>boolean</Unlimited>
          </PrepaidUsage>
          <PrepaidUsage>
            <Code>string</Code>
            <Used>decimal</Used>
            <Remaining>decimal</Remaining>
            <Unlimited>boolean</Unlimited>
          </PrepaidUsage>
        </PrepaidCodeUsage>
        <PromoCodeUsage>decimal</PromoCodeUsage>
      </GetEstimatedInvoiceDetailResult>
    </GetEstimatedInvoiceDetailResponse>
  </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 /WageFilerWS/WageFiler.asmx HTTP/1.1
Host: www.wagefiler.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>
    <GetEstimatedInvoiceDetail xmlns="http://localhost/WageFiler/WageFiler/">
      <request>
        <UserID>string</UserID>
        <Password>string</Password>
        <PricingInfoForBatches>
          <BatchPricingInfo>
            <FormType>int</FormType>
            <PayersInGWXmlBatch>int</PayersInGWXmlBatch>
            <ShippingMethod>int</ShippingMethod>
            <FormTitleCounts xsi:nil="true" />
            <ForeignAddressCount>int</ForeignAddressCount>
            <Services xsi:nil="true" />
            <BundledServices xsi:nil="true" />
            <PrepaidCodes xsi:nil="true" />
            <IsPriorYear>boolean</IsPriorYear>
          </BatchPricingInfo>
          <BatchPricingInfo>
            <FormType>int</FormType>
            <PayersInGWXmlBatch>int</PayersInGWXmlBatch>
            <ShippingMethod>int</ShippingMethod>
            <FormTitleCounts xsi:nil="true" />
            <ForeignAddressCount>int</ForeignAddressCount>
            <Services xsi:nil="true" />
            <BundledServices xsi:nil="true" />
            <PrepaidCodes xsi:nil="true" />
            <IsPriorYear>boolean</IsPriorYear>
          </BatchPricingInfo>
        </PricingInfoForBatches>
        <PromoCode>string</PromoCode>
        <CustomerID>string</CustomerID>
        <ExcludeSalesTax>boolean</ExcludeSalesTax>
      </request>
    </GetEstimatedInvoiceDetail>
  </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>
    <GetEstimatedInvoiceDetailResponse xmlns="http://localhost/WageFiler/WageFiler/">
      <GetEstimatedInvoiceDetailResult>
        <ErrorCode>int</ErrorCode>
        <TotalCost>string</TotalCost>
        <InvoiceDetailForBatches>
          <BatchInvoiceDetail>
            <BatchOID>string</BatchOID>
            <Cost>string</Cost>
            <InvServices xsi:nil="true" />
          </BatchInvoiceDetail>
          <BatchInvoiceDetail>
            <BatchOID>string</BatchOID>
            <Cost>string</Cost>
            <InvServices xsi:nil="true" />
          </BatchInvoiceDetail>
        </InvoiceDetailForBatches>
        <PrepaidCodeUsage>
          <PrepaidUsage>
            <Code>string</Code>
            <Used>decimal</Used>
            <Remaining>decimal</Remaining>
            <Unlimited>boolean</Unlimited>
          </PrepaidUsage>
          <PrepaidUsage>
            <Code>string</Code>
            <Used>decimal</Used>
            <Remaining>decimal</Remaining>
            <Unlimited>boolean</Unlimited>
          </PrepaidUsage>
        </PrepaidCodeUsage>
        <PromoCodeUsage>decimal</PromoCodeUsage>
      </GetEstimatedInvoiceDetailResult>
    </GetEstimatedInvoiceDetailResponse>
  </soap12:Body>
</soap12:Envelope>