Get order details and list view representation

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://restapi.wyzio.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Wyzio MCP server": {
    "url": "https://restapi.wyzio.com/mcp"
  }
}

GET /api-v1/orders/{id}/full

Returns order details together with its list view representation.

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
- order object
  
  Hide order attributes Show order 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
- view object
  
  Hide view attributes Show view 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
  
  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

GET /api-v1/orders/{id}/full

curl \
 --request GET 'https://wyzio.app/api-v1/orders/{id}/full'

Response examples (200)

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