Project invoice milestone object

Scheduled invoicing for a fixed fee project. This is only available for projects that have a billing type of "fixed" or "fixed_recurring".

Example

{
  "id": "bb89d30e-9fdd-4fad-bb5a-644ff2026b22",
  "typeId": "recurring",
  "date": "2022-03-01",
  "quantity": 50,
  "rate": 100,
  "fee": 5000,
  "name": "March 2022",
  "invoiced": false,
  "createdAt": "2022-03-18T15:13:03.724Z",
  "project": {
    "id": "095e0780-48bf-472c-8deb-2fc3ebc7d90c",
    "name": "Vendor Portal",
    "client": {
      "id": "4cacdf11-71d1-4fbb-90ee-b091803581b0",
      "name": "Joe's Shop"
    }
  },
  "invoiceItem": {
    "id": "aba04832-216c-463e-8998-c520948f707c",
    "name": "Consulting Services"
  }
}

Attributes

NameTypeDescription
iduuidThe unique identifier for the object.
typeIdstringThe type of the milestone. Can be either "recurring" (Recurring) or "custom" (Custom) depending on how it was generated.
datedateThe date of the milestone. Will be in the form YYYY-MM-DD.
quantitynumberAn optional quantity applied for calculating the fee.
ratenumberAn optional rate applied for calculating the fee.
feenumberThe total amount for the milestone.
namestringThe name of the milestone.
invoicedbooleanFlag to indicate if the milestone has been invoiced.
createdAttimestampThe timestamp when the object was created.
projectobjectA simple object to the related project. See attributes.
invoiceItemobjectA simple object to the related invoice item. See attributes .

Project attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the project.
clientobjectA simple object to the related client. See attributes.

Client attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the client.

Invoice item attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the invoice item.