API Docs

Get to know get_payments

Overview: get_payments expects to be called with an associative array of parameters including the following keys:

  • invoice_id - The ID of the Ubiquity invoice.

Example:

$params = array(
		'invoice_id' => 854812
	);
$api->call('billing.get_payments', $params);

Output:

Array
	(
	    [status] => 1
	    [data] => Array
	        (
	            [invid] => 854812
	            [invnum] => 854812
	            [date] => 1363125521
	            [due] => 1363669200
	            [amount] => 10.00
	            [clientid] => 5974
	            [sent] => 1
	            [paid] => 1
	            [datepaid] => 1363285585
	            [body] =>
	            [overdue] => 1363669200
	            [reason] =>
	            [comment] =>
	            [amount_unpaid] => 0.00
	            [account_balance] => 10.00
	            [after_tni] => 1
	            [qblistid] =>
	            [last_late_fee_time] => 0
	            [late_fee_method] => 0
	            [late_fee_amount] => 0.00000000
	            [late_fee_delay] => 1
	            [late_fee_recur_method] => 0
	            [late_fee_recur_amount] => 0.00000000
	            [late_fee_recur_interval] => 0
	            [print_status] => 0
	            [qbeditseq] =>
	            [qbtxnid] =>
	            [id_number] => 854812
	            [retryid] =>
	            [client] => Array
	                (
	                    [first] => Firstname
	                    [last] => Lastname
	                    [company] => Nobis Technology Group LLC
	                    [address] => 6930 E Chauncey Ln
	                    [city] => Scottsdale
	                    [state] => AZ
	                    [zip] => 85045
	                    [country] => US
	                )
	            [summary] => Array
	                (                    
	                    [invnote] => Payment is expected by the due date captioned above. All payments should be made through our online portal at https://motion.ubiquityservers.com. Any account ...
	                    [payments] => 81
	                    [prior_balance] => 81
	                    [invoice_note] => This invoice has been sent manually without automatically processing a payment.
	Please contact us if you wish to arrange an alternate method of payment.
	                    [total_current_charges] => 10
	                    [account_balance] => 10
	                    [unpaid_balance] =>
	                    [current_charges] => 10
	                    [amount_charged] => 0
	                    [account_credits] => 0
	                    [total_tax] => 0
	                )
	            [aged] => Array
	                (
	                    [aged_current] => 0000
	                    [aged_zero_thirty] => 0000
	                    [aged_thirty_sixty] => 0000
	                    [aged_sixty_ninety] => 0000
	                    [aged_ninety_onetwenty] => 0000
	                    [aged_onetwenty_plus] => 0000
	                )
	            [current_packs] => Array
	                (
	                    [1] => Array
	                        (
	                            [item_id] => 135443
	                            [invid] => 854812
	                            [packid] => 35569
	                            [clientid] => 5974
	                            [inv_xml_id] => 1
	                            [due] => 1363669200
	                            [section] => current_packs
	                            [desserv] => cPanel license for VPS (cloud): 23.19.193.90 (lcpa)
	                            [servtype] => lcpa
	                            [date_range_start] => 1363064400
	                            [date_range_end] => 1365742800
	                            [billed] => 1
	                            [auto_bill] => 1
	                            [period] => 1
	                            [quantity] => 1.00
	                            [discount] =>
	                            [cost] => 10.00
	                            [unit_price] => 10.00
	                            [value] => 10.00
	                            [unpaid] => 0.00
	                            [paid] => 10.00
	                            [retry_pack_id] => 0
	                            [parentpack] => 34679
	                            [notes] =>
	                            [options] =>
	                            [suspend_on] => 0
	                            [cancel_on] => 0
	                            [suspended] => 0
	                            [canceled] => 0
	                            [details] => Array
	                                (
	                                    [singular] => detail
	                                )
	                            [ob_label] => package
	                            [attributes] => Array
	                                (
	                                    [id] => 1
	                                )
	                        )
	                )
	            [pre_billed_packs] => Array
	                (
	                )
	            [credits] => Array
	                (
	                )
	            [taxes] => Array
	                (
	                )
	            [packs] => Array
	                (
	                    [0] => Array
	                        (
	                            [packid] => 34679
	                            [desserv] => ALSO TEST
	                            [desserv_only] => 1
	                            [ob_label] => package
	                            [attributes] => Array
	                                (
	                                    [pack] => 34679
	                                )
	                        )
	                    [1] => Array
	                        (
	                            [packid] => 35569
	                            [desserv] => cPanel license for VPS (cloud): 23.19.193.90 (lcpa)
	                            [section] => current_packs
	                            [ob_label] => package
	                            [attributes] => Array
	                                (
	                                    [pack] => 35569
	                                )
	                            [parentpack] => 34679
	                        )
	                )
	        )
	)