List PurchaseOrder

GET

/api/purchase-orders

A purchase order is a document for ordering goods or services, specifying the details, conditions of the purchase and line items

Filtering

filter[name]=HelloFromMakiniAPI

filter[name:contains]=Makini

filter[name:startsWith]=Hello

filter[name:startsWith]=API

filter[createdAt:gt]=2023-11-07

filter[createdAt:gteq]=2023-11-07

filter[createdAt:lt]=2023-11-07

filter[createdAt:lted]=2023-11-07

Filter matching

filterMatch=any // OR

filterMatch=all // AND

Sorting

sort[createdAt]=1 // DESC

sort[createdAt]=0 // ASC

Request

Authorization

Query Params

Responses

🟢200

application/json

Successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/purchase-orders?filter&page&sort&per_page'

Response Example

{
    "data": [
        {
            "key": "06000398918336",
            "siteKey": "04000086129130",
            "organizationKey": "02000561823426",
            "orderDate": "2023-10-06T08:17:33Z",
            "vendorKey": "09000938409625",
            "userRequestedKey": "06000585113364",
            "userApprovedKey": "09000696591848",
            "orderNo": "string",
            "statusKey": "07000055068244",
            "title": "Nesciunt aut ut et.",
            "description": "Quibusdam vero illo nobis dolor cum.",
            "dueAt": "2016-01-25T07:20:07Z",
            "approvedAt": "1998-01-20T05:47:36Z",
            "completedAt": "1994-02-05T12:03:13Z",
            "shippingMethod": "string",
            "shipmentDate": "2023-11-14T23:22:34Z",
            "shipmentAddress": {
                "country": "string",
                "addressLines": "string",
                "addressee": "string",
                "state": "string",
                "city": "string",
                "postCode": "string",
                "phone": "string",
                "email": "string",
                "notes": "string",
                "isActive": "true",
                "createdAt": "1983-08-08T12:12:54Z",
                "updatedAt": "2020-05-02T16:09:59Z"
            },
            "billingAddress": {
                "country": "string",
                "addressLines": "string",
                "addressee": "string",
                "state": "string",
                "city": "string",
                "postCode": "string",
                "phone": "string",
                "email": "string",
                "notes": "string",
                "isActive": "true",
                "createdAt": "2015-04-14T02:46:53Z",
                "updatedAt": "2008-11-15T15:19:55Z"
            },
            "terms": "string",
            "notes": "string",
            "deliveryAddress": {
                "country": "string",
                "addressLines": "string",
                "addressee": "string",
                "state": "string",
                "city": "string",
                "postCode": "string",
                "phone": "string",
                "email": "string",
                "notes": "string",
                "isActive": "true",
                "createdAt": "2025-04-22T09:35:59Z",
                "updatedAt": "1982-11-18T08:22:05Z"
            },
            "currencyKey": "02000487484629",
            "locationKey": "08000283085369",
            "totalNetValue": "string",
            "totalGrossValue": "string",
            "updatedAt": "1998-01-27T12:29:53Z",
            "lineItems": [
                {
                    "key": "04000188857621",
                    "locationKey": "01000986450694",
                    "accountKey": "01000467708243",
                    "vendorKey": "01000002180267",
                    "assetKey": "05000694691523",
                    "materialKey": "01000831368349",
                    "productKey": "01000148850743",
                    "statusKey": "09000789498976",
                    "storeroomKey": "06000711223286",
                    "lineNo": "string",
                    "code": "45216459",
                    "type": "string",
                    "name": "string",
                    "description": "Molestias est ut qui voluptatem et.",
                    "lineRef": "string",
                    "quantity": "string",
                    "receivedQuantity": "string",
                    "uomKey": "03000206531274",
                    "currencyKey": "05000152748808",
                    "price": "string",
                    "discount": "string",
                    "lineTaxValue": "string",
                    "lineTotalValue": "string",
                    "notes": "string",
                    "deliveryAt": "2013-11-16T11:14:53Z",
                    "dueAt": "2000-12-06T07:00:00Z",
                    "createdAt": "1990-04-20T20:54:15Z",
                    "updatedAt": "1984-06-19T06:54:31Z",
                    "deletedAt": "2000-07-24T04:22:21Z"
                }
            ]
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}

Modified at 2026-03-19 15:49:21

Get a Project

Create a PurchaseOrder