API - Subscriptions - Abonnementen
List subscriptions
Resource:
/acumulus/stable/picklists/picklist_subscriptions.php
Since API:
Available for authenticated:
API gebruiker
Available for authenticated:
API beheerder
Communication:
Support voor filter :
see: Basic submit
Support voor rowcount :
see: Basic submit
Support voor offset :
see: Basic submit
Support voor inodes :
see: Basic submit
Submit structure
<?xml version="1.0" encoding="UTF-8"?> <myxml> ... <contactid></contactid> <productid></productid> </myxml>
contactid
Optional numeric identifier for contactid to limit output.
productid
Optional numeric identifier for productid to limit output.
Response
<?xml version="1.0" encoding="UTF-8"?> <response> <subscriptions> <subscription> <id></id> <statusid></statusid> <contactid></contactid> <costcenterid></costcenterid> <invoicetemplateid></invoicetemplateid> <bankaccountid></bankaccountid> <productid></productid> <productamount></productamount> <productprice></productprice> <productpricedefault></productpricedefault> <productsuffix></productsuffix> <periodremark></periodremark> <invoicevattype></invoicevattype> <paymentstatus></paymentstatus> <startdate></startdate> <enddate></enddate> <cyclemonths></cyclemonths> <cycleoffsetcreationmonths></cycleoffsetcreationmonths> <sendmail></sendmail> <entries> <entry> <entryid></entryid> <log> <startdate></startdate> <enddate></enddate> <cyclemonths></cyclemonths> <cycleoffsetcreationmonths></cycleoffsetcreationmonths> </log> </entry> </entries> </subscription> </subscriptions> <subscription> ... </subscription> </response>
id
Unique numeric identifier.
statusid
Option
Status
0
Not active
1
Active
contactid
costcenterid
invoicetemplateid
bankaccountid
productid
productamount
productprice
productpricedefault
Option
Meaning
0
Supplied price from subscription applies
1
Default (current) price from product is applied
productsuffix
Appended information about the product. I.e. detailed specification or variant of a base product.
periodremark
Additional information about the product allowing automatically translated code-tags (see subscription manage API).
invoicevattype
paymentstatus
Option
Status
1
Not paid (default)
2
Paid
startdate
enddate
cyclemonths
cycleoffsetcreationmonths
sendmail
Option
Meaning
0
No email is automatically send.
1
Automatically send invoice when applicable..
entries
Subsection when subscription has historically been used to generate entries. Contains entryid and rules which were applied at the time of generation.