Wyzio API documentation

Get list of orders using advanced filtering

GET /api-v1/orders/advanced

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)

Responses

• 200

OK
Hide response attributes Show response attributes object
- activeSubOrderId integer
- activeSubOrderInvoicingDate string(date-time)
- addressCity string
- addressClientName string
- addressCountryCode string
- addressName string
- addressRegionCode string
- addressStreet string
- addressStreetPoBox string
- addressToTheAttentionOf string
- addressZipCode string
- clientAdvancedInvoicingNote string
- clientECorrespondence boolean
- clientEmail string
- clientOrderEmail string
- contactId integer
- contactName string
- creatorContactId integer
- currency string
- currencyId integer
- date string(date-time)
- dayOfWeek string
  
  Values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY.
- departmentId integer
- departmentName string
- description string
- expensesEnabled boolean
- fixedAmount number
- flagsAmount integer(int32)
- hasProformaInvoice boolean
- hasWarnings boolean
- historyDate string(date-time)
- historyStatus string
  
  Values are OFFERED, OFFERED_SENT, CONFIRMED, CONFIRMED_SENT, BILLABLE, FINISHED, or CANCELLED.
- id integer
- inWorkflow boolean
- invoiceGenerated boolean
- invoicingDay string
- invoicingTime string
  
  Values are FIRST_DAY, LAST_DAY, FIRST_WORKING_DAY, or LAST_WORKING_DAY.
- isDisbursementFeeEnabled boolean
- isExpensesEnabled boolean
- isInWorkflow boolean
- isInvoiceGenerated boolean
- isPartialPaymentAvailable boolean
- isPeriodic boolean
- isPrePaymentAvailable boolean
- isTimesheetsEnabled boolean
- minimumAmountToInvoice number
- name string
- orderAmount number
- orderArticleAmount number
- orderArticleDiscount number
- orderArticleId integer
- orderArticleMeasurement string
  
  Values are UNIT, ML, DL, L, HL, G, KG, T, H, M, M_2, M_3, KM, or DAY.
- orderArticleName object
  
  Hide orderArticleName attributes Show orderArticleName attributes
  
  de string
  
  en string
  
  fr string
  
  it string
- orderArticleStatus string
  
  Values are SHIPPED, PARTIALLY_SHIPPED, NOT_SHIPPED, or SERVICE.
- orderArticleTotalNet number
- orderArticleUnitPrice number
- orderId string
- orderValidity integer
- organizationId integer
- ourContactName string
- parentOrderId integer
- parentOrderName string
- partialPaymentAvailable boolean
- paymentAccountId integer
- periodic boolean
- periodicityStartDate string(date-time)
- 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.
- prePaymentAvailable boolean
- requestedPaymentTerms integer(int32)
- status string
  
  Values are OFFERED, OFFERED_SENT, CONFIRMED, CONFIRMED_SENT, BILLABLE, FINISHED, or CANCELLED.
- statusLastChangedDate string(date-time)
- systemValidated boolean
- timesheetsAccountId integer
- validated boolean
- vatRateId integer
- vatRateName object
  
  Hide vatRateName attributes Show vatRateName attributes
  
  de string
  
  en string
  
  fr string
  
  it string
- warnings string
- workflowPermissions string
- yourContactName string
- 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/advanced

curl \
 -X GET http://wyzio.app/api-v1/orders/advanced \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "activeSubOrderId": 42,
    "activeSubOrderInvoicingDate": "2024-05-04T09:42:00+00:00",
    "addressCity": "string",
    "addressClientName": "string",
    "addressCountryCode": "string",
    "addressName": "string",
    "addressRegionCode": "string",
    "addressStreet": "string",
    "addressStreetPoBox": "string",
    "addressToTheAttentionOf": "string",
    "addressZipCode": "string",
    "clientAdvancedInvoicingNote": "string",
    "clientECorrespondence": true,
    "clientEmail": "string",
    "clientOrderEmail": "string",
    "contactId": 42,
    "contactName": "string",
    "creatorContactId": 42,
    "currency": "string",
    "currencyId": 42,
    "date": "2024-05-04T09:42:00+00:00",
    "dayOfWeek": "MONDAY",
    "departmentId": 42,
    "departmentName": "string",
    "description": "string",
    "expensesEnabled": true,
    "fixedAmount": 42.0,
    "flagsAmount": 42,
    "hasProformaInvoice": true,
    "hasWarnings": true,
    "historyDate": "2024-05-04T09:42:00+00:00",
    "historyStatus": "OFFERED",
    "id": 42,
    "inWorkflow": true,
    "invoiceGenerated": true,
    "invoicingDay": "string",
    "invoicingTime": "FIRST_DAY",
    "isDisbursementFeeEnabled": true,
    "isExpensesEnabled": true,
    "isInWorkflow": true,
    "isInvoiceGenerated": true,
    "isPartialPaymentAvailable": true,
    "isPeriodic": true,
    "isPrePaymentAvailable": true,
    "isTimesheetsEnabled": true,
    "minimumAmountToInvoice": 42.0,
    "name": "string",
    "orderAmount": 42.0,
    "orderArticleAmount": 42.0,
    "orderArticleDiscount": 42.0,
    "orderArticleId": 42,
    "orderArticleMeasurement": "UNIT",
    "orderArticleName": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "it": "string"
    },
    "orderArticleStatus": "SHIPPED",
    "orderArticleTotalNet": 42.0,
    "orderArticleUnitPrice": 42.0,
    "orderId": "string",
    "orderValidity": 42,
    "organizationId": 42,
    "ourContactName": "string",
    "parentOrderId": 42,
    "parentOrderName": "string",
    "partialPaymentAvailable": true,
    "paymentAccountId": 42,
    "periodic": true,
    "periodicityStartDate": "2024-05-04T09:42:00+00:00",
    "periodicityType": "NONE",
    "prePaymentAvailable": true,
    "requestedPaymentTerms": 42,
    "status": "OFFERED",
    "statusLastChangedDate": "2024-05-04T09:42:00+00:00",
    "systemValidated": true,
    "timesheetsAccountId": 42,
    "validated": true,
    "vatRateId": 42,
    "vatRateName": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "it": "string"
    },
    "warnings": "string",
    "workflowPermissions": "string",
    "yourContactName": "string",
    "yourReference": "string"
  }
]