ACCOUNTING ExportAffiliateBills API Version 1

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

 

Summary:

Returns a list of bills. No message.


Resource/WSDL Page:

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


Parameters

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

Must be a valid API key (existing and not expired)
Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
billing_cycle
Required
Type: BILLING_CYCLE_OPTIONS
Length (Max/Min): NA

Example Values: Must be one of the following: 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"
paid_only
Required
Type: BOOL
Length (Max/Min): NA

Example Values: TRUE
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: 1

 **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/ExportAffiliateBills?api_key=fmpZgYnJyh0jJ6IP9G0bw&billing_cycle=monthly&billing_period_start_date=2014-06-01&billing_period_end_date=2014-07-01&paid_only=TRUE&payment_type_id=0

 

Sample XML Response:

 

Example Error Messages: 

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