Wyzio API documentation

Modify batch of orders

POST /api-v1/orders/batch

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)

Body Required

orders

activeSubOrderId integer
activeSubOrderInvoicingDate string(date-time)
address object
Hide address attributes Show address attributes
- 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
  
  code string
  
  id integer
  
  name string
- service string
- toTheAttentionOf string
clientAddressId integer
clientHasVatType boolean
clientName string
contactId integer
contactName string
currencyId integer
department integer
description string
disbursementDepartmentId integer
expensesDepartmentId 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
  
  de string
  
  en string
  
  fr string
  
  it string
- departmentId integer
- description string
- discount string
- id integer
- longDescription string
- 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
  
  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
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
- orderId integer
- price string
- saleAccountId integer
- saleAccountName object
  Hide saleAccountName attributes Show saleAccountName attributes
  
  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
- 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
- children array[object]
- id integer
- name string
- parentId integer
- position integer(int32)
- rate number
timesheetsAccountId integer
timesheetsDepartmentId integer
timesheetsDescription string
timesheetsDiscount number
timesheetsLongDescription string
timesheetsTotalPrice string
timesheetsVat string
timesheetsVatRateId integer
validated boolean
validatorUserIds array[integer(int32)]
validatorUserIdsSize integer
vatRateId integer
warnings string
yourContactId integer
yourReference string

Responses

• 200

OK
Hide response attribute Show response attribute object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  error boolean
  
  errorCode object
  
  Hide errorCode attributes Show errorCode attributes
  
  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
  
  data string
  
  errorCode string
  
  fieldName string
  
  isSevere boolean
  
  freshData object
  
  freshRow object
  
  possibleWorkflows array[object]
  
  Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  
  id integer
  
  name string
  
  severeError boolean
• 400

400 Bad Request
• 401

401 Unauthorized
• 403

403 Access Denied
• 404

404 Not Found
• 500

500 Internal Server Error

POST /api-v1/orders/batch

curl \
 -X POST http://wyzio.app/api-v1/orders/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '[{"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"},"service":"string","toTheAttentionOf":"string"},"clientAddressId":42,"clientHasVatType":true,"clientName":"string","contactId":42,"contactName":"string","currencyId":42,"department":42,"description":"string","disbursementDepartmentId":42,"expensesDepartmentId":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","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","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","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":[{"children":[{}],"id":42,"name":"string","parentId":42,"position":42,"rate":42.0}],"timesheetsAccountId":42,"timesheetsDepartmentId":42,"timesheetsDescription":"string","timesheetsDiscount":42.0,"timesheetsLongDescription":"string","timesheetsTotalPrice":"string","timesheetsVat":"string","timesheetsVatRateId":42,"validated":true,"validatorUserIds":[42],"validatorUserIdsSize":42,"vatRateId":42,"warnings":"string","yourContactId":42,"yourReference":"string"}]'

Request example

# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
[
  {
    "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"
      },
      "service": "string",
      "toTheAttentionOf": "string"
    },
    "clientAddressId": 42,
    "clientHasVatType": true,
    "clientName": "string",
    "contactId": 42,
    "contactName": "string",
    "currencyId": 42,
    "department": 42,
    "description": "string",
    "disbursementDepartmentId": 42,
    "expensesDepartmentId": 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",
        "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",
    "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",
        "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": [
      {
        "children": [
          {}
        ],
        "id": 42,
        "name": "string",
        "parentId": 42,
        "position": 42,
        "rate": 42.0
      }
    ],
    "timesheetsAccountId": 42,
    "timesheetsDepartmentId": 42,
    "timesheetsDescription": "string",
    "timesheetsDiscount": 42.0,
    "timesheetsLongDescription": "string",
    "timesheetsTotalPrice": "string",
    "timesheetsVat": "string",
    "timesheetsVatRateId": 42,
    "validated": true,
    "validatorUserIds": [
      42
    ],
    "validatorUserIdsSize": 42,
    "vatRateId": 42,
    "warnings": "string",
    "yourContactId": 42,
    "yourReference": "string"
  }
]

Response examples (200)

{
  "items": [
    {
      "error": true,
      "errorCode": {
        "errorCode": "NO_ERROR",
        "errorDetailValues": [
          {
            "data": "string",
            "errorCode": "string",
            "fieldName": "string",
            "isSevere": true
          }
        ]
      },
      "freshData": {},
      "freshRow": {},
      "possibleWorkflows": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "severeError": true
    }
  ]
}