Get all subscriptions
By using the type it is possible to get only active, cancelled or finished subscriptions
@return
Data Table object
Arguments
Update a subscription
Fields that can be changed:
next_book_date (date) - Date when the next charge should be done.
stop_date (date) -Date when the subscription should stop.
There are various other fields that are managed internally and should not change via the API
Arguments
id |
integer, required |
next_book_date |
date |
stop_date |
date |
next_invoice_date |
date |
Stop a subscription
this will only work if the subscription was in ACTIVE state
Arguments
Reactivate a subscription
this will only work if the subscription was in CANCELLED state
Arguments
Check and create subscription
id - billing document id
_trigger - paymentdate - calling after set-as-paid=1
- invoicedate - calling after is_final=1
Arguments
id |
integer, required |
_trigger |
string, required |
_objBill |
string |
_called_from |
string |
Get one record based on id
Arguments
Arguments
name |
string |
description |
string |
class_name |
string |
method_name |
string |
policy_id |
string, required |
client_id |
string, required |
article_id |
string, required |
Get Change Log for an object
Arguments
Function for adding / editing a record with all the children
@params children is an array of records that has the same rules as add() or set().
@param id is always required - if it is not integer, the child will be added. If it is an integer, the child with the same id will be updated
Ex.:
id => 3 #updates the id 3 of the parent class
.....
children => [
1 => [....]
'new' => [....]
]
This will:
- update the id=3 for the parent class with all the values included,
- it will update the child with id=1
- will add a new child (new)
- if delete is allowed, all other possible children will be removed
@params id - is always required, if it is not integer, the record will be added, else it will be updated
@params id : This method will inset/edit a record with the given id in
SettingsBillingArbPoliciesController
with children in the current class
Missing children in the argument will
NOT be deleted, as the class doesn't accept deleting.
Arguments
id |
integer, required |
comment_id |
integer, required |