API:Add Invoice Payment

From WHMCS Documentation

Jump to: navigation, search

This command is used to add a payment to an invoice.

Attributes

invoiceid - should contact the ID number of the invoice to add the payment to
transid - should contain the transaction number for the payment
amount - should contact the amount paid, can be left blank to take full amount of invoice
fees - optional, if set defines how much fees were involved in the transaction
gateway - should contain the gateway used in system name format, eg. banktransfer or paypalinvoices
noemail - set to true to not send an email if the payment marks the invoice paid
date - optional, if set defines the date the payment was made

Example Command

$postfields["action"] = "addinvoicepayment";
$postfields["invoiceid"] = "1";
$postfields["transid"] = "TEST-123456";
$postfields["amount"] = "40";
$postfields["gateway"] = "mailin";

Returned Variables

None

About the API System · Example API Usage · API Functions

API Functions
Add Client - Update Client - Delete Client - Get Clients - Get Clients Details - Get Clients Products - Get Clients Password - Send Email
Get Support Departments - Get Support Statuses - Get Tickets - Get Ticket - Get Ticket Predefined Cats - Get Ticket Predefined Replies
Open Ticket - Reply Ticket - Add Ticket Note - Delete Ticket
Module Create - Module Suspend - Module Unsuspend - Module Terminate
Create Quote - Update Quote - Delete Quote - Send Quote - Accept Quote
Get Orders - Get Order Statuses - Add Order - Accept Order - Pending Order - Cancel Order - Fraud Order - Delete Order
Get Invoice - Get Payment Methods - Create Invoice - Add Billable Item - Add Invoice Payment
Add Transaction - Add Credit - Capture Payment
Domain WHOIS Lookup - Get Activity Log - Get Admin Details - Update Admin Notes - Get Currencies - Get Email Templates
Get To-Do Items - Get To-Do Item Statuses - Get Staff Online - Get Stats - Encrypt Password - Decrypt Password