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

View
 

Admin Advertiser Invoices API Methods


advertiser_invoices/list

Lists Advertiser Invoices.

 

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

 

// Code

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

 

Parameters:

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

advertiser_invoices/search

Search through Advertiser Invoices.

 

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

 

// Code

admin_advertiser_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.

advertiser_invoices/show

Show data about an Advertiser Invoice.

 

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

 

// Code

admin_advertiser_invoice_show($invoice_id) 

 

Parameters:

  • invoice_id. Required. The invoice ID.

 


advertiser_invoice/create

Create an Advertiser Invoice.

 

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

 

// Code

admin_advertiser_invoice_create($user_id, $advertiser_invoice, $commissions, $fees)

 

Parameters:

  • user_id. Required. An User ID.
  • advertiser_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" ]
  • fees. Required. An array that contains details about the fees that will be added to the invoice amount.  The array looks like ("type" => array("percent", "fixed"), "value" => array(20, 20), "description" => array("description 1", "description 2")

advertiser_invoice/update

Update an Advertiser Invoice.

 

  PUT /users/#{user_id}/advertiser_invoices/#{advertiser_invoice_id}.{json or xml} 

 

// Code

admin_advertiser_invoice_update($user_id, $advertiser_invoice_id, $advertiser_invoice, $fees=null)

 

Parameters:

  • user_id. Required. An User ID.
  • advertiser_invoice_id. Required. An Advertiser Invoice ID.
  • advertiser_invoice. Required. An array that contains ("completed" => (1 or 0))
  • fees. Required. An array that contains details about the fees that will be added to the invoice amount.  The array looks like ("type" => array("percent", "percent"), "value" => array(20, 20), "description" => array("description 1", "description 2")

advertiser_invoice/destroy

Destroy an Advertiser Invoice.

 

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

 

// Code

admin_advertiser_invoice_destroy($user_id, $advertiser_invoice_id) 

 

Parameters:

  • user_id. Required. An User ID.
  • advertiser_invoice_id. Required. An Advertiser Invoice ID.