The External Order Management section of the InvenTree API schema is documented below.
InvenTree API 277¶
API for InvenTree - the intuitive open source inventory management system
Servers¶
Description | URL |
---|---|
http://localhost:8000 | http://localhost:8000 |
order¶
GET /api/order/po-extra-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | ||
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderExtraLine"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/po-extra-line/¶
Description
API endpoint for accessing a list of PurchaseOrderExtraLine objects.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 201 Created
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
GET /api/order/po-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/po-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/po-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
DELETE /api/order/po-line/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/order/po-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
base_part |
query | string | No | Internal Part | |
has_pricing |
query | boolean | No | Has Pricing | |
include_variants |
query | boolean | No | Include Variants | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | Order | |
order_complete |
query | boolean | No | Order Complete | |
order_status |
query | integer | No | Order Status | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Supplier Part | |
pending |
query | boolean | No | Order Pending | |
received |
query | boolean | No | Items Received | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItem"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/po-line/¶
Description
API endpoint for accessing a list of PurchaseOrderLineItem objects.
- GET: Return a list of PurchaseOrder Line Item objects
- POST: Create a new PurchaseOrderLineItem object
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
Response 201 Created
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
DELETE /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
PATCH /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
}
Response 200 OK
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
PUT /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
Response 200 OK
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
GET /api/order/po-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/po-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/po-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/order/po/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
assigned_to |
query | integer | No | Responsible | |
assigned_to_me |
query | boolean | No | Assigned to me | |
has_project_code |
query | boolean | No | Has Project Code | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
outstanding |
query | boolean | No | Outstanding | |
overdue |
query | boolean | No | overdue | |
project_code |
query | integer | No | Project Code | |
reference |
query | string | No | Order Reference | |
search |
query | string | No | A search term. | |
status |
query | integer | No | Order Status | |
supplier |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PurchaseOrder"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/po/¶
Description
API endpoint for accessing a list of PurchaseOrder objects.
- GET: Return list of PurchaseOrder objects (with filters)
- POST: Create a new PurchaseOrder object
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
Response 201 Created
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
GET /api/order/po/status/¶
Description
Retrieve information about a specific status code
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
Response 400 Bad Request
DELETE /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
PATCH /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
PUT /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
Parameter | In | Type | Default | Nullable | Description |
---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Complet