Returns the fixed fee with the given identifier.
GET /psa/fixed-fees/{id}
Group: PSA › Fixed Fees · Operation ID: getFixedFee
The amount and its currency are the two halves of one stored value. They are present together or absent together, and neither is meaningful alone.
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 fixed fee to return. |
Response
200 Success
Under data (getFixedFeeOutput):
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | The unique identifier for the fixed fee. |
amount |
string (decimal) | no | The fixed fee amount, in the currency given by currency. |
currency |
string | no | The currency of amount. Format ISO 4217, for example 'USD'. |
frequency |
string | no | The billing frequency of the fixed fee. Possible values: 'Monthly', 'BiMonthly', 'Quarterly', 'SemiAnnually', 'Annually', 'Once'. |
startDate |
string (date) | no | The first day of the fixed fee's billing period, inclusive. Format YYYY-MM-DD. |
endDate |
string (date) | no | The last day of the fixed fee's billing period, inclusive. Format YYYY-MM-DD. |
psaProjectId |
number | yes | The id of the PSA project this fixed fee belongs to. It is a numeric package-layer key, not the UUID that GET psa/projects/:id takes. |
salesOrderProductLineId |
number | no | The id of the sales order product line this fixed fee fulfills. It is a numeric package-layer key. There is no endpoint for it. |
productId |
number | no | The id of the product this fixed fee 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 fixed fee 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 fixed fee record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Errors
| Code | Status |
|---|---|
NOT_FOUND |
400 |
Statuses
400— Invalid request or business failure. Codes: NOT_FOUND401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error