PublicAPIService
Click here for a complete list of operations.
AddAPVoucher
Post an APVoucher
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/AddAPVoucher" <?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> <AddAPVoucher xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <Auth> <User>string</User> <Password>string</Password> <CompanyID>string</CompanyID> <Version>string</Version> <PartnerToken>string</PartnerToken> </Auth> <voucher> <VoucherNumber> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </VoucherNumber> <VendorNumber> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </VendorNumber> <VendorInvoiceNumber> <Value>string</Value> <Valid>boolean</Valid> </VendorInvoiceNumber> <Total> <Value>decimal</Value> <Valid>boolean</Valid> </Total> <Date> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </Date> <Description> <Value>string</Value> <Valid>boolean</Valid> </Description> <PONumber> <Value>string</Value> <Valid>boolean</Valid> </PONumber> <ExtBatchNumber> <Value>string</Value> <Valid>boolean</Valid> </ExtBatchNumber> <Details> <VoucherDetail> <VoucherNumber xsi:nil="true" /> <TransactionType>int</TransactionType> <Description xsi:nil="true" /> <GLAccount xsi:nil="true" /> <GLDept xsi:nil="true" /> <GLBranch xsi:nil="true" /> <GLDivision xsi:nil="true" /> <Amount xsi:nil="true" /> <CreditAmount xsi:nil="true" /> <DebitAmount xsi:nil="true" /> </VoucherDetail> <VoucherDetail> <VoucherNumber xsi:nil="true" /> <TransactionType>int</TransactionType> <Description xsi:nil="true" /> <GLAccount xsi:nil="true" /> <GLDept xsi:nil="true" /> <GLBranch xsi:nil="true" /> <GLDivision xsi:nil="true" /> <Amount xsi:nil="true" /> <CreditAmount xsi:nil="true" /> <DebitAmount xsi:nil="true" /> </VoucherDetail> </Details> <Applications> <VoucherApplication> <VoucherNumber xsi:nil="true" /> <CheckDate xsi:nil="true" /> <CheckNumber xsi:nil="true" /> <TransType xsi:nil="true" /> <Amount xsi:nil="true" /> </VoucherApplication> <VoucherApplication> <VoucherNumber xsi:nil="true" /> <CheckDate xsi:nil="true" /> <CheckNumber xsi:nil="true" /> <TransType xsi:nil="true" /> <Amount xsi:nil="true" /> </VoucherApplication> </Applications> </voucher> </AddAPVoucher> </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> <AddAPVoucherResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <AddAPVoucherResult> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </AddAPVoucherResult> </AddAPVoucherResponse> </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> <AddAPVoucher xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <Auth> <User>string</User> <Password>string</Password> <CompanyID>string</CompanyID> <Version>string</Version> <PartnerToken>string</PartnerToken> </Auth> <voucher> <VoucherNumber> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </VoucherNumber> <VendorNumber> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </VendorNumber> <VendorInvoiceNumber> <Value>string</Value> <Valid>boolean</Valid> </VendorInvoiceNumber> <Total> <Value>decimal</Value> <Valid>boolean</Valid> </Total> <Date> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </Date> <Description> <Value>string</Value> <Valid>boolean</Valid> </Description> <PONumber> <Value>string</Value> <Valid>boolean</Valid> </PONumber> <ExtBatchNumber> <Value>string</Value> <Valid>boolean</Valid> </ExtBatchNumber> <Details> <VoucherDetail> <VoucherNumber xsi:nil="true" /> <TransactionType>int</TransactionType> <Description xsi:nil="true" /> <GLAccount xsi:nil="true" /> <GLDept xsi:nil="true" /> <GLBranch xsi:nil="true" /> <GLDivision xsi:nil="true" /> <Amount xsi:nil="true" /> <CreditAmount xsi:nil="true" /> <DebitAmount xsi:nil="true" /> </VoucherDetail> <VoucherDetail> <VoucherNumber xsi:nil="true" /> <TransactionType>int</TransactionType> <Description xsi:nil="true" /> <GLAccount xsi:nil="true" /> <GLDept xsi:nil="true" /> <GLBranch xsi:nil="true" /> <GLDivision xsi:nil="true" /> <Amount xsi:nil="true" /> <CreditAmount xsi:nil="true" /> <DebitAmount xsi:nil="true" /> </VoucherDetail> </Details> <Applications> <VoucherApplication> <VoucherNumber xsi:nil="true" /> <CheckDate xsi:nil="true" /> <CheckNumber xsi:nil="true" /> <TransType xsi:nil="true" /> <Amount xsi:nil="true" /> </VoucherApplication> <VoucherApplication> <VoucherNumber xsi:nil="true" /> <CheckDate xsi:nil="true" /> <CheckNumber xsi:nil="true" /> <TransType xsi:nil="true" /> <Amount xsi:nil="true" /> </VoucherApplication> </Applications> </voucher> </AddAPVoucher> </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> <AddAPVoucherResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <AddAPVoucherResult> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </AddAPVoucherResult> </AddAPVoucherResponse> </soap12:Body> </soap12:Envelope>