Sign in
FixedAmount

Creates a new fixed-amount billing entry against a task.

The project is always derived from the task, and the amount is in the currency of the customer the task's project belongs to. Fixed amounts cannot be added to tasks on internal or archived projects. The created record is immediately visible to GET /api/FixedAmount and invoiceable through the invoicing endpoints.

post/api/FixedAmount

Request body

TaskIDFKinteger

The task the fixed amount is added to. Required. Must exist in the authenticated account; the project is always derived from the task. Multiple fixed amounts per task are allowed.

Amountnumber double

The fixed billing amount, in the currency of the customer the task's project belongs to. Required. Rounded to that currency's decimal places.

InventoryItemIDFKinteger

The inventory item used when this fixed amount is invoiced. Required; there is no default.

Notesstring

Plain text notes, maximum 255 characters.

Response

Returns the created 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