This project is read-only.
0

Closed

Support payment.list

description

http://developers.freshbooks.com/docs/payments/
 
payment.list
 
Returns a list of recorded payments. You can optionally filter by invoice_id or client_id.
Note: This method uses pagination
 
Request
 
view plaincopy to clipboardprint?
 
  • <?xml version="1.0" encoding="utf-8"?> 
  • <request method="payment.list"> 
  •   <client_id>3</client_id>            <!-- Filter by client (Optional) --> 
  •   <invoice_id>133</invoice_id>        <!-- Filter by invoice (Optional) --> 
  •   <date_from>2007-01-01</date_from>   <!-- Return payments dated after this arg (Optional) --> 
  •   <date_to>2007-04-01</date_to>       <!-- Return payments dated before this arg (Optional) --> 
  •   <updated_from>2007-01-01</updated_from>   <!-- Return payments modified after this arg (Optional) --> 
  •   <updated_to>2007-04-01</updated_to>       <!-- Return payments modified before this arg (Optional) --> 
  •  
  •   <page>1</page>                      <!-- Page number to return, default is 1 (Optional) --> 
  •   <per_page>10</per_page>             <!-- Number of results per page, default is 25 (Optional) --> 
  • </request> 
     
    Response
     
    view plaincopy to clipboardprint?
     
  • <?xml version="1.0" encoding="utf-8"?> 
  • <response xmlns="http://www.freshbooks.com/api/" status="ok"> 
  •   <payments page="1" per_page="10" pages="23" total="221"> 
  •     <payment> 
  •       <payment_id>165</payment_id> 
  •       <invoice_id>203</invoice_id> 
  •       <date>2007-03-02 12:04:11</date> 
  •       <type>VISA</type> 
  •       <notes></notes> 
  •       <client_id>43</client_id> 
  •       <currency_code>CAD</currency_code> <!-- Only returned for credits --> 
  •       <updated>2009-08-12 09:00:00</updated> <!-- (Read-only) --> 
  •       <gateway_transaction> <!-- (Read-only) --> <!-- Only returned for online payments --> 
  •           <reference_id>2156858189</reference_id> 
  •           <gateway_name>Authorize.Net</gateway_name> 
  •       </gateway_transaction> 
  •       <amount>301.21</amount> 
  •     </payment> 
  •     ... 
  •   </payments> 
  • </response>
Closed Jul 23, 2012 at 6:18 PM by stemarie

comments

wrote Jul 23, 2012 at 6:18 PM

Resolved with changeset 94086.

wrote Feb 1, 2013 at 12:24 AM

wrote May 13, 2013 at 7:24 PM

wrote Nov 27 at 7:31 PM