ACCOUNTING MarkAffiliateBillAsReceived 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"
Resource/WSDL Page:
http://<your_domain_here>/api/1/accounting.asmx?op=MarkAffiliateBillAsReceived
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 use the ExportAffiliateBills API Example Values: 345 |
| invoice_number Required Type: STRING Length (Max/Min): 50 | NULL to erase it, empty string to skip it Example Values: |
| invoiced_amount Required Type: DECIMAL Length (Max/Min): NA | Example Values: 20.01 |
| date_invoice_received Required Type: DATETIME Length (Max/Min): NA | Allowed Formats: "YYYY-mm-dd", "dd-mm-YYYY" Example Values: 2014-06-01 |
| date_invoice_received_modification_type Required Type: MODIFICATION_TYPE Length (Max/Min): NA | Use 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: |
**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
Sample XML Response:
<mark_affiliate_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>
</mark_affiliate_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 |
| Bills processed by Tipalti may not be updated | Tipalti bills cannot be updated with the API |