Wyzio API documentation

Get list of orders

GET /api-v1/orders

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)
- clientAdvancedInvoicingNote string
- clientECorrespondence boolean
- clientEmail string
- clientOrderEmail string
- contactId integer
- contactName string
- creatorContactId integer
- date string(date-time)
- description string
- expensesEnabled boolean
- flagsAmount integer(int32)
- hasProformaInvoice boolean
- hasWarnings boolean
- id integer
- inWorkflow boolean
- invoiceGenerated boolean
- isExpensesEnabled boolean
- isInWorkflow boolean
- isInvoiceGenerated boolean
- isPartialPaymentAvailable boolean
- isPeriodic boolean
- isPrePaymentAvailable boolean
- name string
- orderAmount number
- orderId string
- orderIdNameConcat string
- organizationId integer
- partialPaymentAvailable boolean
- periodic boolean
- prePaymentAvailable boolean
- status string
  
  Values are OFFERED, OFFERED_SENT, CONFIRMED, CONFIRMED_SENT, BILLABLE, FINISHED, or CANCELLED.
- systemValidated boolean
- validated boolean
- warnings string
- workflowPermissions 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

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

Response examples (200)

[
  {
    "activeSubOrderId": 42,
    "activeSubOrderInvoicingDate": "2024-05-04T09:42:00+00:00",
    "clientAdvancedInvoicingNote": "string",
    "clientECorrespondence": true,
    "clientEmail": "string",
    "clientOrderEmail": "string",
    "contactId": 42,
    "contactName": "string",
    "creatorContactId": 42,
    "date": "2024-05-04T09:42:00+00:00",
    "description": "string",
    "expensesEnabled": true,
    "flagsAmount": 42,
    "hasProformaInvoice": true,
    "hasWarnings": true,
    "id": 42,
    "inWorkflow": true,
    "invoiceGenerated": true,
    "isExpensesEnabled": true,
    "isInWorkflow": true,
    "isInvoiceGenerated": true,
    "isPartialPaymentAvailable": true,
    "isPeriodic": true,
    "isPrePaymentAvailable": true,
    "name": "string",
    "orderAmount": 42.0,
    "orderId": "string",
    "orderIdNameConcat": "string",
    "organizationId": 42,
    "partialPaymentAvailable": true,
    "periodic": true,
    "prePaymentAvailable": true,
    "status": "OFFERED",
    "systemValidated": true,
    "validated": true,
    "warnings": "string",
    "workflowPermissions": "string"
  }
]