Skip to content

Overpayments

Michael Newman edited this page Aug 7, 2017 · 3 revisions

See Overpayments at Xero Developer for more information.

see the home page for application setup.

Get Overpayments

$xero->overpayments()->get();

Allocate Overpayment

$overpaymentId = 'c293218a-7360-11e7-8cf7-a6006ad3dba0';
$invoiceId =  '3fd27838-68f5-11e7-907b-a6006ad3dba0';
$appliedAmount = 100.00;

$xero->overpayments()->allocate($overpaymentId, $invoiceId, $appliedAmount);

Request Parameters

ModifiedAfter
$xero->overpayments()->modifiedAfter('2017-03-28T12:00:00')->get();
Where
$xero->overpayments()->where('Status=="PAID"')->get();
Order
//Ascending
$xero->overpayments()->order('Contact.Name')->get();

//Descending
$xero->overpayments()->order('Contact.Name', 'DESC')->get();
Page
$xero->overpayments()->page(1)->get();
SummarizeErrors
$xero->overpayments()->summarizeErrors()->allocate( ... );
Clone this wiki locally