Get list of possible order parents

GET /api-v1/orders/possible-parents/{id}/{contactId}

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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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]
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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]
  
  Additional properties are allowed.
  
  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

GET /api-v1/orders/possible-parents/{id}/{contactId}

curl \
 -X GET http://10.10.10.132/api-v1/orders/possible-parents/{id}/{contactId} \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "activeSubOrderId": 42,
    "activeSubOrderInvoicingDate": "2024-05-04T09:42:00+00:00",
    "address": {
      "city": "string",
      "countryCode2": "string",
      "countryId": 42,
      "houseNumber": "string",
      "id": 42,
      "line1": "string",
      "line2": "string",
      "name": "string",
      "position": 42,
      "postCode": "string",
      "readOnly": true,
      "region": {
        "code": "string",
        "id": 42,
        "name": "string",
        "taxMode": "ANNUALLY"
      },
      "service": "string",
      "toTheAttentionOf": "string"
    },
    "clientAddressId": 42,
    "clientHasVatType": true,
    "clientName": "string",
    "contactId": 42,
    "contactName": "string",
    "currencyId": 42,
    "department": 42,
    "description": "string",
    "disbursementDepartmentId": 42,
    "disbursementOfficeId": 42,
    "expensesDepartmentId": 42,
    "expensesOfficeId": 42,
    "fixedAmount": "string",
    "hasOnlyPrepaymentsInvoices": true,
    "hasProformaInvoice": true,
    "id": 42,
    "includedArticles": [
      {
        "amount": "string",
        "articleId": 42,
        "articleMeasurement": "UNIT",
        "articleName": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "it": "string"
        },
        "departmentId": 42,
        "description": "string",
        "discount": "string",
        "id": 42,
        "longDescription": "string",
        "officeId": 42,
        "orderId": 42,
        "price": "string",
        "shipments": [
          {
            "articleId": 42,
            "articleIdSku": "string",
            "articleName": {
              "de": "string",
              "en": "string",
              "fr": "string",
              "it": "string"
            },
            "currencyCode": "string",
            "generatedStockMovementId": 42,
            "id": 42,
            "orderArticleId": 42,
            "quantity": "string",
            "salesInvoiceLineId": 42,
            "shipmentDate": "string",
            "totalCost": 42.0
          }
        ],
        "status": "SHIPPED",
        "tempId": 42,
        "totalNet": "string",
        "totalPrice": "string",
        "vat": "string",
        "vatRateId": 42
      }
    ],
    "isDisbursementFeeEnabled": true,
    "isExpensesEnabled": true,
    "isInvoiceGenerated": true,
    "isTimesheetsEnabled": true,
    "minimumAmountToInvoice": "string",
    "name": "string",
    "office": 42,
    "orderElementsLayoutLines": [
      {
        "children": [
          {}
        ],
        "id": 42,
        "lineType": "ARTICLE",
        "name": "string",
        "orderElementId": 42,
        "parentId": 42,
        "position": 42
      }
    ],
    "orderId": "string",
    "orderLines": [
      {
        "amount": "string",
        "departmentId": 42,
        "description": "string",
        "discount": "string",
        "id": 42,
        "longDescription": "string",
        "officeId": 42,
        "orderId": 42,
        "price": "string",
        "saleAccountId": 42,
        "saleAccountName": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "it": "string"
        },
        "tempId": 42,
        "totalNet": "string",
        "totalPrice": "string",
        "vat": "string",
        "vatRateId": 42
      }
    ],
    "orderValidity": "string",
    "organizationId": 42,
    "ourContactId": 42,
    "parentOrderId": 42,
    "paymentAccountId": 42,
    "periodic": true,
    "periodicityConfiguration": {
      "dayOfWeek": "MONDAY",
      "endDate": "string",
      "id": 42,
      "invoicingTime": "FIRST_DAY",
      "orderId": 42,
      "periodicityType": "NONE",
      "startDate": "string"
    },
    "realValidated": true,
    "requestedPaymentTerms": "string",
    "status": "OFFERED",
    "statusHistories": [
      {
        "date": "string",
        "id": 42,
        "status": "OFFERED"
      }
    ],
    "statusLastChangedDate": "string",
    "systemValidated": true,
    "tasks": [
      {
        "archived": true,
        "children": [
          {}
        ],
        "id": 42,
        "name": "string",
        "parentId": 42,
        "position": 42,
        "rate": 42.0
      }
    ],
    "timesheetsAccountId": 42,
    "timesheetsDepartmentId": 42,
    "timesheetsDescription": "string",
    "timesheetsDiscount": 42.0,
    "timesheetsLongDescription": "string",
    "timesheetsOfficeId": 42,
    "timesheetsTotalPrice": "string",
    "timesheetsVat": "string",
    "timesheetsVatRateId": 42,
    "validated": true,
    "validatorUserIds": [
      42
    ],
    "validatorUserIdsSize": 42,
    "vatRateId": 42,
    "warnings": "string",
    "yourContactId": 42,
    "yourReference": "string"
  }
]