Returns the milestone with the given identifier.

GET /psa/milestones/{id}

Group: PSA › Milestones · Operation ID: getMilestone

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.

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.
id path string yes The unique identifier for the milestone to return.

Response

200 Success

Under data (getMilestoneOutput):

Field Type Required Description
id string yes The unique identifier for the milestone.
name string no The display name of the milestone.
description string no A free-form description of the milestone.
amount string (decimal) no The milestone amount, in the currency given by currency.
currency string no The currency of amount. Format ISO 4217, for example 'USD'.
dueDate string (date) no The date the milestone is due for completion. Format YYYY-MM-DD.
status string no The status of the milestone. Possible values: 'pending', 'accomplished', 'invoiced'.
billable boolean no Whether the milestone is billable to a customer.
psaProjectId number yes 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 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 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 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) yes The date and time the milestone record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses