CreditManagement Web Service

CreditManagement

Click here for a complete list of operations.

CreateCredit

Send an CreditDocument 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/CreditManagement.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/creditmanagement/CreateCredit"

<?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>
    <CreateCredit xmlns="http://www.pharmx.com.au/gateway3/creditmanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <creditDocument>
        <CreditNumber>string</CreditNumber>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <CreditDate>dateTime</CreditDate>
        <CreditDueDate>dateTime</CreditDueDate>
        <AccountNumber>string</AccountNumber>
        <SupplierCompany>string</SupplierCompany>
        <SupplierABN>string</SupplierABN>
        <Reference>string</Reference>
        <LineCount>int</LineCount>
        <Lines>
          <CreditLine>
            <CreditLineUID>guid</CreditLineUID>
            <InvoiceNumber>string</InvoiceNumber>
            <ReorderNumber>string</ReorderNumber>
            <RanNumber>string</RanNumber>
            <Description>string</Description>
            <UOM>string</UOM>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityAdjusted>int</QuantityAdjusted>
            <TotalAdjustmentExGst>double</TotalAdjustmentExGst>
            <TotalAdjustmentGst>double</TotalAdjustmentGst>
            <TotalAdjustmentIncGst>double</TotalAdjustmentIncGst>
            <DiscountAmount>double</DiscountAmount>
            <DiscountPercentage>double</DiscountPercentage>
            <Ean>string</Ean>
            <Tun>string</Tun>
            <Reason>string</Reason>
            <CustomerReference>string</CustomerReference>
          </CreditLine>
          <CreditLine>
            <CreditLineUID>guid</CreditLineUID>
            <InvoiceNumber>string</InvoiceNumber>
            <ReorderNumber>string</ReorderNumber>
            <RanNumber>string</RanNumber>
            <Description>string</Description>
            <UOM>string</UOM>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityAdjusted>int</QuantityAdjusted>
            <TotalAdjustmentExGst>double</TotalAdjustmentExGst>
            <TotalAdjustmentGst>double</TotalAdjustmentGst>
            <TotalAdjustmentIncGst>double</TotalAdjustmentIncGst>
            <DiscountAmount>double</DiscountAmount>
            <DiscountPercentage>double</DiscountPercentage>
            <Ean>string</Ean>
            <Tun>string</Tun>
            <Reason>string</Reason>
            <CustomerReference>string</CustomerReference>
          </CreditLine>
        </Lines>
        <SupplierUniqueMessageID>guid</SupplierUniqueMessageID>
      </creditDocument>
    </CreateCredit>
  </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>
    <CreateCreditResponse xmlns="http://www.pharmx.com.au/gateway3/creditmanagement">
      <CreateCreditResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CreateCreditResult>
    </CreateCreditResponse>
  </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/CreditManagement.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>
    <CreateCredit xmlns="http://www.pharmx.com.au/gateway3/creditmanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <creditDocument>
        <CreditNumber>string</CreditNumber>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <CreditDate>dateTime</CreditDate>
        <CreditDueDate>dateTime</CreditDueDate>
        <AccountNumber>string</AccountNumber>
        <SupplierCompany>string</SupplierCompany>
        <SupplierABN>string</SupplierABN>
        <Reference>string</Reference>
        <LineCount>int</LineCount>
        <Lines>
          <CreditLine>
            <CreditLineUID>guid</CreditLineUID>
            <InvoiceNumber>string</InvoiceNumber>
            <ReorderNumber>string</ReorderNumber>
            <RanNumber>string</RanNumber>
            <Description>string</Description>
            <UOM>string</UOM>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityAdjusted>int</QuantityAdjusted>
            <TotalAdjustmentExGst>double</TotalAdjustmentExGst>
            <TotalAdjustmentGst>double</TotalAdjustmentGst>
            <TotalAdjustmentIncGst>double</TotalAdjustmentIncGst>
            <DiscountAmount>double</DiscountAmount>
            <DiscountPercentage>double</DiscountPercentage>
            <Ean>string</Ean>
            <Tun>string</Tun>
            <Reason>string</Reason>
            <CustomerReference>string</CustomerReference>
          </CreditLine>
          <CreditLine>
            <CreditLineUID>guid</CreditLineUID>
            <InvoiceNumber>string</InvoiceNumber>
            <ReorderNumber>string</ReorderNumber>
            <RanNumber>string</RanNumber>
            <Description>string</Description>
            <UOM>string</UOM>
            <QuantitySupplied>int</QuantitySupplied>
            <QuantityAdjusted>int</QuantityAdjusted>
            <TotalAdjustmentExGst>double</TotalAdjustmentExGst>
            <TotalAdjustmentGst>double</TotalAdjustmentGst>
            <TotalAdjustmentIncGst>double</TotalAdjustmentIncGst>
            <DiscountAmount>double</DiscountAmount>
            <DiscountPercentage>double</DiscountPercentage>
            <Ean>string</Ean>
            <Tun>string</Tun>
            <Reason>string</Reason>
            <CustomerReference>string</CustomerReference>
          </CreditLine>
        </Lines>
        <SupplierUniqueMessageID>guid</SupplierUniqueMessageID>
      </creditDocument>
    </CreateCredit>
  </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>
    <CreateCreditResponse xmlns="http://www.pharmx.com.au/gateway3/creditmanagement">
      <CreateCreditResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CreateCreditResult>
    </CreateCreditResponse>
  </soap12:Body>
</soap12:Envelope>