Project Prepayments

Create a project prepayment

post/project-prepayments

Request

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

Request body

type'services' | 'expenses' | 'products' | 'other_items' required

The category of fees this prepayment is applied against.

datestring date required

The date of the prepayment. Must be in the form YYYY-MM-DD.

detailsstring required

A description of the prepayment (max 255 chars).

quantitynumber nullable

The quantity for calculating the fee. Required when rate is provided.

ratenumber nullable

The rate for calculating the fee. Required when quantity is provided.

feenumber

The total prepaid amount. Required when quantity and rate are not provided.

projectIdstring required

The project ID (uuid) for this prepayment.

invoiceItemIdstring required

The invoice item ID (uuid) for this prepayment. All prepayments of the same type on a project must use the same invoice item.

Response

200

idstring

The unique identifier for the object.

type'services' | 'expenses' | 'products' | 'other_items'

The category of fees this prepayment is applied against.

datestring date

The date of the prepayment. Will be in the form YYYY-MM-DD.

detailsstring

A description of the prepayment.

quantitynumber nullable

The quantity used to calculate the fee. null when the fee was entered directly.

ratenumber nullable

The rate used to calculate the fee. null when the fee was entered directly.

feenumber

The total prepaid amount available to offset future fees.

createdAtstring date-time

The timestamp when the object was created.

amountUsednumber

The portion of the fee already consumed to offset fees on issued invoices. This is a calculated value.

invoicedboolean

Whether the prepayment has been added to an invoice.

lockedboolean

Whether the prepayment can no longer be modified because it is on an invoice or has been used to offset fees.

Changes

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