ACCOUNTING MarkAffiliateBillAsPaid API Version 1

Updated on 2014-05-27
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP


Summary:

Returns "Affiliate Payment Added" if the bills Date Paid value didn't exist, otherwise "Affiliate Payment Updated".


Resource/WSDL Page:

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


Parameters

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

Must be a valid API key (existing and not expired) 
Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
bill_id
Required
Type: INT


Must match existing bill in database

payment_type_id
0 to skip
Type: BYTE



Must match existing payment type in database
invoice_number
Type: STRING

 
verification_code
Type: STRING

 
payment_date
Required
Type: DATE/TIME



Must evaluate to a real date
notes
Type: STRING

 

 **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/MarkAffiliateBillAsPaid?api_key=fmpZgYnJyh0jJ6IP9G0bw&bill_id=1189&payment_type_id=0&invoice_number=0&verification_code=0&payment_date=05-07-2014¬es=note taken

 

Sample XML Response:

<markaffiliatebillsaspaid_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>Affiliate Payment Updated</message>
</markaffiliatebillsaspaid_accounting_response>



Example Error Messages:  

Error Message
Likely Cause
Invalid API Key
API key does not exist or is expired
Billing ID does not exist
bill_id is zero or was unable to find a bill with that ID in the database
Bills processed by Tipalti may not be updated
The specified bill OR the bills Affiliate is using Tipalti
Payment Type ID does not exist
payment_type_id provided does not exist in the database