InvoiceGet


A service that returns a list of invoices.

WEBSERVICE : http://webservices.vortexauction.com/functions.cfc?wsdl METHOD : InvoiceGet ARGUMENT : AUCTIONEER_ID [Numeric] Required | Your auctioneer ID ACCESS_KEY [String] Required | Your web service access key INVOICE_ID [Numeric] Optional | An invoice ID NUMBER_OF_INVOICE_TO_GET [Numeric] Optional | Number of invoice to get (default 1 and maximum 50) LAST_KNOWN_INVOICE_ID [Numeric] Optional | To get the next invoice after the known ID
RETURNS : InvoiceGetResponse ON FAILURE : <?xml version="1.0" encoding="utf-8"?> <InvoiceGetResponse> <Error> <Code>[Error code]</Code> <Message>[Error message]</Message> </Error> </InvoiceGetResponse> ON SUCCESS : <?xml version="1.0" encoding="utf-8"?> <InvoiceGetResponse> <InvoiceList> <Invoice> <ID>[Invoice ID]</ID> <Name>[Auction name]</Name> <Date>[Auction date]</Date> <CurrencyCode>[Auction currency code (CAD, USD, EUR ...)]</CurrencyCode> <Auctioneer> <AuctioneerName></AuctioneerName> <AuctioneerAddress></AuctioneerAddress> <AuctioneerCity></AuctioneerCity> <AuctioneerProvinceName></AuctioneerProvinceName> <AuctioneerCountryName></AuctioneerCountryName> <AuctioneerTelephone1></AuctioneerTelephone1> <AuctioneerTelephone2></AuctioneerTelephone2> <AuctioneerFax></AuctioneerFax> <AuctioneerEmail></AuctioneerEmail> </Auctioneer> <Bidder> <Bidder_ID></Bidder_ID> <CompanyName></CompanyName> <FirstName></FirstName> <LastName></LastName> <Address></Address> <ProvinceName></ProvinceName> <City></City> <CountryName></CountryName> <PostalCode></PostalCode> <Telephone1></Telephone1> <Telephone2></Telephone2> <Email></Email> <Consignor_ID></Consignor_ID> </Bidder> <ItemList> <Item> <ID></ID> <LotNumber></LotNumber> <RunNumber></RunNumber> <Name></Name> <CategoryName></CategoryName> <Price></Price> <Description></Description> <Fees> <Fee> <Name></Name> <Amount></Amount> </Fee> </Fees> <TotalPrice></TotalPrice> </Item> ... </ItemList> <Subtotal>[Amount without taxs]</Subtotal> <Tax1>[Tax1 if applicable]</Tax1> <Tax2>[Tax2 if applicable]</Tax2> <Total>[Invoice total]</Total> <BottomLeftText>[Left bottom text on your invoice page]</BottomLeftText> <BottomRightText>[Right bottom text on your invoice page]</BottomRightText> </Invoice> ... </InvoiceList> ... </InvoiceGetResponse>
ERROR CODES: 00 = An unexpected error occured. 01 = Missing or invalid arguments. 02 = Invalid auctioneer ID and/or access key. 09 = Invalid invoice ID.
EXAMPLES : COLDFUSION : <cfinvoke webservice="http://webservices.vortexauction.com/functions.cfc?wsdl" method="InvoiceGet" returnvariable="result"> <cfinvokeargument name="Auctioneer_ID" value="0" /> <cfinvokeargument name="Access_Key" value="..." /> <cfinvokeargument name="Invoice_ID" value="..." /> <cfinvokeargument name="Number_of_invoice_to_get" value="..." /> <cfinvokeargument name="Last_known_invoice_ID" value="..." /> </cfinvoke> <cfdump var=#result# /> PHP : class InvoiceGet { function InvoiceGet($Auctioneer_ID, $Access_Key, $Invoice_ID, $Number_of_invoice_to_get, $Last_known_invoice_ID) { $this->Auctioneer_ID = $Auctioneer_ID; $this->Access_Key = $Access_Key; $this->Invoice_ID = $Invoice_ID; $this->Number_of_invoice_to_get = $Number_of_invoice_to_get; $this->Last_known_invoice_ID = $Last_known_invoice_ID; } } $soapClient = new SoapClient("http://webservices.vortexauction.com/functions.cfc?wsdl"); $params = new InvoiceGet(0, "...", "..."); $result = $soapClient->InvoiceGet($params); var_dump($result);
TEST FORM: