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/?offset={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	date

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

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}/

{
    "title": 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.