GetInvoicesByQuery

Ongoing WMS has an invoicing module which the warehouse can use to create invoices for its customers. This function can be used to retrieve those invoices. The intended use-case is for an accounting package to be able to integrate with Ongoing WMS, so that the invoices can be easily transferred automatically from Ongoing WMS to the accounting package.

An invoice consists of several charges. In turn, each charge was created either manually by a user, or it was computed automatically using statistics.

As an example, consider a warehouse that wants to bill its 3PL customer in two ways:

1. They want to charge $5 for every order that they picked.
2. When picking very bulky orders, they need to get a special forklift out, and they want to bill the customer an additional $50 extra for this every time.

The first charge is a typical example of something that would be set up as a statistics charge in Ongoing WMS. The second one is a typical example of a manual charge.

Tags: GetInvoicesByQuery , Query, GetInvoicesByQueryResult, InvoiceV2, GoodsOwner, InvoiceCharge, InvoiceArticle, OrderContext, InOrderContext, ProductionOrderContext, ArticleItemContext, ArticleContext

Request XML

POST /Service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/GetInvoicesByQuery"

<?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>
    <GetInvoicesByQuery xmlns="http://ongoingsystems.se/WSI">
      <GoodsOwnerCode>string</GoodsOwnerCode>
      <UserName>string</UserName>
      <Password>string</Password>
      <query>
        <GetInvoiceRows>boolean</GetInvoiceRows>
        <InvoiceIds>
          <int>int</int>
          <int>int</int>
        </InvoiceIds>
        <IsExported>boolean</IsExported>
        <InvoiceExportedDateFrom>dateTime</InvoiceExportedDateFrom>
        <InvoiceExportedDateTo>dateTime</InvoiceExportedDateTo>
        <InvoiceDateFrom>dateTime</InvoiceDateFrom>
        <InvoiceDateTo>dateTime</InvoiceDateTo>
        <MaxInvoicesToGet>int</MaxInvoicesToGet>
        <InvoiceIdFrom>int</InvoiceIdFrom>
      </query>
    </GetInvoicesByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

Response XML

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>
    <GetInvoicesByQueryResponse xmlns="http://ongoingsystems.se/WSI">
      <GetInvoicesByQueryResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <Invoices>
          <InvoiceV2>
            <GoodsOwner xsi:nil="true" />
            <InvoiceCharges xsi:nil="true" />
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceId>int</InvoiceId>
            <Title>string</Title>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoicePeriodStart>dateTime</InvoicePeriodStart>
            <InvoicePeriodEnd>dateTime</InvoicePeriodEnd>
            <InvoiceAmount>decimal</InvoiceAmount>
            <IsExported>boolean</IsExported>
            <InvoiceYourOrderNumber>string</InvoiceYourOrderNumber>
            <InvoiceYourReference>string</InvoiceYourReference>
          </InvoiceV2>
          <InvoiceV2>
            <GoodsOwner xsi:nil="true" />
            <InvoiceCharges xsi:nil="true" />
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceId>int</InvoiceId>
            <Title>string</Title>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoicePeriodStart>dateTime</InvoicePeriodStart>
            <InvoicePeriodEnd>dateTime</InvoicePeriodEnd>
            <InvoiceAmount>decimal</InvoiceAmount>
            <IsExported>boolean</IsExported>
            <InvoiceYourOrderNumber>string</InvoiceYourOrderNumber>
            <InvoiceYourReference>string</InvoiceYourReference>
          </InvoiceV2>
        </Invoices>
      </GetInvoicesByQueryResult>
    </GetInvoicesByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification