Body Required

• id integer

  Entity ID. If negative value, a new entity will be created

• contactId integer

  Client contact ID

• orderId string

  Internal order number / code

• name string

  Order name

• description string

  Order description

• parentOrderId integer

  Parent order ID. Send -1 to indicate no parent

• department integer

  Business unit (department) ID

• vatRateId integer

  VAT rate ID. Send null or -1 for no VAT

• currencyId integer

  Currency ID

• requestedPaymentTerms string

  Requested payment terms in days

• orderValidity string

  Order validity in days

• minimumAmountToInvoice string

  Minimum invoiceable amount as string

• ourContactId integer

  Our contact ID

• yourContactId integer

  Your contact ID (client's internal contact)

• isTimesheetsEnabled boolean

  Whether timesheets are enabled for this order

• timesheetsAccountId integer

  Timesheets chart of accounts ID

• fixedAmount string

  Fixed amount for TIMESHEET_FIXED type

• timesheetsVatRateId integer

  VAT rate ID for fixed timesheets

• timesheetsVat string

  VAT amount for fixed timesheets

• timesheetsTotalPrice string

  Total price for fixed timesheets

• timesheetsDescription string

  Description for timesheet element

• timesheetsLongDescription string

  Long description for timesheet element

• timesheetsDiscount number

  Discount for timesheet element as BigDecimal

• timesheetsDepartmentId integer

  Department ID for timesheet element

• timesheetsOfficeId integer

  Office ID for timesheet element

• isExpensesEnabled boolean

  Whether expenses are enabled for this order

• isDisbursementFeeEnabled boolean

  Whether disbursement fee is enabled

• disbursementDepartmentId integer

  Department ID for disbursement element

• disbursementOfficeId integer

  Office ID for disbursement element

• expensesDepartmentId integer

  Department ID for expenses element

• expensesOfficeId integer

  Office ID for expenses element

• office integer

  Primary office ID

• clientAddressId integer

  Client address ID for delivery

• address object

  Delivery address for an order

  Hide address attributes Show address attributes object

  • id integer

    Entity ID. If negative value, a new entity will be created

  • name string

    Address label / name

  • line1 string

    Address line 1

  • line2 string

    Address line 2

  • city string

    City

  • region object

    Region

    Hide region attribute Show region attribute object

    • id integer

      Region ID

  • countryCode2 string

    ISO 3166-1 alpha-2 country code

  • countryId integer

    Country ID

  • postCode string

    Postal code

  • houseNumber string

    House number

  • toTheAttentionOf string

    To the attention of

  • position integer(int32)

    Position order

  • service string

    Service label

• validated boolean

  Whether the order is validated

• paymentAccountId integer

  Payment chart of accounts ID

• validatorUserIdsSize integer

  Validator user IDs size

• validatorUserIds array[integer(int32)]

  Validator user IDs array

• systemValidated boolean

  Whether validated by the system

• hasProformaInvoice boolean

  Whether there is a proforma invoice

• warnings string

  JSON-stringified warnings map. Send null to clear

• organizationId integer

  Organization ID

• yourReference string

  Your reference string

• clientName string

  Client name (for display in context without a separate lookup)

• periodicityConfiguration object

  Periodicity configuration for recurring orders

  Hide periodicityConfiguration attributes Show periodicityConfiguration attributes object

  • id integer

    Entity ID. If negative value, a new entity will be created

  • startDate string

    Start date (format dd/MM/yyyy)

  • endDate string

    End date (format dd/MM/yyyy)

  • periodicityType string Required

    Periodicity type. NONE disables recurring invoicing

    Values are NONE, DAILY, WEEKLY, BI_WEEKLY, EVERY_MONTH, EVERY_2_MONTH, EVERY_3_MONTH, EVERY_4_MONTH, EVERY_6_MONTH, or ANNUAL.

  • dayOfWeek string

    Day of week the invoice is generated on, when applicable

    Values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY.

  • invoicingTime string

    When during the period the invoice is generated

    Values are FIRST_DAY, LAST_DAY, FIRST_WORKING_DAY, or LAST_WORKING_DAY.

  • orderId integer

    Order ID this periodicity belongs to

• communicationEmail string

  Communication email for this order

• orderEmail string

  Order email address

• includedArticles array[object]

  Article line within an order (includedArticles)

  Hide includedArticles attributes Show includedArticles attributes object

  Article line within an order (includedArticles)

  • id integer

    Entity ID. If negative value, a new entity will be created

  • tempId integer

    Temporary negative ID used when this article is new. Must match id if id < 0

  • orderId integer

    Order ID this article belongs to

  • articleId integer

    Article ID

  • description string

    Description override

  • longDescription string

    Long description

  • price string

    Unit price as string

  • amount string

    Quantity as string

  • discount string

    Discount percentage as string. Defaults to 0

  • totalNet string

    Net total as string

  • vatRateId integer

    VAT rate ID. Send null or -1 for no VAT

  • vat string

    VAT amount as string

  • totalPrice string

    Total price including VAT as string

  • shipments array[object]

    Shipment records for this article line

    Hide shipments attributes Show shipments attributes object

    • id integer

      Entity ID. If negative value, a new entity will be created

    • shipmentDate string

      Shipment date (format dd/MM/yyyy)

    • articleId integer

      Article ID

    • quantity string

      Quantity as string

    • totalCost number

      Total cost

    • generatedStockMovementId integer

      ID of the stock movement generated for this shipment

    • officeId integer

      Office ID

    • orderArticleId integer

      Order article ID this shipment belongs to

    • salesInvoiceLineId integer

      Sales invoice line ID this shipment was billed through

  • departmentId integer

    Department ID

  • officeId integer

    Office ID

• orderLines array[object]

  Free-text line within an order (orderLines)

  Hide orderLines attributes Show orderLines attributes object

  Free-text line within an order (orderLines)

  • id integer

    Entity ID. If negative value, a new entity will be created

  • tempId integer

    Temporary negative ID used when this line is new. Must match id if id < 0

  • orderId integer

    Order ID this line belongs to

  • description string

    Line description

  • longDescription string

    Long description

  • saleAccountId integer

    Chart of accounts (sale account) ID

  • price string

    Unit price as string

  • amount string

    Quantity as string

  • discount string

    Discount percentage as string. Defaults to 0

  • totalNet string

    Net total as string

  • vatRateId integer

    VAT rate ID. Send null or -1 for no VAT

  • vat string

    VAT amount as string

  • totalPrice string

    Total price including VAT as string

  • departmentId integer

    Department ID

  • officeId integer

    Office ID

• orderElementsLayoutLines array[object]

  Layout line for ordering/grouping order elements and tasks. Recursive structure: children have the same shape. Used for both orderElementsLayoutLines and tasks.

  Hide orderElementsLayoutLines attributes Show orderElementsLayoutLines attributes object

  Layout line for ordering/grouping order elements and tasks. Recursive structure: children have the same shape. Used for both orderElementsLayoutLines and tasks.

  • id integer

    Entity ID. If negative value, a new entity will be created

  • name string

    Display name of the group or section

  • parentId integer

    Parent layout line ID

  • position integer(int32)

    Position among siblings

  • lineType string

    Line type

    Values are ARTICLE, ORDER_LINE, TIMESHEET, TIMESHEET_FIXED, EXPENSES, DISBURSEMENT, or HEADER.

  • orderElementId integer

    ID of the order element (article or line) this layout entry refers to

  • children array

    Child layout lines (recursive)

• tasks array[object]

  Task within an order's timesheet task tree (recursive)

  Hide tasks attributes Show tasks attributes object

  Task within an order's timesheet task tree (recursive)

  • id integer

    Entity ID. If negative value, a new entity will be created

  • name string Required

    Task name

  • rate number

    Hourly rate

  • parentId integer

    Parent task ID

  • position integer(int32)

    Position among siblings

  • children array

    Child tasks (recursive)

  • archived boolean

    Whether the task is archived