Intervals API Resource:

invoicenote

The base URL for this resource is located at
https://api.myintervals.com/invoicenote/

Collection

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager

Allowed Filters
Filter Name	Required?	Expects	Default	Description
invoiceid	yes	integer		Limits the list to invoice notes belonging to the invoice with the ID passed.
authorid	no	integer		Limits the list to invoice notes created by the person with the ID passed.
offset	no	integer		Return invoicenotes starting from the nth invoicenote.
limit	no	integer	10	Sets a limit to the amount of invoicenotes returned in the response.

¹ Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
² This field accepts HTML, but certain HTML elements may be stripped out.

Examples

To filter the list based on certain parameters:

GET /invoicenote/?authorid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager
DELETE	Administrator
POST	Administrator, Manager
PUT	Administrator

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
invoiceid	yes	integer
title	yes	string (255)		The title of the note.
note	no	string		The description of the note.
date	no	datetime

string (xxx) indicates a string with a maximum length of xxx characters.

Response Fields

The fields below are returned in GET responses. Boolean values are "t" / "f" strings. Numeric IDs and floats are returned as strings. Nullable fields may be JSON null.

Response Fields
Field Name	Nullable	Description
id	no	Unique identifier for the invoice note
invoiceid	no	ID of the parent invoice
authorid	no	ID of the person who created the note
title	no	Short title or event label (e.g. Invoice Created)
note	yes	Free-form note body (may be empty for system-generated entries)
date	no	When the note was recorded (UTC, YYYY-MM-DD HH:MM:SS)
actions	yes	Rendered HTML summary of actions (e.g. status changes, invoice events)
author	no	Full name of the note author
authorlocalid	no	Author’s person local ID in the Person app

Sample response object. Non-null values are strings in JSON (including IDs, numeric fields, and booleans as "t" / "f"). Nullable fields may be JSON null when absent.

{
    "id": "123456",
    "invoiceid": "123456",
    "authorid": "123456",
    "title": "Example Title",
    "note": "Note text",
    "date": "2026-01-15 14:30:00",
    "actions": "<p>Example text</p>",
    "author": "First Last",
    "authorlocalid": "1"
}

When retrieving a collection (GET /invoicenote/), the response envelope includes: personid (authenticated user's ID), status ("OK"), code (200), listcount (total matching records before limit/offset), and invoicenote (array of result objects). Defaults, no cap on limit, and how to paginate using listcount are described in the API Introduction (Pagination).

Examples

To retrieve one member resource:

GET /invoicenote/{id}/

Assuming no errors, the server will respond with 200 OK and the object requested.

To delete a particular member resource:

DELETE /invoicenote/{id}/

Assuming no errors, the server will respond with 200 OK.

To create a new member resource:

POST /invoicenote/

{
    "invoiceid": value,
    "title": value
}

Assuming no errors, the server will respond with 201 Created and the newly-created element. This will allow you to get the id of the item you just created and verify the field values. Note: Only required fields were listed here. The entire list of possible fields is above.

To update a member resource:

PUT /invoicenote/{id}/

{
    "note": value,
    "date": value
}

Assuming no errors, the server will respond with 202 Accepted and the entire element. This will allow you to verify the field values.

Documentation

Resources

API Support

Looking for help?
Contact our support team.

OpenAPI

OpenAPI JSON spec (public)

Swagger UI on SwaggerHub

Start tracking time today

Join 5,000+ companies spending their time wisely with Intervals.

Try Intervals free