Purchase Order API

Manage purchase orders — retrieval, creation, modification, closing and document download

Endpoints

GET Get single record
GET Get list
POST Save / create
POST Delete
POST Close
GET Download

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

Base URL

https://{tenant}.logzi.com/api/order_out/

Every request returns a JSON response. On success result.code == 1, on failure result.code == 0.

GET/api/order_out/get

Retrieve a single purchase order by identifier, with full details.

Query parameters

Parameter	Type	Required	Description
`id`	int		Unique identifier of the purchase order

Example request

GET /api/order_out/get?id=55
X-API-KEY: {your_api_key}

GET/api/order_out/list

Retrieve a paginated list of purchase orders with filtering options.

Query parameters

Parameter	Type	Description
`list_offset`	int	Pagination offset (default: 0)
`list_count`	int	Number of records per page
`list_sort[field]`	string	Name of the field to sort by
`list_sort[sort]`	string	Sort direction: `ASC` or `DESC`
`list_condition[identify]`	string	Filter by identifier (LIKE)
`list_condition[company_name]`	string	Filter by supplier name (LIKE)
`list_condition[status_id]`	int	Filter by status
`list_condition[date_create_from]`	date	Creation date — from (YYYY-MM-DD)
`list_condition[date_create_to]`	date	Creation date — to (YYYY-MM-DD)
`list_condition[partner_id]`	int	Filter by supplier partner ID

Example request

GET /api/order_out/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {your_api_key}

POST/api/order_out/save

Create or update a purchase order. For a new order use data[id] = 0; for an update, provide the existing ID.

POST fields — data object

Field	Type	Description
`id`	int	0 = new order, >0 = update
`company_id`	int	Company identifier
`company_user_id`	int	Responsible staff member ID
`company_address_id`	int	Company site ID
`currency_id`	int	Currency identifier
`partner_id`	int	Supplier partner identifier
`date_perform`	date	Delivery deadline (YYYY-MM-DD)
`comment_top`	string	Comment visible to the supplier
`comment_bottom`	string	Internal comment
`jobnumber_id`	int	Job number identifier
`project_id`	int	Project identifier
`item`	array	Array of line items (see below)

Line item fields — data[item][]

Field	Type	Description
`product_id`	int	Product identifier
`quantity`	float	Ordered quantity
`price`	float	Net unit price
`tax_id`	int	VAT rate identifier
`price_discount`	float	Discount percentage
`store_id`	int	Destination warehouse identifier
`remove`	int	1 = remove item on update

POST fields — params object (optional)

Field	Type	Required	Description
`close`	int		1 = automatically close after save
`download`	int		1 = generate PDF after save

Example request

POST /api/order_out/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "currency_id": 1,
    "partner_id": 8,
    "date_perform": "2024-07-01",
    "item": [
      { "product_id": 2, "quantity": 100, "price": 500, "tax_id": 2 }
    ]
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": { "id": 56, "identify": "SZR-2024-0056" }
}

POST/api/order_out/delete

Delete a purchase order. Only an open order (status_id=1) can be deleted.

POST fields — data object

Field	Type	Required	Description
`receipt_id`	int		Identifier of the order to delete

Example request

POST /api/order_out/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 55 } }

POST/api/order_out/close

Close a purchase order. Only an open order (status_id=1) can be closed.

POST fields — data object

Field	Type	Required	Description
`receipt_id`	int		Identifier of the order to close

Example request

POST /api/order_out/close
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 55 } }

GET/api/order_out/download

Download the purchase order document in various formats.

Query parameters

Parameter	Type	Description
`receipt_id`	int	Identifier of the order
`file_type`	string	`pdf`, `pdf-string`, `pdf-string-sample`, `stream`
`language`	string	Name of the template language folder (e.g. `hungarian`)
`template_id`	int	Custom print template ID

Example request

GET /api/order_out/download?receipt_id=55&file_type=pdf
X-API-KEY: {your_api_key}

Get in touch with us

Interested in our software? Feel free to write to us!

Send an inquiry

Need help?

If you can't find the answer and need assistance

Browse the help center

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!