Clients and projects

Change or archive a project

View as Markdown

PATCHhttps://paysuitett.com/api/v1/projects/{id}

Changes a project's name, client, description, budget or billing rate, or archives it (`active: false`) and brings it back. Send only what changes. A new client name joins the directory.

Access. Billing access for invoiceName alone. Other fields require a master key. In businesses that allow it, a personal key may assign the client (`client` only) on projects its holder can see.

Path parameters

idstring · uuidrequired
The project's ID.

Body

A JSON object. Every field is optional.

namestring
The new name.
clientstring
The client's name; empty to remove the client.
descriptionstring
A note about the project; empty to clear.
invoiceNamestring
Customer-facing name, trimmed, max 120 characters; null clears it. Billing access required (master or personal owner/accountant, invoices service).
budget_hoursnumber
Budgeted hours; null to clear.
hourly_ratenumber
Billing rate per hour in the project's currency, e.g. 10.5; null to clear.
currencystring
Three-letter currency code, e.g. TTD or USD.
activeboolean
false archives the project (no new time on it, its hours stay); true brings it back.

Response

200 with a JSON body, as in the example.