• 30 Minute Maintenance Window, Midnight Pacific, Sat May 19. Learn more.

View
 

Admin Affiliate Invoices API Methods


affiliate_invoices/list

Lists Affiliate Invoices.

 

  GET /users/all/affiliate_invoices.{json or xml} 

 

// Code

admin_affiliate_invoices_list($page=1, $perpage=15) 

 

Parameters:

  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

affiliate_invoices/search

Search through Affiliate Invoices.

 

  POST /users/all/affiliate_invoices/search.{json or xml} 

 

// Code

admin_affiliate_invoices_search($search=null, $page=1, $perpage=15) 

 

Parameters:

  • search. Optional. Keywords to search for.  
  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

affiliate_invoices/show

Show data about an Affiliate Invoice.

 

  GET /users/all/affiliate_invoices/#{invoice_id}.{json or xml}  

 

// Code

admin_affiliate_invoice_show($invoice_id) 

 

Parameters:

  • invoice_id. Required. The invoice ID.

 


affiliate_invoice/create

Create an Affiliate Invoice.

 

  POST /users/#{user_id}/affiliate_invoices.{json or xml} 

 

// Code

admin_affiliate_invoice_create($user_id, $affiliate_invoice, $commissions, $taxes) 

 

Parameters:

  • user_id. Required. An User ID.
  • affiliate_invoice. Required. An array that contains ("completed" => (1 or 0), "comments" => "comments related to the invoice")
  • commissions. Required. An array that contains a list of commission IDs, eg. [ "105", "107", "108" ]
  • taxes. Required. An array that contains details about the taxes that will be subtracted from the invoice amount.  The array looks like ("type" => array("percent", "percent"), "value" => array(20, 20), "description" => array("description 1", "description 2")

affiliate_invoice/update

Update an Affiliate Invoice.

 

  PUT /users/#{user_id}/affiliate_invoices/#{affiliate_invoice_id}.{json or xml} 

 

// Code

admin_affiliate_invoice_update($user_id, $affiliate_invoice_id, $affiliate_invoice, $taxes=null)

 

Parameters:

  • user_id. Required. An User ID.
  • affiliate_invoice_id. Required. An Affiliate Invoice ID.
  • affiliate_invoice. Required. An array that contains ("completed" => (1 or 0))
  • taxes. Required. An array that contains details about the taxes that will be subtracted from the invoice amount.  The array looks like ("type" => array("percent", "percent"), "value" => array(20, 20), "description" => array("description 1", "description 2")

affiliate_invoice/destroy

Destroy an Affiliate Invoice.

 

  DELETE /users/all/affiliate_invoices.{json or xml} 

 

// Code

admin_affiliate_invoice_destroy($user_id, $affiliate_invoice_id) 

 

Parameters:

  • user_id. Required. An User ID.
  • affiliate_invoice_id. Required. An Affiliate Invoice ID.