Intervals API Resource: payment

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

Collection

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Executive

Allowed Filters
Filter Name	Required?	Expects	Default	Description
clientid	no	integer		Limits the list to payments belonging to the client with the ID passed.
projectid	no	integer		Limits the list to payments belonging to the client with the ID passed.
personid	no	integer1		Limits the list to payments posted by the persons with the ID passed.
date	no	date		Limits the list to payments having the date passed.
typeid	no	integer		Limits the list to payments having the payment type of the ID passed. For more information, see the paymenttype resource.
invoiceid	no	integer		Limits the list to payments belonging to the invoice with the ID passed.
sortfield	no	string		Sort the list by any of the following fields: id, projectid, date, amount, typeid, reference, note, invoiceid, type, project, and client.
sortdir	no	string		Sets the sort direction of the returned list. Must be either "ASC" or "DESC".
offset	no	integer		Return payments starting from the nth payment.
limit	no	integer	10	Sets a limit to the amount of invoices 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 retrieve the entire list of this resource:

GET /payment/

To filter the list based on certain parameters:

GET /payment/?sortdir={value}

Note: You can string together multiple filters.

Member

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

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
projectid	yes	integer
date	yes	date
amount	yes	double
typeid	yes	integer
reference	no	string (35)		If the payment type is of type Other, a descriptor for that can be stored here.
note	no	string (255)		A description for the payment.
invoiceid	no	integer

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

Examples

To retrieve one member resource:

GET /payment/{id}/

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

To delete a particular member resource:

DELETE /payment/{id}/

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

To create a new member resource:

POST /payment/

{
    "projectid": value,
    "date": value,
    "amount": value,
    "typeid": 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 /payment/{id}/

{
    "amount": value,
    "reference": value
}

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