Note Templates

Invoice note templates are useful when you frequently include the same or similar note in your invoices (payment instructions, tax specific details etc). By default, ActiveCollab will not provide any template:

Response: HTTP 200, application/json (Hide)

GET /invoice-note-templates

Response:

1
[]

You can defined them like this:

Response: HTTP 200, application/json (Hide)

POST /invoice-note-templates

Payload:

1
2
3
4
{
    "name": "Payment instructions",
    "content": "Please make payment to this account: ABC"
}

Response:

1
2
3
4
5
6
7
8
9
10
{
    "single": {
        "id": 1,
        "class": "InvoiceNoteTemplate",
        "url_path": "\/invoice-note-templates\/1",
        "name": "Payment instructions",
        "content": "Please make payment to this account: ABC",
        "is_default": false
    }
}

To update a template, simply send PUT command:

Response: HTTP 200, application/json (Hide)

PUT /invoice-note-templates/1

Payload:

1
2
3
{
    "content": "Please make payment to this account: XYZ"
}

Response:

1
2
3
4
5
6
7
8
9
10
{
    "single": {
        "id": 1,
        "class": "InvoiceNoteTemplate",
        "url_path": "\/invoice-note-templates\/1",
        "name": "Payment instructions",
        "content": "Please make payment to this account: XYZ",
        "is_default": false
    }
}

Default Note Template #

ActiveCollab lets you set up a default note template. Default note template can save you time by automatically adding a note to all your new templates. By default, there is no default note template:

Response: HTTP 404, text/html

GET /invoice-note-templates/default

Response: HTTP 200, application/json (Hide)

PUT /invoice-note-templates/default

Payload:

1
2
3
{
    "invoice_note_template_id": 1
}

Response:

1
2
3
4
5
6
7
8
9
10
{
    "single": {
        "id": 1,
        "class": "InvoiceNoteTemplate",
        "url_path": "\/invoice-note-templates\/1",
        "name": "Payment instructions",
        "content": "Please make payment to this account: XYZ",
        "is_default": true
    }
}

To unset default note template, simply send DELETE request:

Response: HTTP 200, text/html

DELETE /invoice-note-templates/default

Deleting a Note Template #

To delete a note template, send DELETE command to /invoice-note-templates/:invoice_note_template_id:

Response: HTTP 200, text/html

DELETE /invoice-note-templates/1