Headers

• TARGET-ORGANIZATION-ID integer(int32)

  ID of organization, for which the operation must be performed

• WEAL-TOKEN string Required

  API token (can be retrieved from account settings)

Path parameters

• contactId integer Required

  contactId

• id integer Required

  id

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

  • activeSubOrderId integer
  • activeSubOrderInvoicingDate string(date-time)
  • address object
    Hide address attributes Show address attributes object

    • city string
    • countryCode2 string
    • countryId integer
    • houseNumber string
    • id integer
    • line1 string
    • line2 string
    • name string
    • position integer(int32)
    • postCode string
    • readOnly boolean
    • region object
      Hide region attributes Show region attributes object

      • code string
      • id integer
      • name string
      • taxMode string

        Values are ANNUALLY or MONTHLY.

    • service string
    • toTheAttentionOf string
  • clientAddressId integer
  • clientHasVatType boolean
  • clientName string
  • contactId integer
  • contactName string
  • currencyId integer
  • department integer
  • description string
  • disbursementDepartmentId integer
  • disbursementOfficeId integer
  • expensesDepartmentId integer
  • expensesOfficeId integer
  • fixedAmount string
  • hasOnlyPrepaymentsInvoices boolean
  • hasProformaInvoice boolean
  • id integer
  • includedArticles array[object]
    Hide includedArticles attributes Show includedArticles attributes object

    • amount string
    • articleId integer
    • articleMeasurement string

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

    • articleName object
      Hide articleName attributes Show articleName attributes object

      • de string
      • en string
      • fr string
      • it string
    • departmentId integer
    • description string
    • discount string
    • id integer
    • longDescription string
    • officeId integer
    • orderId integer
    • price string
    • shipments array[object]
      Hide shipments attributes Show shipments attributes object

      • articleId integer
      • articleIdSku string
      • articleName object
        Hide articleName attributes Show articleName attributes object

        • de string
        • en string
        • fr string
        • it string
      • currencyCode string
      • generatedStockMovementId integer
      • id integer
      • orderArticleId integer
      • quantity string
      • salesInvoiceLineId integer
      • shipmentDate string
      • totalCost number
    • status string

      Values are SHIPPED, PARTIALLY_SHIPPED, NOT_SHIPPED, or SERVICE.

    • tempId integer
    • totalNet string
    • totalPrice string
    • vat string
    • vatRateId integer
  • isDisbursementFeeEnabled boolean
  • isExpensesEnabled boolean
  • isInvoiceGenerated boolean
  • isTimesheetsEnabled boolean
  • minimumAmountToInvoice string
  • name string
  • office integer
  • orderElementsLayoutLines array[object]
    Hide orderElementsLayoutLines attributes Show orderElementsLayoutLines attributes object

    • children array[object]
    • id integer
    • lineType string

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

    • name string
    • orderElementId integer
    • parentId integer
    • position integer(int32)
  • orderId string
  • orderLines array[object]
    Hide orderLines attributes Show orderLines attributes object

    • amount string
    • departmentId integer
    • description string
    • discount string
    • id integer
    • longDescription string
    • officeId integer
    • orderId integer
    • price string
    • saleAccountId integer
    • saleAccountName object
      Hide saleAccountName attributes Show saleAccountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • tempId integer
    • totalNet string
    • totalPrice string
    • vat string
    • vatRateId integer
  • orderValidity string
  • organizationId integer
  • ourContactId integer
  • parentOrderId integer
  • paymentAccountId integer
  • periodic boolean
  • periodicityConfiguration object
    Hide periodicityConfiguration attributes Show periodicityConfiguration attributes object

    • dayOfWeek string

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

    • endDate string
    • id integer
    • invoicingTime string

      Values are FIRST_DAY, LAST_DAY, FIRST_WORKING_DAY, or LAST_WORKING_DAY.

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

    • startDate string
  • realValidated boolean
  • requestedPaymentTerms string
  • status string

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

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

    • date string
    • id integer
    • status string

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

  • statusLastChangedDate string
  • systemValidated boolean
  • tasks array[object]
    Hide tasks attributes Show tasks attributes object

    • archived boolean
    • children array[object]
    • id integer
    • name string
    • parentId integer
    • position integer(int32)
    • rate number
  • timesheetsAccountId integer
  • timesheetsDepartmentId integer
  • timesheetsDescription string
  • timesheetsDiscount number
  • timesheetsLongDescription string
  • timesheetsOfficeId integer
  • timesheetsTotalPrice string
  • timesheetsVat string
  • timesheetsVatRateId integer
  • validated boolean
  • validatorUserIds array[integer(int32)]
  • validatorUserIdsSize integer
  • vatRateId integer
  • warnings string
  • yourContactId integer
  • yourReference string
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error