API:Get Invoice

From WHMCS Documentation

Jump to: navigation, search

This command is used to obtain an invoice for a client.

Attributes

invoiceid - should be the invoice id you wish to retrieve


Example Command

$postfields["action"] = "getinvoice";
$postfields["invoiceid"] = "1";

Returned Variables

This function will always return an XML response

<whmcsapi> 
 <action>getinvoice</action> 
 <result>success</result> 
 <invoiceid>1</invoiceid> 
 <invoicenum></invoicenum> 
 <userid>1</userid> 
 <date>2009-09-01</date> 
 <duedate>2009-08-04</duedate> 
 <datepaid>2009-09-14 13:21:39</datepaid> 
 <subtotal>10.00</subtotal> 
 <credit>0.00</credit> 
 <tax>0.00</tax> 
 <tax2>0.00</tax2> 
 <total>10.00</total> 
 <taxrate>0.00</taxrate> 
 <taxrate2>0.00</taxrate2> 
 <status>Paid</status> 
 <paymentmethod>offlinecc</paymentmethod> 
 <notes><![CDATA[]]></notes> 
 <items> 
  <item> 
   <id>1</id> 
   <type>Domain</type> 
   <relid>1</relid> 
   <description>Domain Registration - whmcstesting.com - 1 Year/s</description> 
   <amount>10.00</amount> 
   <taxed>1</taxed> 
  </item> 
 </items> 
</whmcsapi>

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