AutoBill.fetchByVid
Web Session Object
Transaction Object
Token Object
Season Set Object
Refund Object
RatePlan Object
Product Object
Payment Provider Object
Payment Method Object
NameValuePair Object
GiftCard Object
Entitlement Object
Chargeback Object
Campaign Object
BillingPlan Object
AutoBill Object
Address Object
Activity Object
Account Object
AutoBill.fetchByVid
The fetchByVid method returns an AutoBill object whose VID matches the input.
When you create a new AutoBill object with the update() call, CashBox assigns the object a unique ID (VID), which is inside the AutoBill object returned to you by the call. Store this VID locally to use it to retrieve or reference the AutoBill object in later calls.
Input
srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.
Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.
vid: the AutoBill object’s Vindicia identifier, which serves as the search criterion.
Output
return: an object of type Return that indicates the success or failure of the call.
autobill: the AutoBill object whose VID matches the input.
Returns
In addition to those listed in Standard Return Codes, this call returns:
Return Code |
Return String |
400 |
One of the following:
|
404 |
Unable to load autobill by VID input-vid: No match. |
Example
$autobillVid = '8367ae7148d071a4e25c24bef856f68f71ee03e3';
// Create an autobill object
$autobill = new AutoBill();
// now load an autobill into the autobill object by VID
$response = $autobill->fetchByVid($autobillVid);
if($response['returnCode'] == 200) {
$fetchedAutoBill = $response['data']->autobill;
// process fetched autobill here
}
For Users
Learn More