ACCOUNTING MarkAdvertiserBillsAsReceived API Version 1

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

 

Summary:

"Bill Successfully Updated" or "Bill Marked As Received". Along with payment_amount and bill_amount 


Resource/WSDL Page:

http://<your_domain_here>/api/1/accounting.asmx?op=MarkAdvertiserBillAsReceived

 

Parameters

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

Must be a valid API key (existing and not expired) 
Example Values: BETwue0XUuMnZitzyqzddodKbz08h7
bill_id
Required
Type: INT
Length (Max/Min): NA 

To retrieve this value please use the ExportAdvertiserBills API
Example Values: 68
payment_amount
Required
Type: DECIMAL
Length (Max/Min): NA

Example Values: 20.01
payment_type_id
Required
Type: BYTE
Length (Max/Min): NA

Passing value of Zero is a wildcard value. You can obtain payment type ID using the following API:GET PaymentTypes API
Example Values: 0
invoice_number
Required
Type: STRING
Length (Max/Min): 50

NULL to erase it, empty string to skip it
Example Values: NULL
verification_code
Required
Type: STRING
Length (Max/Min): 50

NULL to erase it, empty string to skip it
Example Values: NULL
date_payment_received
Required
Type: DATETIME
Length (Max/Min): NA

Acceptable formats: "YYYY-mm-dd", "dd-mm-YYYY"
Example Values: 2014-06-01
date_payment_received_modification_type
Required
Type: MODIFICATION_TYPES
Length (Max/Min): NA

User this to not apply or remove the date
Example Values: do_not_change, change, remove
notes
Required
Type: STRING
Length (Max/Min): 250

NULL to erase it, empty string to skip it
Example Values: NULL

 

**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/MarkAdvertiserBillAsReceived?api_key=fmpZgYnJyh0jJ6IP9G0bw&bill_id=12&payment_amount=20.01&payment_type_id=0&invoice_number=&verification_code=&date_payment_received=2014-06-05&date_payment_received_modification_type=do_not_change&notes=none

 

Sample XML Response:

<mark_advertiser_bill_as_received_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>
<message>Bill Successfully Updated</message>
<payment_amount>
<currency_id>1</currency_id>
<amount>71</amount>
<formatted_amount>$71.00</formatted_amount>
</payment_amount>
<bill_amount>
<currency_id>1</currency_id>
<amount>71.0000</amount>
<formatted_amount>$71.00</formatted_amount>
</bill_amount>
</mark_advertiser_bill_as_received_accounting_response>

 

Example Error Messages: 

Error Message
Likely Cause
Invalid API key
API key does not exist or is expired
Invalid Invoice Number
Length exceeds 50 characters
Invalid Notes
Length exceeds 250 characters
Invalid Bill ID
Bill could not be found using the provided id
Invalid Payment Type ID
Payment ID passed is not valid
Invalid Verification Code
Length exceeds 50 characters