Returns a list of fixed fees.
GET /psa/fixed-fees
Group: PSA › Fixed Fees · Operation ID: fixedFees
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. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likecurrency— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likefrequency— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likestartDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeendDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likepsaProjectId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, frequency, currency, startDate, endDate, psaProjectId, lastModifiedDate
- Selectable: id, amount, currency, frequency, startDate, endDate, psaProjectId, salesOrderProductLineId, productId, productLineId, lastModifiedDate
Response
200 Success
Under data, an array of fixedFeesRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | The unique identifier for the fixed fee. |
amount |
string (decimal) or null | no | The fixed fee amount, in the currency given by currency. |
currency |
string or null | no | The currency of amount. Format ISO 4217, for example 'USD'. |
frequency |
string or null | no | The billing frequency of the fixed fee. Possible values: 'Monthly', 'BiMonthly', 'Quarterly', 'SemiAnnually', 'Annually', 'Once'. |
startDate |
string (date) or null | no | The first day of the fixed fee's billing period, inclusive. Format YYYY-MM-DD. |
endDate |
string (date) or null | no | The last day of the fixed fee's billing period, inclusive. Format YYYY-MM-DD. |
psaProjectId |
number | no | 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 or null | 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 or null | 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 or null | 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) or null | no | The date and time the fixed fee record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error