GET /api/free-texts
<?xml version="1.0" encoding="UTF-8"?> <free-texts type="array" page="1" per_page="100" total="2"> <free-text> ... </free-text> <free-text> ... </free-text> </free-texts>
GET /api/free-texts/{id}
<?xml version="1.0" encoding="UTF-8"?> <free-text> <id type="integer">7</id> <name>Template 1</name> <type>INVOICE</type> <title>Invoice [Invoice.invoice_number]</title> <label></label> <intro>We hereby provide you with the following items into account.</intro> <note>Please transfer the invoice amount to [Invoice.due_date] to our account.</note> <is_default type="integer">1</is_default> </free-text>
POST /api/free-texts
XML element | Description | Type | Default value | Mandatory |
---|---|---|---|---|
name | Name of the free text | ALNUM | yes | |
type | Document type | ALNUM (“INVOICE”, “CORRECTION”, “OFFER”, “CONFIRMATION”, “CREDIT_NOTE”, “DELIVERY_NOTE”, “LETTER”) | yes | |
title | Title / subject | ALNUM | ||
label | Name | ALNUM | ||
intro | Introductory text / letter text | ALNUM | ||
note | Explanatory notes | ALNUM | ||
is_default | Specifies whether this is the default free text (1=yes, 0=no) | BOOL | no |
<free-text> <name>Template 1</name> <type>INVOICE</type> <title>Invoice [Invoice.invoice_number]</title> <label></label> <intro>We hereby provide you with the following items into account.</intro> <note>Please transfer the invoice amount to [Invoice.due_date] to our account.</note> <is_default>1</is_default> </free-text>
<?xml version="1.0" encoding="UTF-8"?> <free-text> <id type="integer">7</id> <name>Template 1</name> <type>INVOICE</type> <title>Invoice [Invoice.invoice_number]</title> <label></label> <intro>We hereby provide you with the following items into account.</intro> <note>Please transfer the invoice amount to [Invoice.due_date] to our account.</note> <is_default type="integer">1</is_default> </free-text>
PUT /api/free-texts/{id}
<free-text> <name>Template 2</name> <type>INVOICE</type> <label>My invoice</label> <is_default>0</is_default> </free-text>
DELETE /api/free-texts/{id}