BackOffice Web Service

BackOffice

Click here for a complete list of operations.

GetPaymentsForInvoices

Get payments posted against invoices in the head office

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 /puckanetennisclub/app/BackOffice.asmx HTTP/1.1
Host: lightingsports.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.joycesoftware.com/GetPaymentsForInvoices"

<?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>
    <GetPaymentsForInvoices xmlns="http://www.joycesoftware.com">
      <PaymentGUID>string</PaymentGUID>
    </GetPaymentsForInvoices>
  </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>
    <GetPaymentsForInvoicesResponse xmlns="http://www.joycesoftware.com">
      <GetPaymentsForInvoicesResult>
        <SalesInvoiceLine>
          <Id>int</Id>
          <SalesInvoiceGuid>string</SalesInvoiceGuid>
          <LineGuid>string</LineGuid>
          <LineType>int</LineType>
          <ProductGUID>string</ProductGUID>
          <ProductDescription>string</ProductDescription>
          <Sku>string</Sku>
          <TaxCategoryId>int</TaxCategoryId>
          <TaxRate>decimal</TaxRate>
          <UnitPrice>decimal</UnitPrice>
          <UnitCost>decimal</UnitCost>
          <Quantity>decimal</Quantity>
          <TotalPriceInc>decimal</TotalPriceInc>
          <TotalPriceExc>decimal</TotalPriceExc>
          <TotalDiscountInc>decimal</TotalDiscountInc>
          <TotalDiscountExc>decimal</TotalDiscountExc>
          <LineMessage1>string</LineMessage1>
          <LineMessage2>string</LineMessage2>
          <LineMessage3>string</LineMessage3>
          <LineMessage4>string</LineMessage4>
          <LineMessage5>string</LineMessage5>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <TotalPromotionalInc>decimal</TotalPromotionalInc>
          <TotalPromotionalExc>decimal</TotalPromotionalExc>
          <PrintPickingList>string</PrintPickingList>
          <BatchNumber>string</BatchNumber>
          <ExpiryDate>dateTime</ExpiryDate>
          <ProductType>decimal</ProductType>
          <AnimalGUID>string</AnimalGUID>
          <OriginalLineGuid>string</OriginalLineGuid>
          <CreditedQuantity>decimal</CreditedQuantity>
          <UnitofMeasure>string</UnitofMeasure>
        </SalesInvoiceLine>
        <SalesInvoiceLine>
          <Id>int</Id>
          <SalesInvoiceGuid>string</SalesInvoiceGuid>
          <LineGuid>string</LineGuid>
          <LineType>int</LineType>
          <ProductGUID>string</ProductGUID>
          <ProductDescription>string</ProductDescription>
          <Sku>string</Sku>
          <TaxCategoryId>int</TaxCategoryId>
          <TaxRate>decimal</TaxRate>
          <UnitPrice>decimal</UnitPrice>
          <UnitCost>decimal</UnitCost>
          <Quantity>decimal</Quantity>
          <TotalPriceInc>decimal</TotalPriceInc>
          <TotalPriceExc>decimal</TotalPriceExc>
          <TotalDiscountInc>decimal</TotalDiscountInc>
          <TotalDiscountExc>decimal</TotalDiscountExc>
          <LineMessage1>string</LineMessage1>
          <LineMessage2>string</LineMessage2>
          <LineMessage3>string</LineMessage3>
          <LineMessage4>string</LineMessage4>
          <LineMessage5>string</LineMessage5>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <TotalPromotionalInc>decimal</TotalPromotionalInc>
          <TotalPromotionalExc>decimal</TotalPromotionalExc>
          <PrintPickingList>string</PrintPickingList>
          <BatchNumber>string</BatchNumber>
          <ExpiryDate>dateTime</ExpiryDate>
          <ProductType>decimal</ProductType>
          <AnimalGUID>string</AnimalGUID>
          <OriginalLineGuid>string</OriginalLineGuid>
          <CreditedQuantity>decimal</CreditedQuantity>
          <UnitofMeasure>string</UnitofMeasure>
        </SalesInvoiceLine>
      </GetPaymentsForInvoicesResult>
    </GetPaymentsForInvoicesResponse>
  </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 /puckanetennisclub/app/BackOffice.asmx HTTP/1.1
Host: lightingsports.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>
    <GetPaymentsForInvoices xmlns="http://www.joycesoftware.com">
      <PaymentGUID>string</PaymentGUID>
    </GetPaymentsForInvoices>
  </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>
    <GetPaymentsForInvoicesResponse xmlns="http://www.joycesoftware.com">
      <GetPaymentsForInvoicesResult>
        <SalesInvoiceLine>
          <Id>int</Id>
          <SalesInvoiceGuid>string</SalesInvoiceGuid>
          <LineGuid>string</LineGuid>
          <LineType>int</LineType>
          <ProductGUID>string</ProductGUID>
          <ProductDescription>string</ProductDescription>
          <Sku>string</Sku>
          <TaxCategoryId>int</TaxCategoryId>
          <TaxRate>decimal</TaxRate>
          <UnitPrice>decimal</UnitPrice>
          <UnitCost>decimal</UnitCost>
          <Quantity>decimal</Quantity>
          <TotalPriceInc>decimal</TotalPriceInc>
          <TotalPriceExc>decimal</TotalPriceExc>
          <TotalDiscountInc>decimal</TotalDiscountInc>
          <TotalDiscountExc>decimal</TotalDiscountExc>
          <LineMessage1>string</LineMessage1>
          <LineMessage2>string</LineMessage2>
          <LineMessage3>string</LineMessage3>
          <LineMessage4>string</LineMessage4>
          <LineMessage5>string</LineMessage5>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <TotalPromotionalInc>decimal</TotalPromotionalInc>
          <TotalPromotionalExc>decimal</TotalPromotionalExc>
          <PrintPickingList>string</PrintPickingList>
          <BatchNumber>string</BatchNumber>
          <ExpiryDate>dateTime</ExpiryDate>
          <ProductType>decimal</ProductType>
          <AnimalGUID>string</AnimalGUID>
          <OriginalLineGuid>string</OriginalLineGuid>
          <CreditedQuantity>decimal</CreditedQuantity>
          <UnitofMeasure>string</UnitofMeasure>
        </SalesInvoiceLine>
        <SalesInvoiceLine>
          <Id>int</Id>
          <SalesInvoiceGuid>string</SalesInvoiceGuid>
          <LineGuid>string</LineGuid>
          <LineType>int</LineType>
          <ProductGUID>string</ProductGUID>
          <ProductDescription>string</ProductDescription>
          <Sku>string</Sku>
          <TaxCategoryId>int</TaxCategoryId>
          <TaxRate>decimal</TaxRate>
          <UnitPrice>decimal</UnitPrice>
          <UnitCost>decimal</UnitCost>
          <Quantity>decimal</Quantity>
          <TotalPriceInc>decimal</TotalPriceInc>
          <TotalPriceExc>decimal</TotalPriceExc>
          <TotalDiscountInc>decimal</TotalDiscountInc>
          <TotalDiscountExc>decimal</TotalDiscountExc>
          <LineMessage1>string</LineMessage1>
          <LineMessage2>string</LineMessage2>
          <LineMessage3>string</LineMessage3>
          <LineMessage4>string</LineMessage4>
          <LineMessage5>string</LineMessage5>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <TotalPromotionalInc>decimal</TotalPromotionalInc>
          <TotalPromotionalExc>decimal</TotalPromotionalExc>
          <PrintPickingList>string</PrintPickingList>
          <BatchNumber>string</BatchNumber>
          <ExpiryDate>dateTime</ExpiryDate>
          <ProductType>decimal</ProductType>
          <AnimalGUID>string</AnimalGUID>
          <OriginalLineGuid>string</OriginalLineGuid>
          <CreditedQuantity>decimal</CreditedQuantity>
          <UnitofMeasure>string</UnitofMeasure>
        </SalesInvoiceLine>
      </GetPaymentsForInvoicesResult>
    </GetPaymentsForInvoicesResponse>
  </soap12:Body>
</soap12:Envelope>