Pazy Documentation

Purchase Order Update API

curl --request PATCH \
  --url https://api.pazy.io/v1.0/procurement/purchase-order/:poId

const options = {method: 'PATCH'};

fetch('https://api.pazy.io/v1.0/procurement/purchase-order/:poId', 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://api.pazy.io/v1.0/procurement/purchase-order/:poId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pazy.io/v1.0/procurement/purchase-order/:poId"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.pazy.io/v1.0/procurement/purchase-order/:poId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

Purchase Order Update API

curl --request PATCH \
  --url https://api.pazy.io/v1.0/procurement/purchase-order/:poId

const options = {method: 'PATCH'};

fetch('https://api.pazy.io/v1.0/procurement/purchase-order/:poId', 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://api.pazy.io/v1.0/procurement/purchase-order/:poId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pazy.io/v1.0/procurement/purchase-order/:poId"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.pazy.io/v1.0/procurement/purchase-order/:poId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

Authentication

All requests require an API key in the request headers. Headers:

Authorization: Api-Key YOUR_API_KEY
Content-Type: application/json

Request

Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
`poId`	string	Yes	The unique slug identifier of the purchase order to update (returned from the PO creation or search API)

Body Parameters

All body fields are optional. Only the fields you provide will be updated.

Parameter	Type	Required	Description
`poNumber`	string	No	Purchase order number (minimum 1 character)
`lineItems`	array	No	List of line items. Replaces all existing line items if provided (minimum 1 item)
`poType`	string	No	Purchase order type. Valid values: `GOODS`, `SERVICES`
`matchingType`	string	No	Matching type. Valid values: `TWO_WAY`, `THREE_WAY`
`poDate`	string	No	Purchase order date in ISO-8601 format (YYYY-MM-DD)
`vendorId`	string	No	Slug identifier of the vendor to link to the PO
`description`	string	No	Short description for the purchase order (1-255 characters)
`currency`	string	No	ISO 4217 currency code (3 characters, e.g., `INR`)
`paymentTerms`	string	No	Free form outline of the agreed payment terms
`deliveryDate`	string	No	Requested delivery date in ISO-8601 format (YYYY-MM-DD)
`termsAndConditions`	string	No	Terms and conditions for the purchase order
`additionalNotes`	string	No	Additional notes for delivery or special requirements
`state`	string	No	Target state: `DRAFTED` or `ACTIVE`. When `ACTIVE` is requested the API validates required fields (merging body with what is already on the PO). If all required fields are present the PO is activated; otherwise it stays in `DRAFTED` and the response includes `submitWarnings`.
`tags`	object	No	PO-level custom fields (also called tags). Map of field slug to a `{ value }` object. Supports dropdown, text, date, and numeric fields. See Tags and Custom Fields below.

Line Items Object

Each item in the lineItems array must contain:

Parameter	Type	Required	Description
`quantity`	number	Yes	Quantity requested for the line item
`rate`	number	Yes	Unit rate to be applied to the line item
`identifier`	string	Yes	Free-text label for the line item (minimum 1 character)
`skuCode`	string	Required for `THREE_WAY`	Item code of an existing SKU in your inventory. Takes priority over `skuName`
`skuName`	string	Required for `THREE_WAY`	Name of an existing SKU in your inventory (used when `skuCode` is not provided)
`tags`	object	No	Line-item-level custom fields (also called tags). Map of field slug to a `{ value }` object.
`taxId`	integer	No	ID of a GST tax configured in your organization. The tax is applied to the line item total (`quantity × rate`)
`taxAmount`	number	No	GST amount for this line item. When provided with `taxId`, it must match the calculated tax based on the tax rate

GST on line items: Provide taxId to apply GST to a line item. When taxAmount is provided, it must match the calculated tax for that line item or the request returns a 400 error. Line items without taxId are unaffected.

SKU matching (THREE_WAY): When the PO uses THREE_WAY matching and lineItems are included in the update, every line item must provide skuCode or skuName, and it must resolve to an existing SKU. If any line item is missing both fields or cannot be matched, the request is rejected with a 400 error and the PO is not updated.

Custom Fields

Custom fields use their organization-configured slugs. Dropdown values are organization tag IDs, date values use YYYY-MM-DD, and numeric values are sent as numbers. Include tags on a line item to set line-level custom fields. When lineItems is supplied, it replaces the existing line-item set together with its custom fields. To get the slugs and field types available to your organization, call the Tag List API and use each data.tags[].id value as the key in tags. For dropdown fields, use the Tag Detail API with that slug to retrieve valid option IDs.

{
  "tags": {
    "project-code": { "value": "PRJ-42" },
    "budget-amount": { "value": 125000.5 }
  },
  "lineItems": [
    {
      "identifier": "SKU-001",
      "quantity": 120,
      "rate": 50,
      "tags": { "warehouse": { "value": "WH-01" } }
    }
  ]
}

Editable States

A purchase order can only be updated when it is in one of the following states:

State	Description
`DRAFTED`	PO is in draft — editable
`DECLINED`	PO was declined and returned for revision — editable

Attempting to update a PO in any other state (PENDING, APPROVED, CLOSED, ARCHIVED) will return a 400 error.

Tags and Custom Fields

Tags can be applied both at the PO level (tags in the request body) and at the line-item level (tags inside each lineItems entry). In both cases tags is an object that maps a tag slug to a { value } object:

To discover the available tag slugs, their types, and (for DROPDOWN tags) the valid value ids, see the tag APIs: the Tag List API, and Tag Detail API.

{
  "tags": {
    "cost-center": { "value": 42 },
    "project-code": { "value": "PRJ-2024" },
    "expected-by": { "value": "2024-03-15" },
    "budget": { "value": 5000 }
  }
}

The value you send depends on the tag’s type:

Tag type	What to send as `value`
`DROPDOWN`	The tag value id (number) of an existing option
`VARCHAR`	Free text (string)
`DATETIME`	A date string in `YYYY-MM-DD` format
`NUMBER`	A number
`NUMERIC`	A number (legacy numeric field type)

Code Examples

curl -X PATCH https://api.pazy.io/v1.0/procurement/purchase-order/po_slug_identifier \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated office supplies order",
    "deliveryDate": "2024-03-01",
    "paymentTerms": "Net 45 days",
    "tags": {
      "cost-center": { "value": 42 },
      "project-code": { "value": "PRJ-2024" }
    },
    "lineItems": [
      {
        "identifier": "SKU-001",
        "quantity": 120,
        "rate": 50.00,
        "tags": {
          "budget-line": { "value": "Stationery" }
        },
        "taxId": 3961,
        "taxAmount": 300.00
      }
    ]
  }'

const response = await fetch('https://api.pazy.io/v1.0/procurement/purchase-order/po_slug_identifier', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: 'Updated office supplies order',
    deliveryDate: '2024-03-01',
    paymentTerms: 'Net 45 days',
    tags: {
      'cost-center': { value: 42 },
      'project-code': { value: 'PRJ-2024' }
    },
    lineItems: [
      {
        identifier: 'SKU-001',
        quantity: 120,
        rate: 50.00,
        tags: {
          'budget-line': { value: 'Stationery' }
        },
        taxId: 3961,
        taxAmount: 300.00
      }
    ]
  })
});

const result = await response.json();

import requests

url = "https://api.pazy.io/v1.0/procurement/purchase-order/po_slug_identifier"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

payload = {
    "description": "Updated office supplies order",
    "deliveryDate": "2024-03-01",
    "paymentTerms": "Net 45 days",
    "tags": {
        "cost-center": {"value": 42},
        "project-code": {"value": "PRJ-2024"}
    },
    "lineItems": [
        {
            "identifier": "SKU-001",
            "quantity": 120,
            "rate": 50.00,
            "tags": {
                "budget-line": {"value": "Stationery"}
            },
            "taxId": 3961,
            "taxAmount": 300.00
        }
    ]
}

response = requests.patch(url, headers=headers, json=payload)
result = response.json()

Success Response

HTTP Status: 200 OK Response Fields:

Field	Type	Description
`ok`	boolean	Indicates whether the request was successful
`data`	object	Contains the update response data
`data.poId`	string	Unique slug identifier of the updated purchase order
`data.state`	string	Present when `state` was requested. `ACTIVE` if activation succeeded, `DRAFTED` if it fell back
`data.skuMatchWarnings`	array	Present when one or more line items could not be matched to a SKU
`data.submitWarnings`	object	Present when `state: ACTIVE` was requested but required fields were missing

`submitWarnings` Object

Field	Type	Description
`po`	array of strings	PO-level fields that were missing (e.g. `"vendorId"`, `"paymentTerms"`)
`lineItems`	object	Map of line item identifier to missing fields (e.g. `"quantity"`, `"rate"`)

Response Example — update only (no state change)

{
  "ok": true,
  "data": {
    "poId": "po_slug_identifier"
  }
}

Response Example — activated (`state: "ACTIVE"`, all fields present)

{
  "ok": true,
  "data": {
    "poId": "po_slug_identifier",
    "state": "ACTIVE"
  }
}