Extract invoices

Use the getInvoices method to extract shopper invoices from the 2Checkout system based on unique order references. The method returns the binary code for invoices in the PDF file format, Base64 encoded (Base64 is used to represent binary data in the ASCII string format).

getInvoices works for COMPLETE orders for which an invoice was already issued. For refunded orders, getInvoices provides two shopper invoices, one for the original order and the second for the refund, reflecting the repayment made.

In the case of cross-selling orders which contain products from different merchants, getInvoice enables you to re-send only the invoices for your own offerings.

Request parameters

Parameter	Type / Description
sessionID	Required (string) Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
reference	Required (string) Unique, system generated reference for orders.

Request sample

<?php

require ('PATH_TO_AUTH');

$reference = 'ORDER_REFERENCE';

try {
    $invoices = $client->getInvoices($sessionID, $reference);
}
catch (SoapFault $e) {
    echo "invoices: " . $e->getMessage();
    exit;
}
var_dump("invoices", $invoices);

Response parameters

Parameter	Type / Description
InvoicesData	Array of objects Details below.
InvoicesData.Sale	String Base64 encoded PDF file containing an invoice for a Complete order.
InvoicesData.Cancellation	String Base64 encoded PDF file containing a cancellation invoice.
InvoicesData.Refunds	Array of string Base64 encoded PDF files containing invoices for Refunds.