Sign in
FixedAmount

Updates an existing fixed-amount billing entry. Only fields listed in the FieldsToUpdate array will be modified. Valid field names: Amount, InventoryItemIDFK, Notes.

Fixed amounts that have already been invoiced cannot be updated. Remove the linked invoice line first to release the record. TaskIDFK and ProjectIDFK cannot be changed — to move a fixed amount, delete it and create a new one.

put/api/FixedAmount

Request body

FixedAmountIDinteger

The ID of the fixed amount to update. Must belong to the authenticated account.

FieldsToUpdatestring[]

Names of the fields to apply from this payload. Valid values: Amount, InventoryItemIDFK, Notes. Fields not named here keep their current values.

Amountnumber double

The fixed billing amount, in the currency of the customer the record's project belongs to. Cannot be cleared.

InventoryItemIDFKinteger

The inventory item used for this fixed amount. Must exist in the account. Cannot be cleared.

Notesstring

Additional notes, maximum 255 characters. Naming Notes in FieldsToUpdate with a null value clears it.

Response

Returns the updated fixed-amount entry.

FixedAmountIDinteger

Unique identifier for the fixed amount entry.

ProjectIDFKinteger

The project this fixed amount is linked to.

ProjectTitlestring

Title of the associated project.

ProjectCodestring

Short code of the associated project.

TaskIDFKinteger

The task this fixed amount is linked to, if any.

TaskTitlestring

Title of the associated task.

InventoryItemIDFKinteger

The inventory item used for this fixed amount.

InventoryItemNamestring

Name of the inventory item.

Amountnumber double

The fixed billing amount.

Notesstring

Additional notes on the fixed amount.

isInvoicedboolean

Whether this fixed amount has been included on an invoice.

CustomerIDFKinteger

ID of the customer company the fixed amount's project belongs to.

InvoiceLineItemIDFKinteger

The invoice line item this fixed amount is linked to, if it has been invoiced.

InvoiceIDFKinteger

The invoice (Transaction) the linked line item belongs to. Only populated when includeInvoiceDetails=true.

DateCreatedstring date-time

Date the record was created.

DateUpdatedstring date-time

Date the record was last updated.

UpdatedByUserIDFKinteger

User ID of the last person to update this record.

Changes

Changed in 1 of the 3 revisions of this API.1