GET All Purchase Orders - Daftra API Docs

Retrieves a paginated list of all purchase orders. The response includes both purchase order data and pagination information.

Parameters:

limit: Number of records per page (1-1000)

page: Page number for pagination

search: Optional search term to filter results

start_date: Optional filter by purchase order date (YYYY-MM-DD)

end_date: Optional filter by purchase order date (YYYY-MM-DD)

supplier_id: Optional filter by supplier ID

status: Optional filter by status (0: draft, 1: pending, 2: received, 3: partially received, 4: canceled)

sort: Optional field to sort by (id, date, total, etc.)

direction: Optional sort direction (asc or desc)

Response:

{
  "result": "success",
  "code": 200,
  "data": [
    {
      "PurchaseOrder": {
        "id": 567,
        "number": "PO-2023-001",
        "supplier_id": 1,
        "date": "2023-03-20",
        "total": 500.00,
        "status": 1,
        "currency_code": "USD",
        // Additional purchase order fields...
      },
      "Supplier": {
        "id": 1,
        "name": "Supply Co",
        // Additional supplier fields...
      },
      "PurchaseOrderItem": [
        {
          "id": 890,
          "purchase_order_id": 567,
          "product_id": 1,
          "description": "Premium Widget",
          "quantity": 10,
          "unit_price": 50.00,
          "total": 500.00
          // Additional item fields...
        }
      ]
    }
    // Additional purchase orders...
  ],
  "pagination": {
    "page": 1,
    "page_count": 3,
    "total_results": 58,
    "prev": null,
    "next": "/api2/purchase_invoices.json?page=2"
  }
}

{ "result": "success", "code": 200, "data": [ { "PurchaseOrder": { "id": 567, "number": "PO-2023-001", "supplier_id": 1, "staff_id": 1, "date": "2023-03-20", "total": 500, "status": 1, "currency_code": "USD", "draft": 0, "notes": "Inventory restock order", "created": "2023-03-20 10:15:22", "modified": "2023-03-20 10:15:22", "is_received": 0 }, "Supplier": { "id": 1, "name": "Supply Co", "business_name": "Supply Company Ltd", "email": "orders@supplyco.com" }, "PurchaseOrderItem": [ { "id": 890, "purchase_order_id": 567, "product_id": 1, "description": "Premium Widget", "quantity": 10, "unit_price": 50, "discount": 0, "discount_type": 1, "tax1": 0, "total": 500 } ] }, { "PurchaseOrder": { "id": 566, "number": "PO-2023-002", "supplier_id": 2, "staff_id": 1, "date": "2023-03-18", "total": 1200, "status": 2, "currency_code": "USD", "draft": 0, "notes": "Office supplies order", "created": "2023-03-18 14:30:45", "modified": "2023-03-25 09:15:30", "is_received": 1, "received_date": "2023-03-25 09:15:30" }, "Supplier": { "id": 2, "name": "Office Depot", "business_name": "Office Depot Inc.", "email": "sales@officedepot.com" }, "PurchaseOrderItem": [ { "id": 889, "purchase_order_id": 566, "product_id": 5, "description": "Office Furniture Set", "quantity": 2, "unit_price": 600, "discount": 0, "discount_type": 1, "tax1": 0, "total": 1200 } ] } ], "pagination": { "page": 1, "page_count": 3, "total_results": 58, "prev": null, "next": "/api2/purchase_invoices.json?page=2" } }

Request

Query Params

limit

string

required

Number of records to return per page (1-1000)

Example:

page

string

required

Page number for pagination

Example:

string

required

Search term to filter results

start_date

string

required

Filter by start date (YYYY-MM-DD)

end_date

string

required

Filter by end date (YYYY-MM-DD)

supplier_id

string

required

Filter by supplier ID

status

string

required

Filter by status (0: draft, 1: pending, 2: received, 3: partially received, 4: canceled)

sort

string

required

Field to sort by (id, date, total, etc.)

Example:

direction

string

required

Sort direction (asc or desc)

Example:

desc

Responses

🟢200Success Response

application/json

Body

result

string

required

code

integer

required

data

array [object {3}]

required

PurchaseOrder

object

required

Supplier

object

required

PurchaseOrderItem

array [object {10}]

required

pagination

object

required

page

integer

required

page_count

integer

required

total_results

integer

required

null

required

string

required