Update purchase order

PUT

admin

api

purchases

purchase-orders

{id}

Update purchase order

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "planned_at": "2026-03-03T04:25:45"
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id}"

payload = { "planned_at": "2026-03-03T04:25:45" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({planned_at: '2026-03-03T04:25:45'})
};

fetch('https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'planned_at' => '2026-03-03T04:25:45'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 1,
    "name": "PO/1",
    "description": "<p></p>",
    "priority": "0",
    "origin": null,
    "partner_reference": "EH-1234",
    "state": "purchase",
    "invoice_status": "invoiced",
    "receipt_status": "full",
    "untaxed_amount": 35000,
    "tax_amount": 5250,
    "total_amount": 40250,
    "total_cc_amount": 40250,
    "currency_rate": 0,
    "mail_reminder_confirmed": true,
    "mail_reception_confirmed": false,
    "mail_reception_declined": false,
    "invoice_count": 0,
    "ordered_at": "2026-01-08T12:53:13.000000Z",
    "approved_at": "2026-01-08T12:56:13.000000Z",
    "planned_at": "2026-03-11T00:00:00.000000Z",
    "calendar_start_at": "2026-01-08T12:53:13.000000Z",
    "incoterm_location": null,
    "effective_date": null,
    "report_grids": false,
    "requisition_id": null,
    "purchases_group_id": null,
    "partner_id": 41,
    "currency_id": 1,
    "fiscal_position_id": null,
    "payment_term_id": null,
    "incoterm_id": null,
    "user_id": 1,
    "company_id": 1,
    "creator_id": 1,
    "operation_type_id": 1,
    "created_at": "2026-01-08T12:55:43.000000Z",
    "updated_at": "2026-01-08T12:56:52.000000Z"
  },
  "message": "Purchase order updated successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "partner_id": [
      "The partner id field must be an integer."
    ]
  }
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Path Parameters

integer

required

The purchase order ID

Example:

1

Body

application/json

partner_id

integer

Vendor partner ID. The id of an existing record in the partners_partners table.

Example:

12

currency_id

integer

Currency ID. The id of an existing record in the currencies table.

Example:

1

ordered_at

string

Order deadline datetime. Must be a valid date.

Example:

"2026-02-20 10:00:00"

company_id

integer

Company ID. The id of an existing record in the companies table.

Example:

1

partner_reference

string | null

Vendor reference. Must not be greater than 255 characters.

Example:

"VEN-REF-009"

requisition_id

integer | null

Purchase agreement ID. The id of an existing record in the purchases_requisitions table.

Example:

5

planned_at

string | null

Must be a valid date.

Example:

"2026-03-03T04:25:45"

user_id

integer | null

Buyer user ID. The id of an existing record in the users table.

Example:

2

payment_term_id

integer | null

Payment term ID. The id of an existing record in the accounts_payment_terms table.

Example:

4

incoterm_id

integer | null

Incoterm ID. The id of an existing record in the accounts_incoterms table.

Example:

3

description

string | null

Terms and conditions / internal description.

Example:

"Please ship in one lot."

origin

string | null

Must not be greater than 255 characters.

Example:

"b"

lines

object[]

Array of purchase order lines with writable fields from the order form. Must have at least 1 items.

Show child attributes

Example:

[
  {
    "product_id": 101,
    "planned_at": "2026-02-28 12:00:00",
    "product_qty": 20,
    "uom_id": 1,
    "product_packaging_id": null,
    "product_packaging_qty": 0,
    "price_unit": 80,
    "discount": 5,
    "qty_received": 0,
    "qty_received_manual": 0,
    "taxes": [1, 2]
  }
]

Response

Success

⌘I

Update purchase order

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "planned_at": "2026-03-03T04:25:45"
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id}"

payload = { "planned_at": "2026-03-03T04:25:45" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({planned_at: '2026-03-03T04:25:45'})
};

fetch('https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/purchases/purchase-orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'planned_at' => '2026-03-03T04:25:45'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 1,
    "name": "PO/1",
    "description": "<p></p>",
    "priority": "0",
    "origin": null,
    "partner_reference": "EH-1234",
    "state": "purchase",
    "invoice_status": "invoiced",
    "receipt_status": "full",
    "untaxed_amount": 35000,
    "tax_amount": 5250,
    "total_amount": 40250,
    "total_cc_amount": 40250,
    "currency_rate": 0,
    "mail_reminder_confirmed": true,
    "mail_reception_confirmed": false,
    "mail_reception_declined": false,
    "invoice_count": 0,
    "ordered_at": "2026-01-08T12:53:13.000000Z",
    "approved_at": "2026-01-08T12:56:13.000000Z",
    "planned_at": "2026-03-11T00:00:00.000000Z",
    "calendar_start_at": "2026-01-08T12:53:13.000000Z",
    "incoterm_location": null,
    "effective_date": null,
    "report_grids": false,
    "requisition_id": null,
    "purchases_group_id": null,
    "partner_id": 41,
    "currency_id": 1,
    "fiscal_position_id": null,
    "payment_term_id": null,
    "incoterm_id": null,
    "user_id": 1,
    "company_id": 1,
    "creator_id": 1,
    "operation_type_id": 1,
    "created_at": "2026-01-08T12:55:43.000000Z",
    "updated_at": "2026-01-08T12:56:52.000000Z"
  },
  "message": "Purchase order updated successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "partner_id": [
      "The partner id field must be an integer."
    ]
  }
}

Get started

Endpoints

Authorizations

Path Parameters

Body

Response