cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_orders/PURCHASE_ORDER_ID" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_order": {
"purchase_order_note": "Deliver to the rear dock."
}
}'from exsited import build_client
client = build_client()
response = client.purchase_orders.update_purchase_order(
"PURCHASE_ORDER_ID",
{"purchase_order": {"purchase_order_note": "Deliver to the rear dock."}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseOrders.updatePurchaseOrder('PURCHASE_ORDER_ID', {
purchase_order: {purchase_order_note: 'Deliver to the rear dock.'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseOrders->updatePurchaseOrder('PURCHASE_ORDER_ID', [
'purchase_order' => ['purchase_order_note' => 'Deliver to the rear dock.'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_orders.purchase_orders_dto.PurchaseOrdersDto.PurchaseOrderUpdated;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseOrderUpdated> response = client.purchaseOrders().updatePurchaseOrder(
"PURCHASE_ORDER_ID",
Map.of("purchase_order", Map.of("purchase_order_note", "Deliver to the rear dock.")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseOrders.UpdatePurchaseOrderAsync(
"PURCHASE_ORDER_ID",
new Dictionary<string, object?>
{
["purchase_order"] = new Dictionary<string, object?>
{
["purchase_order_note"] = "Deliver to the rear dock.",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseOrders.updatePurchaseOrder(
'PURCHASE_ORDER_ID',
{
'purchase_order': {'purchase_order_note': 'Deliver to the rear dock.'},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.PurchaseOrders().UpdatePurchaseOrder(context.Background(), "PURCHASE_ORDER_ID", map[string]any{
"purchase_order": map[string]any{
"purchase_order_note": "Deliver to the rear dock.",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_order": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"account_id": "<string>",
"activity_logs": [
"<unknown>"
],
"bill_total": "<string>",
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"custom_objects": [
"<unknown>"
],
"due_date": "<string>",
"due_total": "<string>",
"expected_completion_date": "<string>",
"href": "<string>",
"id": "<string>",
"is_price_tax_inclusive": "<unknown>",
"issue_date": "<string>",
"kpis": {
"estimated_total": "<string>",
"issue_date": "<unknown>",
"last_cancelled_on": "<unknown>",
"last_changed_on": "<unknown>",
"last_deleted_on": "<unknown>",
"last_invoice_issue_date": "<unknown>",
"last_invoice_total": "<string>",
"last_reactivated_on": "<unknown>",
"object": "<string>",
"total_expense": "<string>",
"total_outstanding": "<string>",
"total_overdue": "<string>",
"total_purchase_invoice": 123
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"lines": [
"<unknown>"
],
"object": "<string>",
"operational_status": "<string>",
"origin": "<string>",
"paid_amount": "<string>",
"price_tax_inclusive": "<string>",
"purchase_order_note": "<string>",
"sale_order": "<unknown>",
"sale_order_id": "<string>",
"status": "<string>",
"subtotal": "<string>",
"supplier_invoice_id": "<string>",
"tax": "<string>",
"tax_total": "<string>",
"total": "<string>",
"uuid": "<string>",
"version": 123,
"warehouse": "<unknown>"
}
}Purchase orders
Update a purchase order
Changes header fields of a purchase order and returns it under purchase_order.
PATCH
/
purchase_orders
/
{purchase_order_id}
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_orders/PURCHASE_ORDER_ID" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_order": {
"purchase_order_note": "Deliver to the rear dock."
}
}'from exsited import build_client
client = build_client()
response = client.purchase_orders.update_purchase_order(
"PURCHASE_ORDER_ID",
{"purchase_order": {"purchase_order_note": "Deliver to the rear dock."}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseOrders.updatePurchaseOrder('PURCHASE_ORDER_ID', {
purchase_order: {purchase_order_note: 'Deliver to the rear dock.'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseOrders->updatePurchaseOrder('PURCHASE_ORDER_ID', [
'purchase_order' => ['purchase_order_note' => 'Deliver to the rear dock.'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_orders.purchase_orders_dto.PurchaseOrdersDto.PurchaseOrderUpdated;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseOrderUpdated> response = client.purchaseOrders().updatePurchaseOrder(
"PURCHASE_ORDER_ID",
Map.of("purchase_order", Map.of("purchase_order_note", "Deliver to the rear dock.")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseOrders.UpdatePurchaseOrderAsync(
"PURCHASE_ORDER_ID",
new Dictionary<string, object?>
{
["purchase_order"] = new Dictionary<string, object?>
{
["purchase_order_note"] = "Deliver to the rear dock.",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseOrders.updatePurchaseOrder(
'PURCHASE_ORDER_ID',
{
'purchase_order': {'purchase_order_note': 'Deliver to the rear dock.'},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.PurchaseOrders().UpdatePurchaseOrder(context.Background(), "PURCHASE_ORDER_ID", map[string]any{
"purchase_order": map[string]any{
"purchase_order_note": "Deliver to the rear dock.",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_order": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"account_id": "<string>",
"activity_logs": [
"<unknown>"
],
"bill_total": "<string>",
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"custom_form": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"custom_objects": [
"<unknown>"
],
"due_date": "<string>",
"due_total": "<string>",
"expected_completion_date": "<string>",
"href": "<string>",
"id": "<string>",
"is_price_tax_inclusive": "<unknown>",
"issue_date": "<string>",
"kpis": {
"estimated_total": "<string>",
"issue_date": "<unknown>",
"last_cancelled_on": "<unknown>",
"last_changed_on": "<unknown>",
"last_deleted_on": "<unknown>",
"last_invoice_issue_date": "<unknown>",
"last_invoice_total": "<string>",
"last_reactivated_on": "<unknown>",
"object": "<string>",
"total_expense": "<string>",
"total_outstanding": "<string>",
"total_overdue": "<string>",
"total_purchase_invoice": 123
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"lines": [
"<unknown>"
],
"object": "<string>",
"operational_status": "<string>",
"origin": "<string>",
"paid_amount": "<string>",
"price_tax_inclusive": "<string>",
"purchase_order_note": "<string>",
"sale_order": "<unknown>",
"sale_order_id": "<string>",
"status": "<string>",
"subtotal": "<string>",
"supplier_invoice_id": "<string>",
"tax": "<string>",
"tax_total": "<string>",
"total": "<string>",
"uuid": "<string>",
"version": 123,
"warehouse": "<unknown>"
}
}Updates fields of the purchase order, such as
purchase_order_note, wrapped in purchase_order. The updated purchase order comes back under purchase_order. To add or change lines, use the change call.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The purchase order's id.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
The updated purchase order, under purchase_order.
Show child attributes
Show child attributes