Settings

Try out for free

View set­tings

GET /api/settings
<?xml version="1.0" encoding="UTF-8"?>
<settings>
    <invoice_intro>...</invoice_intro>
    <invoice_note>...</invoice_note>
    <offer_intro>...</offer_intro>
    <offer_note>...</offer_note>
    <invoice_email_subject>...</invoice_email_subject>
    <invoice_email_body>...</invoice_email_body>
    <offer_email_subject>...</offer_email_subject>
    <offer_email_body>...</offer_email_body>
    <article_number_pre>ART</article_number_pre>
    <client_number_pre>KD</client_number_pre>
    <invoice_number_pre>RE</invoice_number_pre>
    <offer_number_pre>AN</offer_number_pre>
    <article_number_length type="integer">4</article_number_length>
    <client_number_length type="integer">5</client_number_length>
    <invoice_number_length type="integer">8</invoice_number_length>
    <offer_number_length type="integer">0</offer_number_length>
    <currency_code>EUR</currency_code>
    <discount_rate type="float">2.0</discount_rate>
    <discount_days type="integer">14</discount_days>
    <due_days type="integer">30</due_days>
    <offer_validity_days type="integer">2010-10-07</offer_validity_days>
</settings>

Edit set­tings

PUT /api/settings

Updates the set­tings with the given parameters.

XML ele­ment Descrip­tion Type
invoice_intro Intro­duc­tory text of an invoice ALNUM
invoice_note Expla­natory notes of an invoice ALNUM
offer_intro Intro­duc­tory text of an offer ALNUM
offer_note Expla­natory notes of an offer ALNUM
confirmation_intro Intro­duc­tory text of a confirmation ALNUM
confirmation_note Expla­natory notes of a confirmation ALNUM
delivery_note_intro Intro­duc­tory text of a deli­very note ALNUM
delivery_note_note Expla­natory notes of an deli­very note ALNUM
credit_note_intro Intro­duc­tory text of a credit note ALNUM
credit_note_note Expla­natory notes of an credit note ALNUM
invoice_email_subject Sub­ject of an invoice e-mail ALNUM
invoice_email_body Text of an invoice e-mail ALNUM
offer_email_subject Sub­ject of an offer e-mail ALNUM
offer_email_body Text of an offer e-mail ALNUM
confirmation_email_subject Sub­ject of a con­fir­ma­tion e-mail ALNUM
confirmation_email_body Sub­ject of a con­fir­ma­tion e-mail ALNUM
delivery_note_email_subject Sub­ject of a deli­very note e-mail ALNUM
delivery_note_email_body Sub­ject of a deli­very note e-mail ALNUM
credit_note_email_subject Sub­ject of a credit note e-mail ALNUM
credit_note_email_body Sub­ject of a credit note e-mail ALNUM
reminder_email_subject Sub­ject of a remin­der e-mail ALNUM
reminder_email_body Sub­ject of a remin­der e-mail ALNUM
article_number_pre Pre­fix of an arti­cle number ALNUM
client_number_pre Pre­fix of a cli­ent number ALNUM
invoice_number_pre Pre­fix of an invoice num­ber ALNUM
offer_number_pre Pre­fix of an esti­mate number ALNUM
confirmation_number_pre Pre­fix of a con­fir­ma­tion ALNUM
delivery_note_number_pre Pre­fix of a deli­very note ALNUM
credit_note_number_pre Pre­fix of a credit note ALNUM
offer_number_length Mini­mum length of offer num­bers (to be fil­led with lea­ding zeros) INT
invoice_number_length Mini­mum length of invoice num­bers (to be fil­led with lea­ding zeros) INT
article_number_length Mini­mum length of arti­cle num­bers (to be fil­led with lea­ding zeros) INT
client_number_length Mini­mum length of cli­ent num­bers (to be fil­led with lea­ding zeros) INT
confirmation_number_length Mini­mum length of con­fir­ma­tion num­bers (to be fil­led with lea­ding zeros) INT
delivery_note_number_length Mini­mum length of deli­very note num­bers (to be fil­led with lea­ding zeros) INT
credit_note_number_length Mini­mum length of credit note num­bers (to be fil­led with lea­ding zeros) INT
currency_code Default cur­rency of the account ISO cur­rency code
discount_rate Cash dis­count in percent FLOAT
discount_days Dis­count period in days from invoice date INT
due_days Matu­rity in days from invoice date INT
offer_validity_days Vali­dity of offers in days INT

Please note: If the default cur­rency will be chan­ged, pos­si­bly some of the invoice and offers cur­rency exch­ange rates (quote) become inva­lid. It must the­re­fore be taken to ensure that the cour­ses will be updated.

<settings>
    <invoice_intro>
        Dear [Client.salutation] [Client.first_name] [Client.last_name]...
    </invoice_intro>
</settings>