Returns a list of milestones.

GET /psa/milestones

Group: PSA › Milestones · Operation ID: milestones

The psaProjectId, invoiceId, productId and productLineId on a milestone are numeric package-layer keys, not the UUIDs the public GET endpoints take, so none of them can be followed over this API. Milestones cannot be matched by name or description.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
dueDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
billable — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
psaProjectId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, name, status, currency, dueDate, psaProjectId, lastModifiedDate
Selectable: id, name, description, amount, currency, dueDate, status, billable, psaProjectId, invoiceId, productId, productLineId, lastModifiedDate

Response

200 Success

Under data, an array of milestonesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the milestone.
`name`	string or null	no	The display name of the milestone.
`description`	string or null	no	A free-form description of the milestone.
`amount`	string (decimal) or null	no	The milestone amount, in the currency given by currency.
`currency`	string or null	no	The currency of amount. Format ISO 4217, for example 'USD'.
`dueDate`	string (date) or null	no	The date the milestone is due for completion. Format YYYY-MM-DD.
`status`	string or null	no	The status of the milestone. Possible values: 'pending', 'accomplished', 'invoiced'.
`billable`	boolean or null	no	Whether the milestone is billable to a customer.
`psaProjectId`	number	no	The id of the PSA project this milestone belongs to. It is a numeric package-layer key, not the UUID that GET psa/projects/:id takes.
`invoiceId`	number or null	no	The id of the invoice this milestone has been billed on. Absent when the milestone has not been invoiced. It is a numeric package-layer key, not the UUID that GET accounting/invoices/:id takes.
`productId`	number or null	no	The id of the product this milestone is associated with. It is a numeric package-layer key, not the UUID that GET accounting/products/:id takes.
`productLineId`	number or null	no	The id of the product line this milestone is associated with. It is a numeric package-layer key, not the UUID that GET accounting/product-lines/:id takes.
`lastModifiedDate`	string (date-time) or null	no	The date and time the milestone record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error