POST /api-v1/orders/{id}/partial-pay

Headers

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID integer

    ID of organization, for which the operation must be performed

Path parameters

  • id integer Required
application/json

Body Required

  • date string Required
  • articles array[object]
    Hide articles attributes Show articles attributes object
    • orderArticleId integer
    • amount string
    • totalNet string
  • orderLines array[object]
    Hide orderLines attributes Show orderLines attributes object
    • orderLineId integer
    • amount string
    • totalNet string

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • contactId integer Required
    • contactName string
    • orderId string
    • name string Required
    • status string

      Values are OFFERED, OFFERED_SENT, CONFIRMED, CONFIRMED_SENT, BILLABLE, FINISHED, or CANCELLED.

    • statusLastChangedDate string
    • description string
    • parentOrderId integer
    • department integer
    • vatRateId integer
    • currencyId integer Required
    • requestedPaymentTerms string
    • orderValidity string
    • minimumAmountToInvoice string
    • ourContactId integer
    • yourContactId integer
    • periodicityConfiguration object Required
      Hide periodicityConfiguration attributes Show periodicityConfiguration attributes object
      • id integer
      • startDate string Required
      • endDate string
      • 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
    • isTimesheetsEnabled boolean
    • timesheetsAccountId integer
    • fixedAmount string
    • timesheetsVatRateId integer
    • timesheetsVat string
    • timesheetsTotalPrice string
    • timesheetsDescription string
    • timesheetsLongDescription string
    • timesheetsDiscount number

      Minimum value is 0.0, maximum value is 99.99.

    • timesheetsDepartmentId integer
    • timesheetsOfficeId integer
    • isExpensesEnabled boolean
    • isDisbursementFeeEnabled boolean
    • disbursementDepartmentId integer
    • expensesDepartmentId integer
    • office integer
    • disbursementOfficeId integer
    • expensesOfficeId integer
    • includedArticles array[object]
      Hide includedArticles attributes Show includedArticles attributes object
      • id integer
      • tempId integer
      • orderId integer
      • articleId integer Required
      • description string
      • longDescription string
      • price string
      • amount string
      • discount string
      • totalNet string
      • vatRateId integer
      • 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
        • shipmentDate string
        • articleId integer
        • quantity string
        • currencyCode string
        • totalCost number
        • generatedStockMovementId integer
        • articleName object
          Hide articleName attributes Show articleName attributes object
          • en string
          • fr string
          • de string
          • it string
        • articleIdSku string
        • orderArticleId integer
        • salesInvoiceLineId integer
      • 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
      • officeId integer
    • orderLines array[object]
      Hide orderLines attributes Show orderLines attributes object
      • id integer
      • tempId integer
      • orderId integer
      • description string
      • longDescription string
      • saleAccountId integer
      • price string
      • amount string
      • discount string
      • totalNet string
      • vatRateId integer
      • vat string
      • totalPrice string
      • saleAccountName object
        Hide saleAccountName attributes Show saleAccountName attributes object
        • en string
        • fr string
        • de string
        • it string
      • departmentId integer
      • officeId integer
    • orderElementsLayoutLines array[object]
      Hide orderElementsLayoutLines attributes Show orderElementsLayoutLines attributes object
      • id integer
      • name string
      • parentId integer
      • position integer(int32)
      • children array[object]
      • lineType string

        Values are ARTICLE, ORDER_LINE, TIMESHEET, TIMESHEET_FIXED, EXPENSES, DISBURSEMENT, or HEADER.

      • orderElementId integer
    • warnings string
    • organizationId integer
    • isInvoiceGenerated boolean
    • hasOnlyPrepaymentsInvoices boolean
    • yourReference string
    • clientAddressId integer
    • address object
      Hide address attributes Show address attributes object
      • id integer
      • name string Required
      • line1 string
      • line2 string
      • city string
      • region object
        Hide region attributes Show region attributes object
        • id integer
        • name string
        • code string
        • taxMode string

          Values are ANNUALLY or MONTHLY.

      • countryCode2 string
      • postCode string
      • toTheAttentionOf string
      • position integer(int32)
      • houseNumber string
      • countryId integer Required
      • service string
      • readOnly boolean
    • clientName string
    • statusHistories array[object]
      Hide statusHistories attributes Show statusHistories attributes object
      • id integer
      • 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
      • name string Required
      • rate number
      • parentId integer
      • position integer(int32)
      • children array[object]
      • archived boolean
    • clientHasVatType boolean
    • validated boolean
    • paymentAccountId integer
    • validatorUserIdsSize integer
    • validatorUserIds array[integer(int32)]
    • realValidated boolean
    • activeSubOrderId integer
    • activeSubOrderInvoicingDate string(date-time)
    • systemValidated boolean
    • hasProformaInvoice boolean
    • periodic 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/{id}/partial-pay 
curl \
 --request POST 'https://wyzio.app/api-v1/orders/{id}/partial-pay' \
 --header "Content-Type: application/json" \
 --header "WEAL-TOKEN: string" \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --data '{"date":"string","articles":[{"orderArticleId":42,"amount":"string","totalNet":"string"}],"orderLines":[{"orderLineId":42,"amount":"string","totalNet":"string"}]}'
Request examples 
# Headers
WEAL-TOKEN: string
TARGET-ORGANIZATION-ID: 42

# Payload
{
  "date": "string",
  "articles": [
    {
      "orderArticleId": 42,
      "amount": "string",
      "totalNet": "string"
    }
  ],
  "orderLines": [
    {
      "orderLineId": 42,
      "amount": "string",
      "totalNet": "string"
    }
  ]
}
Response examples (200) 
{
  "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": "string",
  "orderValidity": "string",
  "minimumAmountToInvoice": "string",
  "ourContactId": 42,
  "yourContactId": 42,
  "periodicityConfiguration": {
    "id": 42,
    "startDate": "string",
    "endDate": "string",
    "periodicityType": "NONE",
    "dayOfWeek": "MONDAY",
    "invoicingTime": "FIRST_DAY",
    "orderId": 42
  },
  "isTimesheetsEnabled": true,
  "timesheetsAccountId": 42,
  "fixedAmount": "string",
  "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": "string",
      "amount": "string",
      "discount": "string",
      "totalNet": "string",
      "vatRateId": 42,
      "vat": "string",
      "totalPrice": "string",
      "status": "SHIPPED",
      "shipments": [
        {
          "id": 42,
          "shipmentDate": "string",
          "articleId": 42,
          "quantity": "string",
          "currencyCode": "string",
          "totalCost": 42.0,
          "generatedStockMovementId": 42,
          "articleName": {
            "en": "string",
            "fr": "string",
            "de": "string",
            "it": "string"
          },
          "articleIdSku": "string",
          "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": "string",
      "amount": "string",
      "discount": "string",
      "totalNet": "string",
      "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
}