PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

AddARCreditMemoAndApplyToARInvoice

Apply AR credit memo and apply it to a specified AR invoice

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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/AddARCreditMemoAndApplyToARInvoice"

<?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>
    <AddARCreditMemoAndApplyToARInvoice xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <memoData>
        <MemoID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MemoID>
        <CustomerID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerID>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <GLID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </GLID>
        <GLBranch>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </GLBranch>
        <GLDivision>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </GLDivision>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <Amount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Amount>
        <Reversal>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Reversal>
        <ExtReferenceNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ExtReferenceNumber>
        <ApplyToDetails>
          <MemoDetailData>
            <ApplyToNumber xsi:nil="true" />
            <ApplyToType xsi:nil="true" />
            <ApplyToAmount xsi:nil="true" />
          </MemoDetailData>
          <MemoDetailData>
            <ApplyToNumber xsi:nil="true" />
            <ApplyToType xsi:nil="true" />
            <ApplyToAmount xsi:nil="true" />
          </MemoDetailData>
        </ApplyToDetails>
      </memoData>
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
    </AddARCreditMemoAndApplyToARInvoice>
  </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>
    <AddARCreditMemoAndApplyToARInvoiceResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <AddARCreditMemoAndApplyToARInvoiceResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </AddARCreditMemoAndApplyToARInvoiceResult>
    </AddARCreditMemoAndApplyToARInvoiceResponse>
  </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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.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>
    <AddARCreditMemoAndApplyToARInvoice xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <memoData>
        <MemoID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MemoID>
        <CustomerID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerID>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <GLID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </GLID>
        <GLBranch>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </GLBranch>
        <GLDivision>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </GLDivision>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <Amount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Amount>
        <Reversal>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Reversal>
        <ExtReferenceNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ExtReferenceNumber>
        <ApplyToDetails>
          <MemoDetailData>
            <ApplyToNumber xsi:nil="true" />
            <ApplyToType xsi:nil="true" />
            <ApplyToAmount xsi:nil="true" />
          </MemoDetailData>
          <MemoDetailData>
            <ApplyToNumber xsi:nil="true" />
            <ApplyToType xsi:nil="true" />
            <ApplyToAmount xsi:nil="true" />
          </MemoDetailData>
        </ApplyToDetails>
      </memoData>
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
    </AddARCreditMemoAndApplyToARInvoice>
  </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>
    <AddARCreditMemoAndApplyToARInvoiceResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <AddARCreditMemoAndApplyToARInvoiceResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </AddARCreditMemoAndApplyToARInvoiceResult>
    </AddARCreditMemoAndApplyToARInvoiceResponse>
  </soap12:Body>
</soap12:Envelope>