Get list of sub-orders

GET /api-v1/sub-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)

Query parameters

  • direction string

    Sorting direction

    Values are ASC or DESC. Default value is ASC.

  • pageNumber integer(int32)

    Page Number

    Default value is 1.

  • sizePerPage integer(int32)

    Size per page

    Default value is 60.

  • sortingField string

    Field to sort by

Responses

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • amount number
    • contactName string
    • endDate string(date-time)
    • id integer
    • invoicingDate string(date-time)
    • orderId string
    • orderName string
    • orderOriginalId integer
    • orderPeriodicityType string

      Values are NONE, DAILY, WEEKLY, BI_WEEKLY, EVERY_MONTH, EVERY_2_MONTH, EVERY_3_MONTH, EVERY_4_MONTH, EVERY_6_MONTH, or ANNUAL.

    • organizationId integer
    • startDate string(date-time)
    • totalAmount number
    • 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/sub-orders 
curl \
 --request GET 'https://wyzio.app/api-v1/sub-orders' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"
Response examples (200) 
[
  {
    "amount": 42.0,
    "contactName": "string",
    "endDate": "2025-05-04T09:42:00Z",
    "id": 42,
    "invoicingDate": "2025-05-04T09:42:00Z",
    "orderId": "string",
    "orderName": "string",
    "orderOriginalId": 42,
    "orderPeriodicityType": "NONE",
    "organizationId": 42,
    "startDate": "2025-05-04T09:42:00Z",
    "totalAmount": 42.0,
    "workflowPermissions": "string"
  }
]