Cost Periods

Create a cost period

post/cost-periods

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/cost-periods
  • Auth: HTTP bearer

Request body

startstring date required

The start date for the period. Will be in the form YYYY-MM-DD.

memberIdstring required

The unique identifier of the member this cost period applies to.

currencystring

The currency code for the cost period. Defaults to the workspace currency if not supplied.

costMethodId'hourly' | 'fixed_hourly' | 'fixed_monthly'

The cost method used for this period. One of hourly, fixed_hourly, or fixed_monthly.

costPerHournumber nullable

The labor cost per hour.

overheadCostPerHournumber nullable

The overhead cost per hour.

costPerMonthnumber nullable

The labor cost per month.

overheadCostPerMonthnumber nullable

The overhead cost per month.

Response

200

idstring

The unique identifier for the object.

isDefaultboolean

Whether this is the default cost period for the member.

startstring date

The start date for the period. Will be in the form YYYY-MM-DD.

endstring date nullable

The end date for the period. Will be in the form YYYY-MM-DD. null if this is the most recent period.

currencystring

The currency code for the cost period.

costMethodId'hourly' | 'fixed_hourly' | 'fixed_monthly'

The cost method used for this period.

costPerHournumber nullable

The labor cost per hour. null when costMethodId is fixed_monthly.

overheadCostPerHournumber nullable

The overhead cost per hour. null when costMethodId is fixed_monthly.

totalCostPerHournumber nullable

The sum of costPerHour and overheadCostPerHour. null when costMethodId is fixed_monthly.

costPerMonthnumber nullable

The labor cost per month. null when costMethodId is hourly or fixed_hourly.

overheadCostPerMonthnumber nullable

The overhead cost per month. null when costMethodId is hourly or fixed_hourly.

totalCostPerMonthnumber nullable

The sum of costPerMonth and overheadCostPerMonth. null when costMethodId is hourly or fixed_hourly.

createdAtstring date-time

The timestamp when the object was created.

Changes

No recorded changes to this operation across all 1 revision of this API.