Order Item Status Codes
Order Item Type | Code | Description |
---|---|---|
PURCHASE_PENDING | 0 | Approved but not purchased. |
PURCHASE_INUSE | 1 | Added to purchaser's PO list. |
RECEIVE_PENDING | 2 | Purchased but not yet received, i.e. receivedPassQty == 0. |
RECEIVED | 3 | Fully received, i.e. receivedPassQty == quantity. |
REJECTED_FOR_PURCHASE | 4 | Rejected at procurement, i.e. denied. |
RECEIVE_PARTIAL | 5 | Partially received, i.e. receivedPassQty != quantity and receivedPassQty > 0. |
FULFILLED | 6 | Received but unused. |
APPROVAL_DENIED | 7 | Denied in approval routing (by approver). |
REQUEST_DRAFT | 8 | Preparing for draft instead of using sessions. |
object | |
Array of objects (OrderItem) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": 0,
- "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": "string",
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": "string",
- "catalog_item": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": 0,
- "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- 0
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": 0,
- "price": "string",
- "purchase_order": 0,
- "purchaser": 0,
- "quantity": "string",
- "receivedFailQty": "string",
- "receivedPassQty": "string",
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}
}
]
}
Order Status Codes
Order Type | Code |
---|---|
PENDING | 0 |
APPROVED | 1 |
REJECTED | 2 |
PURCHASED | 3 |
CANCELLED (legacy) | 4 |
RECEIVED | 5 |
DRAFT | 6 |
object | |
Array of objects (OrderRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "num": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "branch": {
- "id": 0,
- "external_id": "string",
- "name": "string",
- "logo": "string",
- "language": 1,
- "multipleLocations": true,
- "locationTimezone": "Africa/Abidjan",
- "userLimit": 4294967295,
- "budgetOvertureToggle": true,
- "purchase_filtering": true,
- "catalog_permission": true,
- "separate_expense_approval": true,
- "standalone_travel_approval": true,
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": "user@example.com",
- "fiscalYearEndDay": 4294967295,
- "fiscalYearEndMonth": 4294967295,
- "beginDate": "2019-08-24T14:15:22Z",
- "ported": true,
- "port_date": "2019-08-24T14:15:22Z",
- "active": true,
- "activated": true,
- "setup_stage": "COMP",
- "localCurrency": 0,
- "contactPerson": 0,
- "buyerAddress": 0,
- "shippingAddress": 0
}, - "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "total_cost_in_base_currency": 0,
- "logs": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "department": {
- "id": null,
- "name": null,
- "location": null
}
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "setter": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "item_count": 0,
- "ip_address": "string",
- "date": "2019-08-24T14:15:22Z",
- "description": "string",
- "dateRequired": "2019-08-24T14:15:22Z",
- "dateModified": "2019-08-24T14:15:22Z",
- "lineCount": -2147483648,
- "purchasedCount": -2147483648,
- "totalPrice": "string",
- "status": 0,
- "next_approver": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegatee": 0,
- "punchout_group": {
- "id": 0,
- "name": "string"
}, - "punchout_shipping_address": {
- "id": 0,
- "name": "string"
}, - "punchout_items_rejected": true,
- "punchout_supplier_name": "string",
- "punchout_supplier_icon": "string",
- "punchout_vendor_reference": 0,
- "punchout_is_retriable": true,
- "punchout_order_purchase_order_id": 0,
- "has_blanket_order_items": true
}
]
}
object Default: {} | |
required | object (RequisitionRead) |
{- "required_date": "2019-08-24",
- "location_name": "string",
- "department_name": "string",
- "line_items": [
- {
- "item_name": "string",
- "vendor_name": "string",
- "account_code": "string",
- "unit_price": "string",
- "quantity": "string",
- "unit": "string",
- "currency_code": "string",
- "custom_fields": [
- {
- "custom_field_name": "string",
- "custom_field_value": "string"
}
]
}
]
}
{- "metadata": { },
- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}