Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• id string

  Order ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• name string

  Order name filter

• orderId string

  Internal order number / code filter

• date string

  Order date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• description string

  Order description filter

• contactId string

  Client contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• status string

  Order status filter

  Values are OFFERED, OFFERED_SENT, CONFIRMED, CONFIRMED_SENT, BILLABLE, FINISHED, or CANCELLED.

• isExpensesEnabled boolean

  Whether expenses are enabled for the order

• orderAmount string

  Order amount filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• hasWarnings boolean

  Whether the order has warnings

• validated boolean

  Whether the order is validated

• clientEmail string

  Client email filter

• isInvoiceGenerated boolean

  Whether the order is currently generating an invoice

• isPeriodic boolean

  Whether the order is periodic (recurring)

• isInWorkflow boolean

  Whether the order is currently part of an active workflow

• clientOrderEmail string

  Order email address filter

• hasProformaInvoice boolean

  Whether the order has a proforma invoice

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • name string
  • orderId string
  • date string(date-time)
  • description string
  • contactName string
  • contactId integer(int64)
  • organizationId integer(int64)
  • warnings string
  • status string

    Values are OFFERED, OFFERED_SENT, CONFIRMED, CONFIRMED_SENT, BILLABLE, FINISHED, or CANCELLED.

  • isExpensesEnabled boolean
  • isPrePaymentAvailable boolean
  • isPartialPaymentAvailable boolean
  • orderAmount number
  • creatorContactId integer(int64)
  • hasWarnings boolean
  • validated boolean
  • clientEmail string
  • clientECorrespondence boolean
  • workflowPermissions string
  • isInvoiceGenerated boolean
  • isPeriodic boolean
  • isInWorkflow boolean
  • flagsAmount integer(int32)
  • activeSubOrderId integer(int64)
  • activeSubOrderInvoicingDate string(date-time)
  • systemValidated boolean
  • clientOrderEmail string
  • clientAdvancedInvoicingNote string
  • hasProformaInvoice boolean
  • parentOrderId integer(int64)
  • parentOrderName string
  • departmentId integer(int64)
  • departmentName string
  • officeId integer(int64)
  • officeName string
  • vatRateId integer(int64)
  • vatRateName object
    Hide vatRateName attributes Show vatRateName attributes object

    • en string
    • fr string
    • de string
    • it string
  • requestedPaymentTerms integer(int32)
  • currencyId integer(int64)
  • currency string
  • minimumAmountToInvoice number
  • ourContactName string
  • yourContactName string
  • periodicityStartDate string(date-time)
  • periodicityType string

    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

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

  • invoicingTime string

    Values are FIRST_DAY, LAST_DAY, FIRST_WORKING_DAY, or LAST_WORKING_DAY.

  • invoicingDay string
  • isDisbursementFeeEnabled boolean
  • isTimesheetsEnabled boolean
  • timesheetsAccountId integer(int64)
  • fixedAmount number
  • orderArticleId integer(int64)
  • orderArticleName object
    Hide orderArticleName attributes Show orderArticleName attributes object

    • en string
    • fr string
    • de string
    • it string
  • orderArticleMeasurement string

    Values are UNIT, ML, DL, L, HL, G, KG, T, H, M, M_2, M_3, KM, or DAY.

  • orderArticleUnitPrice number
  • orderArticleAmount number
  • orderArticleDiscount number
  • orderArticleTotalNet number
  • orderArticleStatus string

    Values are SHIPPED, PARTIALLY_SHIPPED, NOT_SHIPPED, or SERVICE.

  • historyStatus string

    Values are OFFERED, OFFERED_SENT, CONFIRMED, CONFIRMED_SENT, BILLABLE, FINISHED, or CANCELLED.

  • historyDate string(date-time)
  • statusLastChangedDate string(date-time)
  • addressName string
  • addressClientName string
  • addressStreet string
  • addressStreetPoBox string
  • addressZipCode string
  • addressCity string
  • addressCountryCode string
  • addressRegionCode string
  • addressToTheAttentionOf string
  • yourReference string
  • orderValidity integer(int64)
  • paymentAccountId integer(int64)
  • periodic boolean
  • inWorkflow boolean
  • expensesEnabled boolean
  • prePaymentAvailable boolean
  • partialPaymentAvailable boolean
  • invoiceGenerated boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error