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

• contactName string

  Client contact name 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.
  
  

• creatorContactId string

  Whether the order was created by, or has, the current user's contact ID.
  
  Multi-value supported. Example: value1;value2
  
  

• 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

• parentOrderId string

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

• departmentId string

  Department IDs filter.
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• officeId string

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

• vatRateId string

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

• requestedPaymentTerms integer(int32)

  Requested payment terms in days filter

• currencyId string

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

• minimumAmountToInvoice string

  Minimum invoiceable 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.
  
  

• ourContactName string

  Our contact name filter

• yourContactName string

  Client's internal contact name filter

• periodicityStartDate string

  Recurring order periodicity start 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.
  
  

• isDisbursementFeeEnabled boolean

  Whether disbursement fee is enabled for the order

• isTimesheetsEnabled boolean

  Whether timesheets are enabled for the order

• timesheetsAccountId string

  Timesheets chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• fixedAmount string

  Fixed amount filter (for TIMESHEET_FIXED orders)Supports 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.
  
  

• orderArticleId string

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

• orderArticleUnitPrice string

  Order article unit price 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.
  
  

• orderArticleAmount string

  Order article quantity 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.
  
  

• orderArticleDiscount string

  Order article discount 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.
  
  

• orderArticleTotalNet string

  Order article net total 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.
  
  

• orderArticleStatus string

  Order article status filter

  Values are SHIPPED, PARTIALLY_SHIPPED, NOT_SHIPPED, or SERVICE.

• historyStatus string

  Order status history entry status filter

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

• historyDate string

  Order status history entry 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.
  
  

• addressName string

  Delivery address name filter

• addressClientName string

  Delivery address client name filter

• addressStreet string

  Delivery address street filter

• addressStreetPoBox string

  Delivery address P.O. box / street line 2 filter

• addressZipCode string

  Delivery address postal code filter

• addressCity string

  Delivery address city filter

• addressCountryCode string

  Delivery address ISO 3166-1 alpha-2 country code filter

• addressRegionCode string

  Delivery address region code filter

• addressToTheAttentionOf string

  Delivery address 'to the attention of' filter

• yourReference string

  Client's reference filter

• orderValidity integer(int64)

  Order validity in days filter

• paymentAccountId string

  Payment chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• hasProformaInvoice boolean

  Whether the order has a proforma invoice

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • items array[object]
    Hide items attributes Show items attributes object

    • errorCode object
      Hide errorCode attributes Show errorCode attributes object

      • errorCode string

        Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.

      • errorDetailValues array[object]
        Hide errorDetailValues attributes Show errorDetailValues attributes object

        • errorCode string
        • fieldName string
        • data string
        • isSevere boolean
    • freshData

      Refreshed domain data

    • freshRow

      Refreshed table row data

    • possibleWorkflows array[object]
      Hide possibleWorkflows attributes Show possibleWorkflows attributes object

      • id integer(int64)
      • name string
    • error boolean
    • severeError boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error