Skip to main content
PATCH
/
v1
/
delivery
/
{id}
Update a delivery
curl --request PATCH \
  --url http://localhost:3001/v1/delivery/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "deliveryNumber": "247000-08",
  "externalId": "1234567890",
  "deliveryDate": "2024-06-21",
  "purchaseOrderId": "1234567890"
}'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deliveryNumber": "<string>",
  "externalId": "<string>",
  "deliveryDate": "2023-11-07T05:31:56Z",
  "purchaseOrder": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "purchaseOrderNumber": "<string>",
    "externalId": "<string>",
    "orderDate": "2023-11-07T05:31:56Z",
    "deliveryDate": "2023-11-07T05:31:56Z",
    "counterparty": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "name": "<string>",
      "markedTrusted": true,
      "markedTrustedDate": "2023-11-07T05:31:56Z",
      "markedTrustedUser": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true,
        "organization": {
          "id": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "name": "<any>",
          "slug": "<any>",
          "logoFileName": "<any>",
          "country": "<any>",
          "vatNumber": "<any>",
          "featureFlags": "<any>"
        }
      },
      "description": "<string>",
      "vat": "<string>",
      "accountsPayableNumber": "22 0391919",
      "street": "<string>",
      "city": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "paymentTermsDays": 123,
      "skontoPercentage": 123,
      "skontoDays": 123,
      "organization": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "slug": "<string>",
        "logoFileName": "<string>",
        "country": "<string>",
        "vatNumber": "<string>",
        "featureFlags": [
          {
            "id": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "featureName": "<any>",
            "isEnabled": "<any>"
          }
        ]
      },
      "bankAccount": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>"
      },
      "bankAccountVerification": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "bankAccount": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>"
        },
        "paymentProvider": "<string>",
        "status": "VALID",
        "initializedAt": "2023-11-07T05:31:56Z",
        "mailTrackings": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "version": 123,
          "type": "ONBOARDING",
          "status": "ACCEPTED"
        },
        "fullName": "<string>"
      },
      "transactions": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "amount": 123,
        "remittanceInformation": "<string>",
        "requestedExecutionDate": "2023-11-07T05:31:56Z",
        "skontoAmount": 123,
        "skontoDate": "2023-11-07T05:31:56Z",
        "ignoreSkontoDeadline": true,
        "creditor": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>"
        },
        "debitor": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>"
        },
        "analysis": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "analysisRules": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "type": "AMOUNT_DEVIATION",
            "severity": "NORMAL",
            "markedOk": true,
            "markedOkReason": "<string>",
            "markedOkDate": "2023-11-07T05:31:56Z",
            "value": "<string>",
            "markedOkUser": "<any>"
          },
          "customRules": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "description": "<string>",
            "rule": "<string>",
            "twoFactorCheck": true,
            "accountCheck": true,
            "deleted": true,
            "active": true,
            "organization": "<any>"
          }
        },
        "archived": true,
        "archivedDate": "2023-11-07T05:31:56Z",
        "archivedByUser": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "id": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "name": "<any>",
            "slug": "<any>",
            "logoFileName": "<any>",
            "country": "<any>",
            "vatNumber": "<any>",
            "featureFlags": "<any>"
          }
        },
        "paymentRun": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdById": "<string>",
          "createdByName": "<string>",
          "organizationId": "<string>",
          "sumAmount": 123,
          "sumAmountWithSkonto": 123,
          "sumBookedAmount": 123,
          "transactionCount": 123
        }
      }
    },
    "lineItems": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "productCode": 123,
        "externalId": "<string>",
        "title": "<string>",
        "description": "<string>",
        "quantity": 123,
        "unit": 123,
        "unitPrice": 123,
        "totalPrice": 123,
        "discount": 123,
        "taxRate": 123,
        "taxAmount": 123,
        "deliveredQuantity": 123,
        "invoicedQuantity": 123,
        "invoicedTotalAmount": 123,
        "deliveryPercentage": 123,
        "invoicedPercentage": 123
      }
    ],
    "currency": "<string>",
    "counterpartyId": "<string>",
    "counterpartyName": "<string>",
    "totalOrderAmount": 123,
    "totalInvoicedAmount": 123,
    "totalLineItems": 123,
    "fullyInvoicedLineItemsCount": 123,
    "fullyDeliveredLineItemsCount": 123,
    "invoiceCompletionPercentage": 123,
    "totalOrderQuantity": 123,
    "totalDeliveredQuantity": 123,
    "uniqueDeliveriesCount": 123,
    "totalInvoicedQuantity": 123,
    "uniqueInvoicesCount": 123,
    "outstandingInvoiceAmount": 123
  },
  "lineItems": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "productCode": 123,
      "externalId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "quantity": 123,
      "unit": 123,
      "unitPrice": 123,
      "totalPrice": 123,
      "discount": 123,
      "taxRate": 123,
      "taxAmount": 123,
      "purchaseOrderLineItem": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "productCode": 123,
        "externalId": "<string>",
        "title": "<string>",
        "description": "<string>",
        "quantity": 123,
        "unit": 123,
        "unitPrice": 123,
        "totalPrice": 123,
        "discount": 123,
        "taxRate": 123,
        "taxAmount": 123,
        "deliveredQuantity": 123,
        "invoicedQuantity": 123,
        "invoicedTotalAmount": 123,
        "deliveryPercentage": 123,
        "invoicedPercentage": 123
      }
    }
  ],
  "totalQuantity": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Delivery ID

Body

application/json
​
deliveryNumber
string

The delivery number.

Example:

"247000-08"

​
externalId
string

The external ID of the delivery.

Example:

"1234567890"

​
deliveryDate
string<date-time>

The delivery date.

Example:

"2024-06-21"

​
purchaseOrderId
string

The purchase order ID.

Example:

"1234567890"

Response

200 - application/json
​
id
string

The unique identifier of the entity.

​
createdAt
string<date-time>

The date and time the entity was created.

​
updatedAt
string<date-time>

The date and time the entity was last updated.

​
deliveryNumber
string

The number of the delivery.

​
externalId
string

The external ID of the delivery.

​
deliveryDate
string<date-time>

The date of the delivery.

​
purchaseOrder
object

The purchase order of the delivery.

​
lineItems
object[]

The line items of the delivery.

​
totalQuantity
number

Total quantity delivered across all line items