Partial pay order

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

Headers

Path parameters

  • id integer Required

    id

Body Required

partialPayment

Responses

POST /api-v1/orders/{id}/partial-pay
curl \
 -X POST http://wyzio.app/api-v1/orders/{id}/partial-pay \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '{"articles":[{"amount":"string","orderArticleId":42,"totalNet":"string"}],"date":"string","orderLines":[{"amount":"string","orderLineId":42,"totalNet":"string"}]}'
Request examples
# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
{
  "articles": [
    {
      "amount": "string",
      "orderArticleId": 42,
      "totalNet": "string"
    }
  ],
  "date": "string",
  "orderLines": [
    {
      "amount": "string",
      "orderLineId": 42,
      "totalNet": "string"
    }
  ]
}
Response examples (200)
{
  "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",
      "taxMode": "ANNUALLY"
    },
    "service": "string",
    "toTheAttentionOf": "string"
  },
  "clientAddressId": 42,
  "clientHasVatType": true,
  "clientName": "string",
  "contactId": 42,
  "contactName": "string",
  "currencyId": 42,
  "department": 42,
  "description": "string",
  "disbursementDepartmentId": 42,
  "disbursementOfficeId": 42,
  "expensesDepartmentId": 42,
  "expensesOfficeId": 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",
      "officeId": 42,
      "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",
  "office": 42,
  "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",
      "officeId": 42,
      "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": [
    {
      "archived": true,
      "children": [
        {}
      ],
      "id": 42,
      "name": "string",
      "parentId": 42,
      "position": 42,
      "rate": 42.0
    }
  ],
  "timesheetsAccountId": 42,
  "timesheetsDepartmentId": 42,
  "timesheetsDescription": "string",
  "timesheetsDiscount": 42.0,
  "timesheetsLongDescription": "string",
  "timesheetsOfficeId": 42,
  "timesheetsTotalPrice": "string",
  "timesheetsVat": "string",
  "timesheetsVatRateId": 42,
  "validated": true,
  "validatorUserIds": [
    42
  ],
  "validatorUserIdsSize": 42,
  "vatRateId": 42,
  "warnings": "string",
  "yourContactId": 42,
  "yourReference": "string"
}