ACCOUNTING ExportAdvertiserBills API Version 1

Updated on 2014-07-08
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

 

Summary:

Returns a list of advertiser bills.


Resource/WSDL Page:

http://your.domainhere.com/api/1/accounting.asmx?op=ExportAdvertiserBills


Parameters

api_key
Required
Type: STRING
Length (Max/Min): NA

Must be a valid API key (existing and NOT expired) 
Example Values: BETwue0XUuMnZitzyqzddodKbz08h7
billing_cycle
Required
Type: billing_cycle_options
Length (Max/Min): NA

Example Values: Must be Weekly, Bimonthly, Monthly or All 
billing_period_start_date
Required
Type: DATETIME
Length (Max/Min): NA

Example Values: Allowed formats: "YYYY-mm-dd", "dd-mm-YYYY"
billing_period_end_date
Required
Type: DATETIME
Length (Max/Min): NA

Example Values: Allowed formats: "YYYY-mm-dd", "dd-mm-YYYY"

 **Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 


Example Request

GET
http://demo-new.cakemarketing.com/api/1/accounting.asmx/ExportAdvertiserBills?&api_key=fmpZgYnJyh0jJ6IP9G0bw&billing_cycle=monthly&billing_period_start_date=01-01-2017 00:00:00&billing_period_end_date=02-01-2017 00:00:00



Example XML Response

   

<export_advertiser_bills_accounting_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/">
<success>true</success>
<row_count>2</row_count>
<advertiser_bills>
<advertiser_bill>
<bill_id>68</bill_id>
<advertiser>
<advertiser_id>137</advertiser_id>
<advertiser_name>KING</advertiser_name>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<account_managers>
<account_manager>
<contact_id>451</contact_id>
<contact_name>John DaSilva</contact_name>
</account_manager>
</account_managers>
<advertiser_billing>
<contacts>
<contact>
<contact_id>547</contact_id>
<contact_type>Billing</contact_type>
<first_name>Felipe</first_name>
<last_name>Uribe</last_name>
</contact>
</contacts>
<billing_cycle>
<billing_cycle_id xmlns="API:id_name_store">3</billing_cycle_id>
<billing_cycle_name xmlns="API:id_name_store">Monthly</billing_cycle_name>
</billing_cycle>
<address>
<street_1/>
<street_2/>
<city/>
<state/>
<zip_code/>
<country/>
</address>
</advertiser_billing>
</advertiser>
<start_date>2014-06-01T00:00:00</start_date>
<end_date>2014-07-01T00:00:00</end_date>
<bill_amount>
<currency_id>1</currency_id>
<amount>71.0000</amount>
<formatted_amount>$71.00</formatted_amount>
</bill_amount>
<converted_bill_amount>
<currency_id>1</currency_id>
<amount>71.0000</amount>
<formatted_amount>$71.00</formatted_amount>
</converted_bill_amount>
<sent_invoice>true</sent_invoice>
<sent_invoice_info>
<invoice_number>123456</invoice_number>
<date>2014-07-15T06:58:31.257</date>
</sent_invoice_info>
<received_payment>true</received_payment>
<received_payment_info>
<payment_amount>
<currency_id>1</currency_id>
<amount>71.0000</amount>
<formatted_amount>$71.00</formatted_amount>
</payment_amount>
<invoice_number>123456</invoice_number>
<date>2014-07-16T10:35:57.67</date>
</received_payment_info>
<advertiser_bill_line_items>
<advertiser_bill_line_item>
<line_item_id>10813</line_item_id>
<line_item_type>Standard Item</line_item_type>
<offer>
<offer_id xmlns="API:id_name_store">925</offer_id>
<offer_name xmlns="API:id_name_store">Conversion Cap</offer_name>
</offer>
<price_per_action>
<currency_id>1</currency_id>
<amount>1.0000</amount>
<formatted_amount>$1.00</formatted_amount>
</price_per_action>
<paid_actions>1</paid_actions>
<total_amount>
<currency_id>1</currency_id>
<amount>1.0000</amount>
<formatted_amount>$1.00</formatted_amount>
</total_amount>
<offer_total_amount>
<currency_id>1</currency_id>
<amount>1.0000</amount>
<formatted_amount>$1.00</formatted_amount>
</offer_total_amount>
<adjustment_date xsi:nil="true"/>
</advertiser_bill_line_item>
<advertiser_bill_line_item>
<line_item_id>10814</line_item_id>
<line_item_type>Standard Item</line_item_type>
<offer>
<offer_id xmlns="API:id_name_store">927</offer_id>
<offer_name xmlns="API:id_name_store">iojlikj</offer_name>
</offer>
<price_per_action>
<currency_id>1</currency_id>
<amount>10.0000</amount>
<formatted_amount>$10.00</formatted_amount>
</price_per_action>
<paid_actions>7</paid_actions>
<total_amount>
<currency_id>1</currency_id>
<amount>70.0000</amount>
<formatted_amount>$70.00</formatted_amount>
</total_amount>
<offer_total_amount>
<currency_id>1</currency_id>
<amount>70.0000</amount>
<formatted_amount>$70.00</formatted_amount>
</offer_total_amount>
<adjustment_date xsi:nil="true"/>
</advertiser_bill_line_item>
</advertiser_bill_line_items>
</advertiser_bill>
<advertiser_bill>
<bill_id>67</bill_id>
<advertiser>
<advertiser_id>1</advertiser_id>
<advertiser_name>Shopify</advertiser_name>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<account_managers>
<account_manager>
<contact_id>451</contact_id>
<contact_name>John DaSilva</contact_name>
</account_manager>
</account_managers>
<advertiser_billing>
<contacts>
<contact>
<contact_id>1</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Christina</first_name>
<last_name>Du</last_name>
</contact>
<contact>
<contact_id>2</contact_id>
<contact_type>Billing</contact_type>
<first_name>Eric</first_name>
<last_name>Muirhead</last_name>
</contact>
<contact>
<contact_id>14</contact_id>
<contact_type>Billing</contact_type>
<first_name>Brad</first_name>
<last_name>Shumard</last_name>
</contact>
<contact>
<contact_id>15</contact_id>
<contact_type>Tech</contact_type>
<first_name>John</first_name>
<last_name>Dye</last_name>
</contact>
<contact>
<contact_id>16</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Loria</first_name>
<last_name>Sammarco</last_name>
</contact>
<contact>
<contact_id>27</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Ron</first_name>
<last_name>Ward</last_name>
</contact>
<contact>
<contact_id>28</contact_id>
<contact_type>Billing</contact_type>
<first_name>Granville</first_name>
<last_name>Dereu</last_name>
</contact>
<contact>
<contact_id>66</contact_id>
<contact_type>Billing</contact_type>
<first_name>Larita</first_name>
<last_name>Brigges</last_name>
</contact>
<contact>
<contact_id>67</contact_id>
<contact_type>Tech</contact_type>
<first_name>Brittany</first_name>
<last_name>Edmonston</last_name>
</contact>
<contact>
<contact_id>75</contact_id>
<contact_type>Billing (Primary)</contact_type>
<first_name>Cliff</first_name>
<last_name>Heebner</last_name>
</contact>
<contact>
<contact_id>106</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Drew</first_name>
<last_name>Patterson</last_name>
</contact>
<contact>
<contact_id>107</contact_id>
<contact_type>Billing</contact_type>
<first_name>Warren</first_name>
<last_name>Marayag</last_name>
</contact>
<contact>
<contact_id>112</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Jena</first_name>
<last_name>Danzig</last_name>
</contact>
<contact>
<contact_id>143</contact_id>
<contact_type>Tech (Primary)</contact_type>
<first_name>Cedrick</first_name>
<last_name>Nwakanma</last_name>
</contact>
<contact>
<contact_id>148</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Jo</first_name>
<last_name>Eagle</last_name>
</contact>
<contact>
<contact_id>149</contact_id>
<contact_type>Tech (Primary)</contact_type>
<first_name>Agripina</first_name>
<last_name>Dallis</last_name>
</contact>
<contact>
<contact_id>158</contact_id>
<contact_type>Billing (Primary)</contact_type>
<first_name>Matt</first_name>
<last_name>Moltrie</last_name>
</contact>
<contact>
<contact_id>192</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Paul</first_name>
<last_name>Wright</last_name>
</contact>
<contact>
<contact_id>207</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Sample</first_name>
<last_name>User</last_name>
</contact>
<contact>
<contact_id>223</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Rofek</first_name>
<last_name>QA example</last_name>
</contact>
<contact>
<contact_id>228</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Taylor</first_name>
<last_name>Ball</last_name>
</contact>
<contact>
<contact_id>230</contact_id>
<contact_type>Tech</contact_type>
<first_name>Ron</first_name>
<last_name>Torres</last_name>
</contact>
<contact>
<contact_id>236</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Garth</first_name>
<last_name>Harris</last_name>
</contact>
<contact>
<contact_id>237</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Elizabeth</first_name>
<last_name>D'Arcy-potts</last_name>
</contact>
<contact>
<contact_id>243</contact_id>
<contact_type>Tech</contact_type>
<first_name>123</first_name>
<last_name>223</last_name>
</contact>
<contact>
<contact_id>245</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>ads</first_name>
<last_name>sales</last_name>
</contact>
<contact>
<contact_id>255</contact_id>
<contact_type>Tech</contact_type>
<first_name>John</first_name>
<last_name>Smithy</last_name>
</contact>
<contact>
<contact_id>260</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Adam</first_name>
<last_name>Maltais</last_name>
</contact>
<contact>
<contact_id>275</contact_id>
<contact_type>Tech</contact_type>
<first_name>admin</first_name>
<last_name>user</last_name>
</contact>
<contact>
<contact_id>280</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Jeff</first_name>
<last_name>McCollum</last_name>
</contact>
<contact>
<contact_id>287</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Scott</first_name>
<last_name>Manager</last_name>
</contact>
<contact>
<contact_id>296</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Katie</first_name>
<last_name>Ewing</last_name>
</contact>
<contact>
<contact_id>301</contact_id>
<contact_type>Tech</contact_type>
<first_name>Bob</first_name>
<last_name>Chen</last_name>
</contact>
<contact>
<contact_id>302</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Robin</first_name>
<last_name>Ward</last_name>
</contact>
<contact>
<contact_id>321</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>US</first_name>
<last_name>Client Services</last_name>
</contact>
<contact>
<contact_id>322</contact_id>
<contact_type>Tech</contact_type>
<first_name>TEST</first_name>
<last_name>ADMIN</last_name>
</contact>
<contact>
<contact_id>326</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Scott</first_name>
<last_name>Braga</last_name>
</contact>
<contact>
<contact_id>327</contact_id>
<contact_type>Tech</contact_type>
<first_name>Karen</first_name>
<last_name>Nugent</last_name>
</contact>
<contact>
<contact_id>328</contact_id>
<contact_type>Tech</contact_type>
<first_name>Jena</first_name>
<last_name>Danzig</last_name>
</contact>
<contact>
<contact_id>329</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Howard</first_name>
<last_name>Lim</last_name>
</contact>
<contact>
<contact_id>343</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>John</first_name>
<last_name>Smith</last_name>
</contact>
<contact>
<contact_id>351</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Jo</first_name>
<last_name>Eagle</last_name>
</contact>
<contact>
<contact_id>352</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Jordanna</first_name>
<last_name>Eagles</last_name>
</contact>
<contact>
<contact_id>359</contact_id>
<contact_type>Tech</contact_type>
<first_name>Eric</first_name>
<last_name>Muirhead</last_name>
</contact>
<contact>
<contact_id>360</contact_id>
<contact_type>Tech (Primary)</contact_type>
<first_name>Rofek</first_name>
<last_name>S</last_name>
</contact>
<contact>
<contact_id>363</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Kirsten</first_name>
<last_name>Singer</last_name>
</contact>
<contact>
<contact_id>378</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Jena</first_name>
<last_name>Danzig</last_name>
</contact>
<contact>
<contact_id>381</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Ayca</first_name>
<last_name>Miller</last_name>
</contact>
<contact>
<contact_id>382</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Ayca</first_name>
<last_name>Miller</last_name>
</contact>
<contact>
<contact_id>383</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Account</first_name>
<last_name>Manager</last_name>
</contact>
<contact>
<contact_id>384</contact_id>
<contact_type>Tech</contact_type>
<first_name>Eric</first_name>
<last_name>Restricted Contacts</last_name>
</contact>
<contact>
<contact_id>390</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>John The</first_name>
<last_name>New Employee</last_name>
</contact>
<contact>
<contact_id>410</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Nate</first_name>
<last_name>Manchester</last_name>
</contact>
<contact>
<contact_id>420</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Brittany</first_name>
<last_name>Luankaw</last_name>
</contact>
<contact>
<contact_id>421</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Tim</first_name>
<last_name>Hespe</last_name>
</contact>
<contact>
<contact_id>428</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Erik</first_name>
<last_name>Charles</last_name>
</contact>
<contact>
<contact_id>433</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Tina</first_name>
<last_name>Carnow</last_name>
</contact>
<contact>
<contact_id>445</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>ayca</first_name>
<last_name>miller</last_name>
</contact>
<contact>
<contact_id>451</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>John</first_name>
<last_name>DaSilva</last_name>
</contact>
<contact>
<contact_id>467</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Dave</first_name>
<last_name>Downs</last_name>
</contact>
<contact>
<contact_id>474</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>D</first_name>
<last_name>D</last_name>
</contact>
<contact>
<contact_id>477</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Marya</first_name>
<last_name>Stevens</last_name>
</contact>
<contact>
<contact_id>479</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Jo</first_name>
<last_name>Eagle 2</last_name>
</contact>
<contact>
<contact_id>485</contact_id>
<contact_type>Account Manager (Primary)</contact_type>
<first_name>Jordanna</first_name>
<last_name>Beth</last_name>
</contact>
<contact>
<contact_id>494</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Simona</first_name>
<last_name>Turla</last_name>
</contact>
<contact>
<contact_id>497</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Rob</first_name>
<last_name>Gissubel</last_name>
</contact>
<contact>
<contact_id>498</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Britt</first_name>
<last_name>Test</last_name>
</contact>
<contact>
<contact_id>505</contact_id>
<contact_type>Tech</contact_type>
<first_name>Jason</first_name>
<last_name>Kay</last_name>
</contact>
<contact>
<contact_id>514</contact_id>
<contact_type>Tech</contact_type>
<first_name>Octavius</first_name>
<last_name>Ryan</last_name>
</contact>
<contact>
<contact_id>520</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Oleg</first_name>
<last_name>tester</last_name>
</contact>
<contact>
<contact_id>521</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Test</first_name>
<last_name>Shpoopie</last_name>
</contact>
<contact>
<contact_id>522</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Oleg</first_name>
<last_name>Tester</last_name>
</contact>
<contact>
<contact_id>523</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>he</first_name>
<last_name>hree</last_name>
</contact>
<contact>
<contact_id>532</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Sarah</first_name>
<last_name>Hefter</last_name>
</contact>
<contact>
<contact_id>535</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Oleg</first_name>
<last_name>Tester</last_name>
</contact>
<contact>
<contact_id>538</contact_id>
<contact_type>Billing (Primary)</contact_type>
<first_name>John</first_name>
<last_name>Doe</last_name>
</contact>
<contact>
<contact_id>543</contact_id>
<contact_type>Account Manager</contact_type>
<first_name>Matt</first_name>
<last_name>Owens</last_name>
</contact>
</contacts>
<billing_cycle>
<billing_cycle_id xmlns="API:id_name_store">3</billing_cycle_id>
<billing_cycle_name xmlns="API:id_name_store">Monthly</billing_cycle_name>
</billing_cycle>
<address>
<street_1>2244 West Coast Highway</street_1>
<street_2>STE 250</street_2>
<city>Newport Beach</city>
<state>CA</state>
<zip_code>92663</zip_code>
<country>US</country>
</address>
</advertiser_billing>
</advertiser>
<start_date>2014-06-01T00:00:00</start_date>
<end_date>2014-07-01T00:00:00</end_date>
<bill_amount>
<currency_id>1</currency_id>
<amount>6.9600</amount>
<formatted_amount>$6.96</formatted_amount>
</bill_amount>
<converted_bill_amount>
<currency_id>1</currency_id>
<amount>6.9600</amount>
<formatted_amount>$6.96</formatted_amount>
</converted_bill_amount>
<sent_invoice>true</sent_invoice>
<sent_invoice_info>
<date>2014-07-16T10:35:50.68</date>
</sent_invoice_info>
<received_payment>true</received_payment>
<received_payment_info>
<payment_amount>
<currency_id>1</currency_id>
<amount>6.9600</amount>
<formatted_amount>$6.96</formatted_amount>
</payment_amount>
<date>2014-07-16T10:35:57.67</date>
</received_payment_info>
<advertiser_bill_line_items>
<advertiser_bill_line_item>
<line_item_id>10812</line_item_id>
<line_item_type>Standard Item</line_item_type>
<offer>
<offer_id xmlns="API:id_name_store">56</offer_id>
<offer_name xmlns="API:id_name_store">Radioactive Waste or Beauty Secret?</offer_name>
</offer>
<price_per_action>
<currency_id>1</currency_id>
<amount>3.4800</amount>
<formatted_amount>$3.48</formatted_amount>
</price_per_action>
<paid_actions>2</paid_actions>
<total_amount>
<currency_id>1</currency_id>
<amount>6.9600</amount>
<formatted_amount>$6.96</formatted_amount>
</total_amount>
<offer_total_amount>
<currency_id>1</currency_id>
<amount>6.9600</amount>
<formatted_amount>$6.96</formatted_amount>
</offer_total_amount>
<adjustment_date xsi:nil="true"/>
</advertiser_bill_line_item>
</advertiser_bill_line_items>
</advertiser_bill>
</advertiser_bills>
</export_advertiser_bills_accounting_response>

   


Example Error Messages:

Error Message
Likely Cause
Invalid API Key
API key does not exist or is expired