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

Path parameters

• id integer(int64) Required

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • contactId integer(int64) Required
  • contactName string
  • orderId string
  • name string Required

    Minimum length is 1.

  • status string

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

  • statusLastChangedDate string
  • description string
  • parentOrderId integer(int64)
  • department integer(int64)
  • vatRateId integer(int64)
  • currencyId integer(int64) Required
  • requestedPaymentTerms string

    Numeric value represented as string

  • orderValidity string

    Numeric value represented as string

  • minimumAmountToInvoice string

    Numeric value represented as string

  • ourContactId integer(int64)
  • yourContactId integer(int64)
  • periodicityConfiguration object Required
    Hide periodicityConfiguration attributes Show periodicityConfiguration attributes object

    • id integer(int64)
    • startDate string(date-time) Required

      Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

      Minimum length is 1.

    • endDate string(date-time)

      Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

    • 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.

    • orderId integer(int64)
  • isTimesheetsEnabled boolean
  • timesheetsAccountId integer(int64)
  • fixedAmount string

    Numeric value represented as string

  • timesheetsVatRateId integer(int64)
  • timesheetsVat string
  • timesheetsTotalPrice string
  • timesheetsDescription string
  • timesheetsLongDescription string
  • timesheetsDiscount number

    Minimum value is 0.0, maximum value is 99.99.

  • timesheetsDepartmentId integer(int64)
  • timesheetsOfficeId integer(int64)
  • isExpensesEnabled boolean
  • isDisbursementFeeEnabled boolean
  • disbursementDepartmentId integer(int64)
  • expensesDepartmentId integer(int64)
  • office integer(int64)
  • disbursementOfficeId integer(int64)
  • expensesOfficeId integer(int64)
  • includedArticles array[object]
    Hide includedArticles attributes Show includedArticles attributes object

    • id integer(int64)
    • tempId integer(int64)
    • orderId integer(int64)
    • articleId integer(int64) Required
    • description string
    • longDescription string
    • price string

      Numeric value represented as string

    • amount string

      Numeric value represented as string

    • discount string

      Numeric value represented as string

    • totalNet string

      Numeric value represented as string

    • vatRateId integer(int64)
    • vat string
    • totalPrice string
    • status string

      Values are SHIPPED, PARTIALLY_SHIPPED, NOT_SHIPPED, or SERVICE.

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

      • id integer(int64)
      • shipmentDate string(date-time)

        Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

      • articleId integer(int64)
      • quantity string

        Numeric value represented as string

      • currencyCode string
      • totalCost number
      • generatedStockMovementId integer(int64)
      • articleName object
        Hide articleName attributes Show articleName attributes object

        • en string
        • fr string
        • de string
        • it string
      • articleIdSku string
      • officeId integer(int64)
      • orderArticleId integer(int64)
      • salesInvoiceLineId integer(int64)
    • articleName object
      Hide articleName attributes Show articleName attributes object

      • en string
      • fr string
      • de string
      • it string
    • articleMeasurement string

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

    • departmentId integer(int64)
    • officeId integer(int64)
  • orderLines array[object]
    Hide orderLines attributes Show orderLines attributes object

    • id integer(int64)
    • tempId integer(int64)
    • orderId integer(int64)
    • description string
    • longDescription string
    • saleAccountId integer(int64)
    • price string

      Numeric value represented as string

    • amount string

      Numeric value represented as string

    • discount string

      Numeric value represented as string

    • totalNet string

      Numeric value represented as string

    • vatRateId integer(int64)
    • vat string
    • totalPrice string
    • saleAccountName object
      Hide saleAccountName attributes Show saleAccountName attributes object

      • en string
      • fr string
      • de string
      • it string
    • departmentId integer(int64)
    • officeId integer(int64)
  • orderElementsLayoutLines array[object]
    Hide orderElementsLayoutLines attributes Show orderElementsLayoutLines attributes object

    • id integer(int64)
    • name string
    • parentId integer(int64)
    • position integer(int32)
    • children array[object]
    • lineType string

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

    • orderElementId integer(int64)
  • warnings string
  • organizationId integer(int64)
  • isInvoiceGenerated boolean
  • hasOnlyPrepaymentsInvoices boolean
  • yourReference string
  • clientAddressId integer(int64)
  • address object
    Hide address attributes Show address attributes object

    • id integer(int64)
    • name string Required

      Minimum length is 1.

    • line1 string
    • line2 string
    • city string
    • region object
      Hide region attributes Show region attributes object

      • id integer(int64)
      • name string
      • code string
      • taxMode string

        Values are ANNUALLY or MONTHLY.

    • countryCode2 string
    • postCode string
    • toTheAttentionOf string
    • position integer(int32)
    • houseNumber string
    • countryId integer(int64) Required
    • service string
    • readOnly boolean
  • clientName string
  • statusHistories array[object]
    Hide statusHistories attributes Show statusHistories attributes object

    • id integer(int64)
    • status string

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

    • date string
  • tasks array[object]
    Hide tasks attributes Show tasks attributes object

    • id integer(int64)
    • name string Required

      Minimum length is 1.

    • rate number
    • parentId integer(int64)
    • position integer(int32)
    • children array[object]
    • archived boolean
  • clientHasVatType boolean
  • validated boolean
  • paymentAccountId integer(int64)
  • validatorUserIdsSize integer(int64)
  • validatorUserIds array[integer(int64)]
  • realValidated boolean
  • activeSubOrderId integer(int64)
  • activeSubOrderInvoicingDate string(date-time)
  • systemValidated boolean
  • hasProformaInvoice boolean
  • periodic boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error