InvoiceManagement Web Service

InvoiceManagement

Click here for a complete list of operations.

CreateInvoice

Send an invoice to the gateway

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 /Gateway3/InvoiceManagement.asmx HTTP/1.1
Host: gateway.pharmx.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.pharmx.com.au/gateway3/invoicemanagement/CreateInvoice"

<?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>
    <CreateInvoice xmlns="http://www.pharmx.com.au/gateway3/invoicemanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <invoice>
        <BillToAccountNumber>string</BillToAccountNumber>
        <DeliveryAccountNumber>string</DeliveryAccountNumber>
        <DueDate>dateTime</DueDate>
        <InvoiceSegmentNumber>int</InvoiceSegmentNumber>
        <InvoiceSegmentTotal>int</InvoiceSegmentTotal>
        <DeliveryDate>dateTime</DeliveryDate>
        <DeliveryNumber>string</DeliveryNumber>
        <DeliveryTrackingID>string</DeliveryTrackingID>
        <DeliveryTrackingURL>string</DeliveryTrackingURL>
        <SettlementDiscount>double</SettlementDiscount>
        <InvoiceNumber>string</InvoiceNumber>
        <Reference>string</Reference>
        <SupplierABN>string</SupplierABN>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <SenderUniqueMessageID>guid</SenderUniqueMessageID>
        <LineCount>int</LineCount>
        <Lines>
          <InvoiceLine>
            <InvoiceLineUID>guid</InvoiceLineUID>
            <OrderLineUID>guid</OrderLineUID>
            <SequenceNumber>int</SequenceNumber>
            <Description>string</Description>
            <Ean>string</Ean>
            <ExtendedCostExGst>double</ExtendedCostExGst>
            <ExtendedCostGst>double</ExtendedCostGst>
            <ExtendedCostIncGst>double</ExtendedCostIncGst>
            <GstStatus>string</GstStatus>
            <Manufacturer>string</Manufacturer>
            <NonSupplyReason>string</NonSupplyReason>
            <NormalCostExGst>double</NormalCostExGst>
            <NormalCostGst>double</NormalCostGst>
            <NormalCostIncGst>double</NormalCostIncGst>
            <UOM>string</UOM>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityBonus>int</QuantityBonus>
            <ReorderNumber>string</ReorderNumber>
            <ReorderNumberOrdered>string</ReorderNumberOrdered>
            <RetailPrice>double</RetailPrice>
            <Tote>string</Tote>
            <Tun>string</Tun>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <InvoiceLineType>unsignedByte</InvoiceLineType>
            <BatchNumber>string</BatchNumber>
            <ExpiryDate>dateTime</ExpiryDate>
            <MOQ>int</MOQ>
            <RetailUnitsPerUOM>int</RetailUnitsPerUOM>
            <ExtendedInfos xsi:nil="true" />
          </InvoiceLine>
          <InvoiceLine>
            <InvoiceLineUID>guid</InvoiceLineUID>
            <OrderLineUID>guid</OrderLineUID>
            <SequenceNumber>int</SequenceNumber>
            <Description>string</Description>
            <Ean>string</Ean>
            <ExtendedCostExGst>double</ExtendedCostExGst>
            <ExtendedCostGst>double</ExtendedCostGst>
            <ExtendedCostIncGst>double</ExtendedCostIncGst>
            <GstStatus>string</GstStatus>
            <Manufacturer>string</Manufacturer>
            <NonSupplyReason>string</NonSupplyReason>
            <NormalCostExGst>double</NormalCostExGst>
            <NormalCostGst>double</NormalCostGst>
            <NormalCostIncGst>double</NormalCostIncGst>
            <UOM>string</UOM>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityBonus>int</QuantityBonus>
            <ReorderNumber>string</ReorderNumber>
            <ReorderNumberOrdered>string</ReorderNumberOrdered>
            <RetailPrice>double</RetailPrice>
            <Tote>string</Tote>
            <Tun>string</Tun>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <InvoiceLineType>unsignedByte</InvoiceLineType>
            <BatchNumber>string</BatchNumber>
            <ExpiryDate>dateTime</ExpiryDate>
            <MOQ>int</MOQ>
            <RetailUnitsPerUOM>int</RetailUnitsPerUOM>
            <ExtendedInfos xsi:nil="true" />
          </InvoiceLine>
        </Lines>
        <ExtendedInfos>
          <ExtendedInfo>
            <Name>string</Name>
            <Type>string</Type>
            <Value>string</Value>
          </ExtendedInfo>
          <ExtendedInfo>
            <Name>string</Name>
            <Type>string</Type>
            <Value>string</Value>
          </ExtendedInfo>
        </ExtendedInfos>
      </invoice>
    </CreateInvoice>
  </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>
    <CreateInvoiceResponse xmlns="http://www.pharmx.com.au/gateway3/invoicemanagement">
      <CreateInvoiceResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CreateInvoiceResult>
    </CreateInvoiceResponse>
  </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 /Gateway3/InvoiceManagement.asmx HTTP/1.1
Host: gateway.pharmx.com.au
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>
    <CreateInvoice xmlns="http://www.pharmx.com.au/gateway3/invoicemanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <invoice>
        <BillToAccountNumber>string</BillToAccountNumber>
        <DeliveryAccountNumber>string</DeliveryAccountNumber>
        <DueDate>dateTime</DueDate>
        <InvoiceSegmentNumber>int</InvoiceSegmentNumber>
        <InvoiceSegmentTotal>int</InvoiceSegmentTotal>
        <DeliveryDate>dateTime</DeliveryDate>
        <DeliveryNumber>string</DeliveryNumber>
        <DeliveryTrackingID>string</DeliveryTrackingID>
        <DeliveryTrackingURL>string</DeliveryTrackingURL>
        <SettlementDiscount>double</SettlementDiscount>
        <InvoiceNumber>string</InvoiceNumber>
        <Reference>string</Reference>
        <SupplierABN>string</SupplierABN>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <SenderUniqueMessageID>guid</SenderUniqueMessageID>
        <LineCount>int</LineCount>
        <Lines>
          <InvoiceLine>
            <InvoiceLineUID>guid</InvoiceLineUID>
            <OrderLineUID>guid</OrderLineUID>
            <SequenceNumber>int</SequenceNumber>
            <Description>string</Description>
            <Ean>string</Ean>
            <ExtendedCostExGst>double</ExtendedCostExGst>
            <ExtendedCostGst>double</ExtendedCostGst>
            <ExtendedCostIncGst>double</ExtendedCostIncGst>
            <GstStatus>string</GstStatus>
            <Manufacturer>string</Manufacturer>
            <NonSupplyReason>string</NonSupplyReason>
            <NormalCostExGst>double</NormalCostExGst>
            <NormalCostGst>double</NormalCostGst>
            <NormalCostIncGst>double</NormalCostIncGst>
            <UOM>string</UOM>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityBonus>int</QuantityBonus>
            <ReorderNumber>string</ReorderNumber>
            <ReorderNumberOrdered>string</ReorderNumberOrdered>
            <RetailPrice>double</RetailPrice>
            <Tote>string</Tote>
            <Tun>string</Tun>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <InvoiceLineType>unsignedByte</InvoiceLineType>
            <BatchNumber>string</BatchNumber>
            <ExpiryDate>dateTime</ExpiryDate>
            <MOQ>int</MOQ>
            <RetailUnitsPerUOM>int</RetailUnitsPerUOM>
            <ExtendedInfos xsi:nil="true" />
          </InvoiceLine>
          <InvoiceLine>
            <InvoiceLineUID>guid</InvoiceLineUID>
            <OrderLineUID>guid</OrderLineUID>
            <SequenceNumber>int</SequenceNumber>
            <Description>string</Description>
            <Ean>string</Ean>
            <ExtendedCostExGst>double</ExtendedCostExGst>
            <ExtendedCostGst>double</ExtendedCostGst>
            <ExtendedCostIncGst>double</ExtendedCostIncGst>
            <GstStatus>string</GstStatus>
            <Manufacturer>string</Manufacturer>
            <NonSupplyReason>string</NonSupplyReason>
            <NormalCostExGst>double</NormalCostExGst>
            <NormalCostGst>double</NormalCostGst>
            <NormalCostIncGst>double</NormalCostIncGst>
            <UOM>string</UOM>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityBonus>int</QuantityBonus>
            <ReorderNumber>string</ReorderNumber>
            <ReorderNumberOrdered>string</ReorderNumberOrdered>
            <RetailPrice>double</RetailPrice>
            <Tote>string</Tote>
            <Tun>string</Tun>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <InvoiceLineType>unsignedByte</InvoiceLineType>
            <BatchNumber>string</BatchNumber>
            <ExpiryDate>dateTime</ExpiryDate>
            <MOQ>int</MOQ>
            <RetailUnitsPerUOM>int</RetailUnitsPerUOM>
            <ExtendedInfos xsi:nil="true" />
          </InvoiceLine>
        </Lines>
        <ExtendedInfos>
          <ExtendedInfo>
            <Name>string</Name>
            <Type>string</Type>
            <Value>string</Value>
          </ExtendedInfo>
          <ExtendedInfo>
            <Name>string</Name>
            <Type>string</Type>
            <Value>string</Value>
          </ExtendedInfo>
        </ExtendedInfos>
      </invoice>
    </CreateInvoice>
  </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>
    <CreateInvoiceResponse xmlns="http://www.pharmx.com.au/gateway3/invoicemanagement">
      <CreateInvoiceResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CreateInvoiceResult>
    </CreateInvoiceResponse>
  </soap12:Body>
</soap12:Envelope>