API - Manage Subscription
Add or update subscription
Resource:
/acumulus/stable/subscriptions/subscription_manage.php
Since API:
Available for authenticated:
API gebruiker
Available for authenticated:
API beheerder
Communication:
Basic submit, including below structure
Support voor inodes :
see: Basic submit
Submit
<?xml version="1.0" encoding="UTF-8"?> <myxml> <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> <text></text> <cyclemonths></cyclemonths> <cycleoffsetcreationmonths></cycleoffsetcreationmonths> <sendmail></sendmail> <delete></delete> </subscription> </myxml>
id
Optional unique numeric identifier. Use when updating or ommit when adding subscription.
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.
Tag
Conversion
[123]
123
invoicevattype
paymentstatus
Option
Status
1
Not paid (default)
2
Paid
startdate
enddate
text
Multiline field for extended description of the subscription. Content will appear on invoice and associated emails. Use \n for newlines. When multiple subscriptions are placed on a single document, only unique descriptions will be displayed.
cyclemonths
cycleoffsetcreationmonths
sendmail
Option
Meaning
0
No email is automatically send.
1
Automatically send invoice when applicable..
delete
Option
Meaning
0
Do not delete subscription (default).
1
Remove subscription.
Response
<?xml version="1.0" encoding="UTF-8"?> <response> <subscription> ... <proc></proc> </subscription> </response>
All known xml-nodes available for this endpoint will be returned with their set values. Including below.
proc
Applied method of processing.
Value
Description
added
Subscription added
updated
Subscription updated, even if no changes made
deleted
Subscription deleted.