The External Order Management section of the InvenTree API schema is documented below.

InvenTree API 530

API for InvenTree - the intuitive open source inventory management system

---

License: MIT

Servers

Description	URL
http://localhost:8000	http://localhost:8000

order

---

DELETE /api/order/po-extra-line/

Description

Perform a DELETE operation against this list endpoint.

Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

Responses

204 No Content

---

GET /api/order/po-extra-line/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
ordering	query	string		No	Which field to use when ordering the results.
search	query	string		No	A search term. Searched fields: description, notes, quantity, reference.

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "description": "string",
            "discount": 10.12,
            "line": "string",
            "link": null,
            "notes": "string",
            "order": 0,
            "order_detail": null,
            "pk": 0,
            "price": "string",
            "price_currency": "string",
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "quantity": 10.12,
            "reference": "string",
            "target_date": "2022-04-13",
            "total_price": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "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
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "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
oauth2	header	string	N/A	No
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

Responses

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
oauth2	header	string	N/A	No
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

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "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
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "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
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a PurchaseOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

DELETE /api/order/po-line/

Description

Perform a DELETE operation against this list endpoint.

Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

Responses

204 No Content

---

GET /api/order/po-line/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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	integer		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_detail	query	boolean	False	No	Include detailed information about the sales order in the response
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
part_detail	query	boolean	False	No	Include detailed information about the related part in the response
pending	query	boolean		No	Order Pending
received	query	boolean		No	Items Received
search	query	string		No	A search term. Searched fields: part__SKU, part__manufacturer_part__MPN, part__part__description, part__part__name, reference.

Responses

200 OK

application/json

{
    "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,
            "build_order": 0,
            "build_order_detail": null,
            "destination": 0,
            "destination_detail": null,
            "discount": 10.12,
            "internal_part": 0,
            "internal_part_name": "string",
            "ipn": "string",
            "line": "string",
            "link": null,
            "merge_items": true,
            "mpn": "string",
            "notes": "string",
            "order": 0,
            "order_detail": null,
            "overdue": true,
            "part": 0,
            "part_detail": null,
            "pk": 0,
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "purchase_price": "string",
            "purchase_price_currency": "string",
            "quantity": 10.12,
            "received": 10.12,
            "reference": "string",
            "sku": "string",
            "supplier_part_detail": null,
            "target_date": "2022-04-13",
            "total_price": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "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
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

---

DELETE /api/order/po-line/{id}/

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/po-line/{id}/

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
part_detail	query	boolean	False	No	Include detailed information about the related part in the response

Responses

200 OK

application/json

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

---

PATCH /api/order/po-line/{id}/

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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"
}

Responses

200 OK

application/json

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

---

PUT /api/order/po-line/{id}/

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "discount": 10.12,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": null,
    "merge_items": true,
    "mpn": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "purchase_price": "string",
    "purchase_price_currency": "string",
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "sku": "string",
    "supplier_part_detail": null,
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for the PurchaseOrderLineItem model.",
    "properties": {
        "auto_pricing": {
            "default": false,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "build_order": {
            "description": "External Build Order to be fulfilled by this line item",
            "nullable": true,
            "type": "integer"
        },
        "build_order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Build"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "destination": {
            "description": "Destination for received items",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "internal_part": {
            "readOnly": true,
            "type": "integer"
        },
        "internal_part_name": {
            "readOnly": true,
            "type": "string"
        },
        "ipn": {
            "nullable": true,
            "readOnly": true,
            "title": "Internal Part Number",
            "type": "string"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PurchaseOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "nullable": true,
            "title": "Supplier Part",
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "description": "Purchase price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "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": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier_part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SupplierPart"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "target_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": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received"
    ],
    "type": "object"
}

---

GET /api/order/po/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
completed_after	query	string		No	Completed After
completed_before	query	string		No	Completed Before
created_after	query	string		No	Created After
created_before	query	string		No	Created Before
created_by	query	integer		No	Created By
external_build	query	integer		No	External Build Order
has_project_code	query	boolean		No	Has Project Code
has_start_date	query	boolean		No	Has Start Date
has_target_date	query	boolean		No	Has Target Date
limit	query	integer		No	Number of results to return per page.
max_date	query	string		No	Max Date
min_date	query	string		No	Min Date
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
part	query	integer		No	Part
project_code	query	integer		No	Project Code
reference	query	string		No	Order Reference
search	query	string		No	A search term. Searched fields: description, project_code__code, reference, supplier__name, supplier_reference.
start_date_after	query	string		No	Start Date After
start_date_before	query	string		No	Start Date Before
status	query	integer		No	Order Status
supplier	query	integer		No
supplier_detail	query	boolean	False	No	Include detailed information about the supplier in the response
supplier_part	query	integer		No	Supplier Part
tags	query	string		No	Tags
target_date_after	query	string		No	Target Date After
target_date_before	query	string		No	Target Date Before
updated_after	query	string		No	Updated After
updated_before	query	string		No	Updated Before

Responses

200 OK

application/json

{
    "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,
            "created_by": null,
            "creation_date": "2022-04-13",
            "description": "string",
            "destination": 0,
            "duplicate": null,
            "issue_date": "2022-04-13",
            "line_items": 0,
            "link": null,
            "notes": "string",
            "order_currency": "string",
            "overdue": true,
            "parameters": [
                {
                    "data": "string",
                    "data_numeric": 10.12,
                    "model_id": 0,
                    "model_type": null,
                    "note": "string",
                    "pk": 0,
                    "template": 0,
                    "template_detail": null,
                    "updated": "2022-04-13T15:42:05.901Z",
                    "updated_by": 0,
                    "updated_by_detail": null
                }
            ],
            "pk": 0,
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "reference": "string",
            "responsible": 0,
            "responsible_detail": null,
            "start_date": "2022-04-13",
            "status": 0,
            "status_custom_key": 0,
            "status_text": "string",
            "supplier": 0,
            "supplier_detail": null,
            "supplier_name": "string",
            "supplier_reference": "string",
            "tags": [
                "string"
            ],
            "target_date": "2022-04-13",
            "total_price": "string",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "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
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 206,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 294,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 257,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 235,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

---

GET /api/order/po/status/

Description

Retrieve information about a specific status code

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"

Responses

200 OK400 Bad Request

application/json

{
    "status_class": "string",
    "values": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "API serializer for generic state class information.",
    "properties": {
        "status_class": {
            "readOnly": true,
            "title": "Class",
            "type": "string"
        },
        "values": {
            "additionalProperties": {
                "$ref": "#/components/schemas/GenericStateValue"
            },
            "type": "object"
        }
    },
    "required": [
        "status_class",
        "values"
    ],
    "type": "object"
}

---

DELETE /api/order/po/{id}/

Description

API endpoint for detail view of a PurchaseOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

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
oauth2	header	string	N/A	No
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
supplier_detail	query	boolean	False	No	Include detailed information about the supplier in the response

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 231,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "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
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 126,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "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,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 2,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "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,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 254,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 56,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "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
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 241,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 231,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 164,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "destination": 0,
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 292,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_detail": null,
    "supplier_name": "string",
    "supplier_reference": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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"
                }
            ],
            "nullable": true,
            "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": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "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/PurchaseOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "supplier_name": {
            "readOnly": true,
            "type": "string"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "supplier",
        "supplier_name"
    ],
    "type": "object"
}

---

POST /api/order/po/{id}/cancel/

Description

API endpoint to 'cancel' a purchase order.

The purchase order must be in a state which can be cancelled

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/po/{id}/complete/

Description

API endpoint to 'complete' a purchase order.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for completing a purchase order.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for completing a purchase order.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for completing a purchase order.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

Responses

201 Created

application/json

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for completing a purchase order.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

---

POST /api/order/po/{id}/hold/

Description

API endpoint to place a PurchaseOrder on hold.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/po/{id}/issue/

Description

API endpoint to 'issue' (place) a PurchaseOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/po/{id}/receive/

Description

API endpoint to receive stock items against a PurchaseOrder.

• The purchase order is specified in the URL.
• Items to receive are specified as a list called "items" with the following options:
  • line_item: pk of the PO Line item
  • supplier_part: pk value of the supplier part
  • quantity: quantity to receive
  • status: stock item status
  • expiry_date: stock item expiry date (optional)
  • location: destination for stock item (optional)
  • batch_code: the batch code for this stock item
  • serial_numbers: serial numbers for this stock item
• A global location must also be specified. This is used when no locations are specified for items, and no location is given in the PO line item

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "items": [
        {
            "barcode": "string",
            "batch_code": "string",
            "expiry_date": "2022-04-13",
            "line_item": 0,
            "location": 0,
            "note": "string",
            "packaging": "string",
            "quantity": "string",
            "serial_numbers": "string",
            "status": null
        }
    ],
    "location": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for receiving items against a PurchaseOrder.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/PurchaseOrderLineItemReceive"
            },
            "type": "array"
        },
        "location": {
            "description": "Select destination location for received items",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "items"
    ],
    "type": "object"
}

{
    "items": [
        {
            "barcode": "string",
            "batch_code": "string",
            "expiry_date": "2022-04-13",
            "line_item": 0,
            "location": 0,
            "note": "string",
            "packaging": "string",
            "quantity": "string",
            "serial_numbers": "string",
            "status": null
        }
    ],
    "location": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for receiving items against a PurchaseOrder.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/PurchaseOrderLineItemReceive"
            },
            "type": "array"
        },
        "location": {
            "description": "Select destination location for received items",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "items"
    ],
    "type": "object"
}

{
    "items": [
        {
            "barcode": "string",
            "batch_code": "string",
            "expiry_date": "2022-04-13",
            "line_item": 0,
            "location": 0,
            "note": "string",
            "packaging": "string",
            "quantity": "string",
            "serial_numbers": "string",
            "status": null
        }
    ],
    "location": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for receiving items against a PurchaseOrder.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/PurchaseOrderLineItemReceive"
            },
            "type": "array"
        },
        "location": {
            "description": "Select destination location for received items",
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "items"
    ],
    "type": "object"
}

Responses

201 Created

application/json

[
    {
        "MPN": "string",
        "SKU": "string",
        "allocated": 10.12,
        "barcode_hash": "string",
        "batch": "string",
        "belongs_to": 0,
        "build": 0,
        "child_items": 0,
        "consumed_by": 0,
        "creation_date": "2022-04-13T15:42:05.901Z",
        "customer": 0,
        "delete_on_deplete": true,
        "expired": true,
        "expiry_date": "2022-04-13",
        "in_stock": true,
        "installed_items": 0,
        "is_building": true,
        "link": null,
        "location": 0,
        "location_detail": null,
        "location_path": [
            {
                "icon": "string",
                "name": "string",
                "pk": 0
            }
        ],
        "notes": "string",
        "owner": 0,
        "packaging": "string",
        "parent": 0,
        "part": 0,
        "part_detail": null,
        "pk": 0,
        "purchase_order": 0,
        "purchase_order_reference": "string",
        "purchase_price": "string",
        "purchase_price_currency": "string",
        "quantity": 10.12,
        "sales_order": 0,
        "sales_order_reference": "string",
        "serial": "string",
        "serial_numbers": "string",
        "stale": true,
        "status": null,
        "status_custom_key": 0,
        "status_text": "string",
        "stocktake_date": "2022-04-13",
        "supplier_part": 0,
        "supplier_part_detail": null,
        "tags": [
            "string"
        ],
        "tests": [
            {
                "attachment": "string",
                "date": "2022-04-13T15:42:05.901Z",
                "finished_datetime": "2022-04-13T15:42:05.901Z",
                "notes": "string",
                "pk": 0,
                "result": true,
                "started_datetime": "2022-04-13T15:42:05.901Z",
                "stock_item": 0,
                "template": 0,
                "template_detail": null,
                "test_station": "string",
                "user": 0,
                "user_detail": null,
                "value": "string"
            }
        ],
        "tracking_items": 0,
        "updated": "2022-04-13T15:42:05.901Z",
        "use_pack_size": true
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "items": {
        "$ref": "#/components/schemas/StockItem"
    },
    "type": "array"
}

---

DELETE /api/order/ro-extra-line/

Description

Perform a DELETE operation against this list endpoint.

Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

Responses

204 No Content

---

GET /api/order/ro-extra-line/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
ordering	query	string		No	Which field to use when ordering the results.
search	query	string		No	A search term. Searched fields: description, notes, quantity, reference.

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "description": "string",
            "discount": 10.12,
            "line": "string",
            "link": null,
            "notes": "string",
            "order": 0,
            "order_detail": null,
            "pk": 0,
            "price": "string",
            "price_currency": "string",
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "quantity": 10.12,
            "reference": "string",
            "target_date": "2022-04-13",
            "total_price": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/ReturnOrderExtraLine"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

POST /api/order/ro-extra-line/

Description

API endpoint for accessing a list of ReturnOrderExtraLine objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

DELETE /api/order/ro-extra-line/{id}/

Description

API endpoint for detail view of a ReturnOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/ro-extra-line/{id}/

Description

API endpoint for detail view of a ReturnOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PATCH /api/order/ro-extra-line/{id}/

Description

API endpoint for detail view of a ReturnOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PUT /api/order/ro-extra-line/{id}/

Description

API endpoint for detail view of a ReturnOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

DELETE /api/order/ro-line/

Description

Perform a DELETE operation against this list endpoint.

Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

Responses

204 No Content

---

GET /api/order/ro-line/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"
has_pricing	query	boolean		No	Has Pricing
item	query	integer		No
item_detail	query	boolean	True	No	Include detailed information about the item in the response
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_detail	query	boolean	False	No	Include detailed information about the sales order in the response
order_status	query	integer		No	Order Status
ordering	query	string		No	Which field to use when ordering the results.
outcome	query	integer		No	outcome
part_detail	query	boolean	False	No	Include detailed information about the related part in the response
received	query	boolean		No	received
search	query	string		No	A search term. Searched fields: item__part__description, item__part__name, item__serial, reference.

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "discount": 10.12,
            "item": 0,
            "item_detail": null,
            "line": "string",
            "link": null,
            "notes": "string",
            "order": 0,
            "order_detail": null,
            "outcome": null,
            "part_detail": null,
            "pk": 0,
            "price": "string",
            "price_currency": "string",
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "quantity": 10.12,
            "received_date": "2022-04-13",
            "reference": "string",
            "target_date": "2022-04-13"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/ReturnOrderLineItem"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

POST /api/order/ro-line/

Description

API endpoint for accessing a list of ReturnOrderLineItemList objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

GET /api/order/ro-line/status/

Description

Retrieve information about a specific status code

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"

Responses

200 OK400 Bad Request

application/json

{
    "status_class": "string",
    "values": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "API serializer for generic state class information.",
    "properties": {
        "status_class": {
            "readOnly": true,
            "title": "Class",
            "type": "string"
        },
        "values": {
            "additionalProperties": {
                "$ref": "#/components/schemas/GenericStateValue"
            },
            "type": "object"
        }
    },
    "required": [
        "status_class",
        "values"
    ],
    "type": "object"
}

---

DELETE /api/order/ro-line/{id}/

Description

API endpoint for detail view of a ReturnOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/ro-line/{id}/

Description

API endpoint for detail view of a ReturnOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
item_detail	query	boolean	True	No	Include detailed information about the item in the response
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
part_detail	query	boolean	False	No	Include detailed information about the related part in the response

Responses

200 OK

application/json

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PATCH /api/order/ro-line/{id}/

Description

API endpoint for detail view of a ReturnOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PUT /api/order/ro-line/{id}/

Description

API endpoint for detail view of a ReturnOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "discount": 10.12,
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "outcome": null,
    "part_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "received_date": "2022-04-13",
    "reference": "string",
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a ReturnOrderLineItem object.",
    "properties": {
        "discount": {
            "format": "double",
            "type": "number"
        },
        "item": {
            "description": "Select item to return from customer",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Return Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "outcome": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/OutcomeEnum"
                }
            ],
            "description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject",
            "maximum": 9223372036854775807,
            "minimum": 0
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Line price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "description": "Quantity to return",
            "format": "double",
            "type": "number"
        },
        "received_date": {
            "description": "The date this return item was received",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

GET /api/order/ro/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
completed_after	query	string		No	Completed After
completed_before	query	string		No	Completed Before
created_after	query	string		No	Created After
created_before	query	string		No	Created Before
created_by	query	integer		No	Created By
customer	query	integer		No
customer_detail	query	boolean	False	No	Include detailed information about the customer in the response
has_project_code	query	boolean		No	Has Project Code
has_start_date	query	boolean		No	Has Start Date
has_target_date	query	boolean		No	Has Target Date
include_variants	query	boolean		No	Include Variants
limit	query	integer		No	Number of results to return per page.
max_date	query	string		No	Max Date
min_date	query	string		No	Min Date
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
part	query	integer		No
project_code	query	integer		No	Project Code
reference	query	string		No	Order Reference
search	query	string		No	A search term. Searched fields: customer__name, customer_reference, description, project_code__code, reference.
start_date_after	query	string		No	Start Date After
start_date_before	query	string		No	Start Date Before
status	query	integer		No	Order Status
tags	query	string		No	Tags
target_date_after	query	string		No	Target Date After
target_date_before	query	string		No	Target Date Before
updated_after	query	string		No	Updated After
updated_before	query	string		No	Updated Before

Responses

200 OK

application/json

{
    "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,
            "created_by": null,
            "creation_date": "2022-04-13",
            "customer": 0,
            "customer_detail": null,
            "customer_reference": "string",
            "description": "string",
            "duplicate": null,
            "issue_date": "2022-04-13",
            "line_items": 0,
            "link": null,
            "notes": "string",
            "order_currency": "string",
            "overdue": true,
            "parameters": [
                {
                    "data": "string",
                    "data_numeric": 10.12,
                    "model_id": 197,
                    "model_type": null,
                    "note": "string",
                    "pk": 0,
                    "template": 0,
                    "template_detail": null,
                    "updated": "2022-04-13T15:42:05.901Z",
                    "updated_by": 0,
                    "updated_by_detail": null
                }
            ],
            "pk": 0,
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "reference": "string",
            "responsible": 0,
            "responsible_detail": null,
            "start_date": "2022-04-13",
            "status": 0,
            "status_custom_key": 0,
            "status_text": "string",
            "tags": [
                "string"
            ],
            "target_date": "2022-04-13",
            "total_price": "string",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/ReturnOrder"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

POST /api/order/ro/

Description

API endpoint for accessing a list of ReturnOrder objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 248,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 202,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 29,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 60,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

GET /api/order/ro/status/

Description

Retrieve information about a specific status code

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"

Responses

200 OK400 Bad Request

application/json

{
    "status_class": "string",
    "values": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "API serializer for generic state class information.",
    "properties": {
        "status_class": {
            "readOnly": true,
            "title": "Class",
            "type": "string"
        },
        "values": {
            "additionalProperties": {
                "$ref": "#/components/schemas/GenericStateValue"
            },
            "type": "object"
        }
    },
    "required": [
        "status_class",
        "values"
    ],
    "type": "object"
}

---

DELETE /api/order/ro/{id}/

Description

API endpoint for detail view of a single ReturnOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/ro/{id}/

Description

API endpoint for detail view of a single ReturnOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"
customer_detail	query	boolean	False	No	Include detailed information about the customer in the response
id	path	integer		No

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 260,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

PATCH /api/order/ro/{id}/

Description

API endpoint for detail view of a single ReturnOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 135,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "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,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 20,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "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,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 33,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 263,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

PUT /api/order/ro/{id}/

Description

API endpoint for detail view of a single ReturnOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 141,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 28,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 201,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 2,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the ReturnOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company from which items are being returned",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ReturnOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

POST /api/order/ro/{id}/cancel/

Description

API endpoint to cancel a ReturnOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/ro/{id}/complete/

Description

API endpoint to complete a ReturnOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/ro/{id}/hold/

Description

API endpoint to hold a ReturnOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/ro/{id}/issue/

Description

API endpoint to issue (place) a ReturnOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/ro/{id}/receive/

Description

API endpoint to receive items against a ReturnOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "items": [
        {
            "item": 0,
            "status": null
        }
    ],
    "location": 0,
    "note": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for receiving items against a ReturnOrder.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/ReturnOrderLineItemReceive"
            },
            "type": "array"
        },
        "location": {
            "description": "Select destination location for received items",
            "type": "integer"
        },
        "note": {
            "default": "",
            "description": "Additional note for incoming stock items",
            "type": "string"
        }
    },
    "required": [
        "items",
        "location"
    ],
    "type": "object"
}

{
    "items": [
        {
            "item": 0,
            "status": null
        }
    ],
    "location": 0,
    "note": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for receiving items against a ReturnOrder.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/ReturnOrderLineItemReceive"
            },
            "type": "array"
        },
        "location": {
            "description": "Select destination location for received items",
            "type": "integer"
        },
        "note": {
            "default": "",
            "description": "Additional note for incoming stock items",
            "type": "string"
        }
    },
    "required": [
        "items",
        "location"
    ],
    "type": "object"
}

{
    "items": [
        {
            "item": 0,
            "status": null
        }
    ],
    "location": 0,
    "note": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for receiving items against a ReturnOrder.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/ReturnOrderLineItemReceive"
            },
            "type": "array"
        },
        "location": {
            "description": "Select destination location for received items",
            "type": "integer"
        },
        "note": {
            "default": "",
            "description": "Additional note for incoming stock items",
            "type": "string"
        }
    },
    "required": [
        "items",
        "location"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "items": [
        {
            "item": 0,
            "status": null
        }
    ],
    "location": 0,
    "note": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for receiving items against a ReturnOrder.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/ReturnOrderLineItemReceive"
            },
            "type": "array"
        },
        "location": {
            "description": "Select destination location for received items",
            "type": "integer"
        },
        "note": {
            "default": "",
            "description": "Additional note for incoming stock items",
            "type": "string"
        }
    },
    "required": [
        "items",
        "location"
    ],
    "type": "object"
}

---

DELETE /api/order/so-allocation/

Description

Perform a DELETE operation against this list endpoint.

Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

Responses

204 No Content

---

GET /api/order/so-allocation/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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_shipment	query	boolean		No	Has Shipment
customer_detail	query	boolean	False	No	Include detailed information about the customer in the response
include_variants	query	boolean		No	Include Variants
item	query	integer		No
item_detail	query	boolean	False	No	Include detailed information about the item in the response
limit	query	integer		No	Number of results to return per page.
line	query	integer		No
location	query	integer		No	Location
location_detail	query	boolean	False	No	Include detailed information about the stock location in the response
offset	query	integer		No	The initial index from which to return the results.
order	query	integer		No	Order
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
ordering	query	string		No	Which field to use when ordering the results.
outstanding	query	boolean		No	Outstanding
part	query	integer		No	Part
part_detail	query	boolean	False	No	Include detailed information about the related part in the response
search	query	string		No	A search term. Searched fields: item__batch, item__part__IPN, item__part__name, item__serial.
shipment	query	integer		No

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "customer_detail": null,
            "item": 0,
            "item_detail": null,
            "line": 0,
            "location": 0,
            "location_detail": null,
            "order": 0,
            "order_detail": null,
            "part": 0,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "serial": "string",
            "shipment": 0,
            "shipment_detail": null
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/SalesOrderAllocation"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

PATCH /api/order/so-allocation/

Description

Perform a PATCH operation against this list endpoint.

Note that the typical DRF list endpoint does not support PATCH, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PUT /api/order/so-allocation/

Description

Perform a PUT operation against this list endpoint.

Simply redirects to the PATCH method.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

DELETE /api/order/so-allocation/{id}/

Description

API endpoint for detail view of a SalesOrderAllocation object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/so-allocation/{id}/

Description

API endpoint for detail view of a SalesOrderAllocation object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

200 OK

application/json

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PATCH /api/order/so-allocation/{id}/

Description

API endpoint for detail view of a SalesOrderAllocation object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PUT /api/order/so-allocation/{id}/

Description

API endpoint for detail view of a SalesOrderAllocation object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "customer_detail": null,
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string",
    "shipment": 0,
    "shipment_detail": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipment": {
            "description": "Sales order shipment reference",
            "nullable": true,
            "type": "integer"
        },
        "shipment_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipment"
                }
            ],
            "nullable": true,
            "readOnly": true
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

DELETE /api/order/so-extra-line/

Description

Perform a DELETE operation against this list endpoint.

Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

Responses

204 No Content

---

GET /api/order/so-extra-line/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
ordering	query	string		No	Which field to use when ordering the results.
search	query	string		No	A search term. Searched fields: description, notes, quantity, reference.

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "description": "string",
            "discount": 10.12,
            "line": "string",
            "link": null,
            "notes": "string",
            "order": 0,
            "order_detail": null,
            "pk": 0,
            "price": "string",
            "price_currency": "string",
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "quantity": 10.12,
            "reference": "string",
            "target_date": "2022-04-13",
            "total_price": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/SalesOrderExtraLine"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

POST /api/order/so-extra-line/

Description

API endpoint for accessing a list of SalesOrderExtraLine objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

DELETE /api/order/so-extra-line/{id}/

Description

API endpoint for detail view of a SalesOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/so-extra-line/{id}/

Description

API endpoint for detail view of a SalesOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PATCH /api/order/so-extra-line/{id}/

Description

API endpoint for detail view of a SalesOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PUT /api/order/so-extra-line/{id}/

Description

API endpoint for detail view of a SalesOrderExtraLine object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "pk": 0,
    "price": "string",
    "price_currency": "string",
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderExtraLine object.",
    "properties": {
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "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": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

DELETE /api/order/so-line/

Description

Perform a DELETE operation against this list endpoint.

Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

{
    "filters": {},
    "items": [
        0
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Parameters for selecting items for bulk operations.",
    "properties": {
        "filters": {
            "additionalProperties": {},
            "title": "A dictionary of filter values",
            "type": "object"
        },
        "items": {
            "items": {
                "type": "integer"
            },
            "title": "A list of primary key values",
            "type": "array"
        }
    },
    "type": "object"
}

Responses

204 No Content

---

GET /api/order/so-line/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"
allocated	query	boolean		No	Allocated
completed	query	boolean		No	Completed
customer_detail	query	boolean	False	No	Include detailed information about the customer in the response
has_pricing	query	boolean		No	Has Pricing
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_detail	query	boolean	False	No	Include detailed information about the sales order in the response
order_outstanding	query	boolean		No	Order Outstanding
order_status	query	integer		No	Order Status
ordering	query	string		No	Which field to use when ordering the results.
part	query	integer		No
part_detail	query	boolean	False	No	Include detailed information about the related part in the response
search	query	string		No	A search term. Searched fields: part__name, quantity, reference.

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "allocated": 10.12,
            "available_stock": 10.12,
            "available_variant_stock": 10.12,
            "building": 10.12,
            "customer_detail": null,
            "discount": 10.12,
            "line": "string",
            "link": null,
            "notes": "string",
            "on_order": 10.12,
            "order": 0,
            "order_detail": null,
            "overdue": true,
            "part": 0,
            "part_detail": null,
            "pk": 0,
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "quantity": 10.12,
            "reference": "string",
            "sale_price": "string",
            "sale_price_currency": "string",
            "shipped": 10.12,
            "target_date": "2022-04-13"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/SalesOrderLineItem"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

POST /api/order/so-line/

Description

API endpoint for accessing a list of SalesOrderLineItem objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

---

DELETE /api/order/so-line/{id}/

Description

API endpoint for detail view of a SalesOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/so-line/{id}/

Description

API endpoint for detail view of a SalesOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"
customer_detail	query	boolean	False	No	Include detailed information about the customer in the response
id	path	integer		No
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
part_detail	query	boolean	False	No	Include detailed information about the related part in the response

Responses

200 OK

application/json

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

---

PATCH /api/order/so-line/{id}/

Description

API endpoint for detail view of a SalesOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

---

PUT /api/order/so-line/{id}/

Description

API endpoint for detail view of a SalesOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "allocated": 10.12,
    "available_stock": 10.12,
    "available_variant_stock": 10.12,
    "building": 10.12,
    "customer_detail": null,
    "discount": 10.12,
    "line": "string",
    "link": null,
    "notes": "string",
    "on_order": 10.12,
    "order": 0,
    "order_detail": null,
    "overdue": true,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "quantity": 10.12,
    "reference": "string",
    "sale_price": "string",
    "sale_price_currency": "string",
    "shipped": 10.12,
    "target_date": "2022-04-13"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a SalesOrderLineItem object.",
    "properties": {
        "allocated": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "available_variant_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "building": {
            "format": "double",
            "readOnly": true,
            "title": "In Production",
            "type": "number"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "discount": {
            "format": "double",
            "type": "number"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "on_order": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Part",
            "nullable": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "sale_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "sale_price_currency": {
            "description": "Sale price currency\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "title": "Currency",
            "type": "string"
        },
        "shipped": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "target_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        }
    },
    "required": [
        "allocated",
        "available_stock",
        "available_variant_stock",
        "building",
        "on_order",
        "order",
        "pk",
        "quantity",
        "shipped"
    ],
    "type": "object"
}

---

GET /api/order/so/

Description

Override the GET method to determine export options.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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
completed_after	query	string		No	Completed After
completed_before	query	string		No	Completed Before
created_after	query	string		No	Created After
created_before	query	string		No	Created Before
created_by	query	integer		No	Created By
customer	query	integer		No
customer_detail	query	boolean	False	No	Include detailed information about the customer in the response
has_project_code	query	boolean		No	Has Project Code
has_start_date	query	boolean		No	Has Start Date
has_target_date	query	boolean		No	Has Target Date
include_variants	query	boolean		No	Include Variants
limit	query	integer		No	Number of results to return per page.
max_date	query	string		No	Max Date
min_date	query	string		No	Min Date
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
part	query	integer		No
project_code	query	integer		No	Project Code
reference	query	string		No	Order Reference
search	query	string		No	A search term. Searched fields: customer__name, customer_reference, description, project_code__code, reference.
start_date_after	query	string		No	Start Date After
start_date_before	query	string		No	Start Date Before
status	query	integer		No	Order Status
tags	query	string		No	Tags
target_date_after	query	string		No	Target Date After
target_date_before	query	string		No	Target Date Before
updated_after	query	string		No	Updated After
updated_before	query	string		No	Updated Before

Responses

200 OK

application/json

{
    "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,
            "allocated_lines": 0,
            "barcode_hash": "string",
            "completed_lines": 0,
            "completed_shipments_count": 0,
            "contact": 0,
            "contact_detail": null,
            "created_by": null,
            "creation_date": "2022-04-13",
            "customer": 0,
            "customer_detail": null,
            "customer_reference": "string",
            "description": "string",
            "duplicate": null,
            "issue_date": "2022-04-13",
            "line_items": 0,
            "link": null,
            "notes": "string",
            "order_currency": "string",
            "overdue": true,
            "parameters": [
                {
                    "data": "string",
                    "data_numeric": 10.12,
                    "model_id": 42,
                    "model_type": null,
                    "note": "string",
                    "pk": 0,
                    "template": 0,
                    "template_detail": null,
                    "updated": "2022-04-13T15:42:05.901Z",
                    "updated_by": 0,
                    "updated_by_detail": null
                }
            ],
            "pk": 0,
            "project_code": 0,
            "project_code_detail": null,
            "project_code_label": "string",
            "reference": "string",
            "responsible": 0,
            "responsible_detail": null,
            "shipment_date": "2022-04-13",
            "shipments_count": 0,
            "start_date": "2022-04-13",
            "status": 0,
            "status_custom_key": 0,
            "status_text": "string",
            "tags": [
                "string"
            ],
            "target_date": "2022-04-13",
            "total_price": "string",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/SalesOrder"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

POST /api/order/so/

Description

API endpoint for accessing a list of SalesOrder objects.

• GET: Return list of SalesOrder objects (with filters)
• POST: Create a new SalesOrder

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 42,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 291,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 285,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 130,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

GET /api/order/so/shipment/

Description

API list endpoint for SalesOrderShipment model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"
checked	query	boolean		No	checked
delivered	query	boolean		No	delivered
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_outstanding	query	boolean		No	Order Outstanding
order_status	query	number		No	Order Status
ordering	query	string		No	Which field to use when ordering the results.
search	query	string		No	A search term. Searched fields: invoice_number, order__reference, reference, tracking_number.
shipped	query	boolean		No	shipped
tags	query	string		No	Tags

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "allocated_items": 0,
            "barcode_hash": "string",
            "checked_by": 0,
            "checked_by_detail": null,
            "customer_detail": null,
            "delivery_date": "2022-04-13",
            "duplicate": null,
            "invoice_number": "string",
            "link": null,
            "notes": "string",
            "order": 0,
            "order_detail": null,
            "parameters": [
                {
                    "data": "string",
                    "data_numeric": 10.12,
                    "model_id": 264,
                    "model_type": null,
                    "note": "string",
                    "pk": 0,
                    "template": 0,
                    "template_detail": null,
                    "updated": "2022-04-13T15:42:05.901Z",
                    "updated_by": 0,
                    "updated_by_detail": null
                }
            ],
            "pk": 0,
            "reference": "string",
            "shipment_address": 0,
            "shipment_address_detail": null,
            "shipment_date": "2022-04-13",
            "tags": [
                "string"
            ],
            "tracking_number": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/SalesOrderShipment"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

POST /api/order/so/shipment/

Description

API list endpoint for SalesOrderShipment model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 192,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 24,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 63,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 249,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

---

DELETE /api/order/so/shipment/{id}/

Description

API detail endpoint for SalesOrderShipment model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/so/shipment/{id}/

Description

API detail endpoint for SalesOrderShipment model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

200 OK

application/json

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 119,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

---

PATCH /api/order/so/shipment/{id}/

Description

API detail endpoint for SalesOrderShipment model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 225,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 218,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 169,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 171,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

---

PUT /api/order/so/shipment/{id}/

Description

API detail endpoint for SalesOrderShipment model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 207,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 26,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 152,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "allocated_items": 0,
    "barcode_hash": "string",
    "checked_by": 0,
    "checked_by_detail": null,
    "customer_detail": null,
    "delivery_date": "2022-04-13",
    "duplicate": null,
    "invoice_number": "string",
    "link": null,
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 158,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": null,
    "shipment_date": "2022-04-13",
    "tags": [
        "string"
    ],
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrderShipment class.",
    "properties": {
        "allocated_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "checked_by": {
            "description": "User who checked this shipment",
            "nullable": true,
            "type": "integer"
        },
        "checked_by_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderShipmentDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "description": "Sales Order",
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "reference": {
            "default": "1",
            "description": "Shipment number",
            "maxLength": 100,
            "title": "Shipment",
            "type": "string"
        },
        "shipment_address": {
            "description": "Shipping address for this shipment",
            "nullable": true,
            "title": "Address",
            "type": "integer"
        },
        "shipment_address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk"
    ],
    "type": "object"
}

---

POST /api/order/so/shipment/{id}/ship/

Description

Override the post method to handle shipment completion.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "delivery_date": "2022-04-13",
    "invoice_number": "string",
    "link": null,
    "shipment_date": "2022-04-13",
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for completing (shipping) a SalesOrderShipment.",
    "properties": {
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "delivery_date": "2022-04-13",
    "invoice_number": "string",
    "link": null,
    "shipment_date": "2022-04-13",
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for completing (shipping) a SalesOrderShipment.",
    "properties": {
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "delivery_date": "2022-04-13",
    "invoice_number": "string",
    "link": null,
    "shipment_date": "2022-04-13",
    "tracking_number": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for completing (shipping) a SalesOrderShipment.",
    "properties": {
        "delivery_date": {
            "description": "Date of delivery of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "type": "string"
                }
            ]
        },
        "shipment_date": {
            "description": "Date of shipment",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "tracking_number": {
            "description": "Shipment tracking information",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "complete": true,
    "exists": true,
    "http_status": 0,
    "pending": true,
    "success": true,
    "task_id": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a background task detail.",
    "properties": {
        "complete": {
            "readOnly": true,
            "type": "boolean"
        },
        "exists": {
            "readOnly": true,
            "type": "boolean"
        },
        "http_status": {
            "readOnly": true,
            "type": "integer"
        },
        "pending": {
            "readOnly": true,
            "type": "boolean"
        },
        "success": {
            "readOnly": true,
            "type": "boolean"
        },
        "task_id": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "complete",
        "exists",
        "http_status",
        "pending",
        "success",
        "task_id"
    ],
    "type": "object"
}

---

GET /api/order/so/status/

Description

Retrieve information about a specific status code

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"

Responses

200 OK400 Bad Request

application/json

{
    "status_class": "string",
    "values": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "API serializer for generic state class information.",
    "properties": {
        "status_class": {
            "readOnly": true,
            "title": "Class",
            "type": "string"
        },
        "values": {
            "additionalProperties": {
                "$ref": "#/components/schemas/GenericStateValue"
            },
            "type": "object"
        }
    },
    "required": [
        "status_class",
        "values"
    ],
    "type": "object"
}

---

DELETE /api/order/so/{id}/

Description

API endpoint for detail view of a SalesOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

204 No Content

---

GET /api/order/so/{id}/

Description

API endpoint for detail view of a SalesOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"
customer_detail	query	boolean	False	No	Include detailed information about the customer in the response
id	path	integer		No

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 107,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

PATCH /api/order/so/{id}/

Description

API endpoint for detail view of a SalesOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 182,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 152,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 26,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 136,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

PUT /api/order/so/{id}/

Description

API endpoint for detail view of a SalesOrder object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 254,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 233,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 42,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "address": 0,
    "address_detail": null,
    "allocated_lines": 0,
    "barcode_hash": "string",
    "completed_lines": 0,
    "completed_shipments_count": 0,
    "contact": 0,
    "contact_detail": null,
    "created_by": null,
    "creation_date": "2022-04-13",
    "customer": 0,
    "customer_detail": null,
    "customer_reference": "string",
    "description": "string",
    "duplicate": null,
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": null,
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 264,
            "model_type": null,
            "note": "string",
            "pk": 0,
            "template": 0,
            "template_detail": null,
            "updated": "2022-04-13T15:42:05.901Z",
            "updated_by": 0,
            "updated_by_detail": null
        }
    ],
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "project_code_label": "string",
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "string",
    "tags": [
        "string"
    ],
    "target_date": "2022-04-13",
    "total_price": "string",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the SalesOrder model class.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "allocated_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "completed_lines": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "completed_shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Completed Shipments",
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "created_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "customer": {
            "description": "Company to which the items are being sold",
            "nullable": true,
            "type": "integer"
        },
        "customer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "customer_reference": {
            "description": "Customer order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "duplicate": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalesOrderDuplicateOptions"
                }
            ],
            "description": "Specify options for duplicating this item",
            "title": "Duplication Options",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "oneOf": [
                {
                    "format": "uri",
                    "maxLength": 2000,
                    "type": "string"
                },
                {
                    "maxLength": 0,
                    "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` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
            "nullable": true,
            "type": "string"
        },
        "overdue": {
            "nullable": true,
            "readOnly": true,
            "type": "boolean"
        },
        "parameters": {
            "items": {
                "$ref": "#/components/schemas/Parameter"
            },
            "nullable": true,
            "readOnly": true,
            "type": "array"
        },
        "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "project_code_label": {
            "nullable": true,
            "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"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "shipment_date": {
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "shipments_count": {
            "nullable": true,
            "readOnly": true,
            "title": "Shipments",
            "type": "integer"
        },
        "start_date": {
            "description": "Scheduled start date for this order",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_custom_key": {
            "description": "Update order status to a custom value for this logical value",
            "nullable": true,
            "title": "Custom Status Key",
            "type": "integer"
        },
        "status_text": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "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"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status"
    ],
    "type": "object"
}

---

POST /api/order/so/{id}/allocate-serials/

Description

API endpoint to allocation stock items against a SalesOrder, by specifying serial numbers.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "line_item": 0,
    "quantity": 0,
    "serial_numbers": "string",
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
    "properties": {
        "line_item": {
            "type": "integer"
        },
        "quantity": {
            "minimum": 1,
            "type": "integer"
        },
        "serial_numbers": {
            "description": "Enter serial numbers to allocate",
            "type": "string"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "line_item",
        "quantity",
        "serial_numbers"
    ],
    "type": "object"
}

{
    "line_item": 0,
    "quantity": 0,
    "serial_numbers": "string",
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
    "properties": {
        "line_item": {
            "type": "integer"
        },
        "quantity": {
            "minimum": 1,
            "type": "integer"
        },
        "serial_numbers": {
            "description": "Enter serial numbers to allocate",
            "type": "string"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "line_item",
        "quantity",
        "serial_numbers"
    ],
    "type": "object"
}

{
    "line_item": 0,
    "quantity": 0,
    "serial_numbers": "string",
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
    "properties": {
        "line_item": {
            "type": "integer"
        },
        "quantity": {
            "minimum": 1,
            "type": "integer"
        },
        "serial_numbers": {
            "description": "Enter serial numbers to allocate",
            "type": "string"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "line_item",
        "quantity",
        "serial_numbers"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "line_item": 0,
    "quantity": 0,
    "serial_numbers": "string",
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
    "properties": {
        "line_item": {
            "type": "integer"
        },
        "quantity": {
            "minimum": 1,
            "type": "integer"
        },
        "serial_numbers": {
            "description": "Enter serial numbers to allocate",
            "type": "string"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "line_item",
        "quantity",
        "serial_numbers"
    ],
    "type": "object"
}

---

POST /api/order/so/{id}/allocate/

Description

API endpoint to allocate stock items against a SalesOrder.

• The SalesOrder is specified in the URL
• See the SalesOrderShipmentAllocationSerializer class

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "items": [
        {
            "line_item": 0,
            "quantity": "string",
            "stock_item": 0
        }
    ],
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for allocation of stock items against a sales order / shipment.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
            },
            "type": "array"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "items"
    ],
    "type": "object"
}

{
    "items": [
        {
            "line_item": 0,
            "quantity": "string",
            "stock_item": 0
        }
    ],
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for allocation of stock items against a sales order / shipment.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
            },
            "type": "array"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "items"
    ],
    "type": "object"
}

{
    "items": [
        {
            "line_item": 0,
            "quantity": "string",
            "stock_item": 0
        }
    ],
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for allocation of stock items against a sales order / shipment.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
            },
            "type": "array"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "items"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "items": [
        {
            "line_item": 0,
            "quantity": "string",
            "stock_item": 0
        }
    ],
    "shipment": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "DRF serializer for allocation of stock items against a sales order / shipment.",
    "properties": {
        "items": {
            "items": {
                "$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
            },
            "type": "array"
        },
        "shipment": {
            "nullable": true,
            "type": "integer"
        }
    },
    "required": [
        "items"
    ],
    "type": "object"
}

---

POST /api/order/so/{id}/auto-allocate/

Description

Validate parameters and offload auto-allocation to a background task.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "exclude_location": 0,
    "interchangeable": true,
    "line_items": [
        0
    ],
    "location": 0,
    "serialized_stock": null,
    "shipment": 0,
    "stock_sort_by": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for auto-allocating stock items against a SalesOrder.",
    "properties": {
        "exclude_location": {
            "description": "Exclude stock items from this location",
            "nullable": true,
            "type": "integer"
        },
        "interchangeable": {
            "default": true,
            "description": "Allow stock to be taken from multiple locations to fulfil a single line item",
            "title": "Interchangeable Stock",
            "type": "boolean"
        },
        "line_items": {
            "description": "Limit allocation to these line items (leave blank to allocate all lines)",
            "items": {
                "title": "Line Items",
                "type": "integer"
            },
            "type": "array"
        },
        "location": {
            "description": "Stock location where items are sourced (leave blank to use any location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "serialized_stock": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SerializedStockEnum"
                }
            ],
            "default": "any",
            "description": "Control whether serialized stock items are included in auto-allocation\n\n* `any` - Allow any stock (serialized or unserialized)\n* `serialized` - Serialized stock only\n* `unserialized` - Unserialized stock only"
        },
        "shipment": {
            "description": "Assign allocations to this shipment",
            "nullable": true,
            "type": "integer"
        },
        "stock_sort_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockSortByEnum"
                }
            ],
            "default": "updated",
            "description": "Preferred order in which matching stock items are consumed\n\n* `updated` - Oldest stock first (FIFO)\n* `-updated` - Newest stock first (LIFO)\n* `quantity` - Smallest quantity first\n* `-quantity` - Largest quantity first\n* `expiry_date` - Soonest expiry date first",
            "title": "Stock Priority"
        }
    },
    "type": "object"
}

{
    "exclude_location": 0,
    "interchangeable": true,
    "line_items": [
        0
    ],
    "location": 0,
    "serialized_stock": null,
    "shipment": 0,
    "stock_sort_by": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for auto-allocating stock items against a SalesOrder.",
    "properties": {
        "exclude_location": {
            "description": "Exclude stock items from this location",
            "nullable": true,
            "type": "integer"
        },
        "interchangeable": {
            "default": true,
            "description": "Allow stock to be taken from multiple locations to fulfil a single line item",
            "title": "Interchangeable Stock",
            "type": "boolean"
        },
        "line_items": {
            "description": "Limit allocation to these line items (leave blank to allocate all lines)",
            "items": {
                "title": "Line Items",
                "type": "integer"
            },
            "type": "array"
        },
        "location": {
            "description": "Stock location where items are sourced (leave blank to use any location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "serialized_stock": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SerializedStockEnum"
                }
            ],
            "default": "any",
            "description": "Control whether serialized stock items are included in auto-allocation\n\n* `any` - Allow any stock (serialized or unserialized)\n* `serialized` - Serialized stock only\n* `unserialized` - Unserialized stock only"
        },
        "shipment": {
            "description": "Assign allocations to this shipment",
            "nullable": true,
            "type": "integer"
        },
        "stock_sort_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockSortByEnum"
                }
            ],
            "default": "updated",
            "description": "Preferred order in which matching stock items are consumed\n\n* `updated` - Oldest stock first (FIFO)\n* `-updated` - Newest stock first (LIFO)\n* `quantity` - Smallest quantity first\n* `-quantity` - Largest quantity first\n* `expiry_date` - Soonest expiry date first",
            "title": "Stock Priority"
        }
    },
    "type": "object"
}

{
    "exclude_location": 0,
    "interchangeable": true,
    "line_items": [
        0
    ],
    "location": 0,
    "serialized_stock": null,
    "shipment": 0,
    "stock_sort_by": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for auto-allocating stock items against a SalesOrder.",
    "properties": {
        "exclude_location": {
            "description": "Exclude stock items from this location",
            "nullable": true,
            "type": "integer"
        },
        "interchangeable": {
            "default": true,
            "description": "Allow stock to be taken from multiple locations to fulfil a single line item",
            "title": "Interchangeable Stock",
            "type": "boolean"
        },
        "line_items": {
            "description": "Limit allocation to these line items (leave blank to allocate all lines)",
            "items": {
                "title": "Line Items",
                "type": "integer"
            },
            "type": "array"
        },
        "location": {
            "description": "Stock location where items are sourced (leave blank to use any location)",
            "nullable": true,
            "title": "Source Location",
            "type": "integer"
        },
        "serialized_stock": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SerializedStockEnum"
                }
            ],
            "default": "any",
            "description": "Control whether serialized stock items are included in auto-allocation\n\n* `any` - Allow any stock (serialized or unserialized)\n* `serialized` - Serialized stock only\n* `unserialized` - Unserialized stock only"
        },
        "shipment": {
            "description": "Assign allocations to this shipment",
            "nullable": true,
            "type": "integer"
        },
        "stock_sort_by": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockSortByEnum"
                }
            ],
            "default": "updated",
            "description": "Preferred order in which matching stock items are consumed\n\n* `updated` - Oldest stock first (FIFO)\n* `-updated` - Newest stock first (LIFO)\n* `quantity` - Smallest quantity first\n* `-quantity` - Largest quantity first\n* `expiry_date` - Soonest expiry date first",
            "title": "Stock Priority"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "complete": true,
    "exists": true,
    "http_status": 0,
    "pending": true,
    "success": true,
    "task_id": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for a background task detail.",
    "properties": {
        "complete": {
            "readOnly": true,
            "type": "boolean"
        },
        "exists": {
            "readOnly": true,
            "type": "boolean"
        },
        "http_status": {
            "readOnly": true,
            "type": "integer"
        },
        "pending": {
            "readOnly": true,
            "type": "boolean"
        },
        "success": {
            "readOnly": true,
            "type": "boolean"
        },
        "task_id": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "complete",
        "exists",
        "http_status",
        "pending",
        "success",
        "task_id"
    ],
    "type": "object"
}

---

POST /api/order/so/{id}/cancel/

Description

API endpoint to cancel a SalesOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/so/{id}/complete/

Description

API endpoint for manually marking a SalesOrder as "complete".

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for manually marking a sales order as complete.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for manually marking a sales order as complete.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "DRF serializer for manually marking a sales order as complete.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

Responses

201 Created

application/json

{
    "accept_incomplete": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "DRF serializer for manually marking a sales order as complete.",
    "properties": {
        "accept_incomplete": {
            "default": false,
            "description": "Allow order to be closed with incomplete line items",
            "type": "boolean"
        }
    },
    "type": "object"
}

---

POST /api/order/so/{id}/hold/

Description

API endpoint to place a SalesOrder on hold.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

POST /api/order/so/{id}/issue/

Description

API endpoint to issue a SalesOrder.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

Responses

201 Created

---

GET /api/order/transfer-order-allocation/

Description

API endpoint for listing TransferOrderAllocation objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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"
include_variants	query	boolean		No	Include Variants
item	query	integer		No
item_detail	query	boolean	False	No	Include detailed information about the item in the response
limit	query	integer		No	Number of results to return per page.
line	query	integer		No
location	query	integer		No	Location
location_detail	query	boolean	False	No	Include detailed information about the stock location in the response
offset	query	integer		No	The initial index from which to return the results.
order	query	integer		No	Order
order_detail	query	boolean	False	No	Include detailed information about the sales order in the response
ordering	query	string		No	Which field to use when ordering the results.
outstanding	query	boolean		No	Outstanding
part	query	integer		No	Part
part_detail	query	boolean	False	No	Include detailed information about the related part in the response
search	query	string		No	A search term. Searched fields: item__batch, item__part__IPN, item__part__name, item__serial.

Responses

200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "item": 0,
            "item_detail": null,
            "line": 0,
            "location": 0,
            "location_detail": null,
            "order": 0,
            "order_detail": null,
            "part": 0,
            "part_detail": null,
            "pk": 0,
            "quantity": 10.12,
            "serial": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/TransferOrderAllocation"
            },
            "type": "array"
        }
    },
    "required": [
        "count",
        "results"
    ],
    "type": "object"
}

---

PATCH /api/order/transfer-order-allocation/

Description

Perform a PATCH operation against this list endpoint.

Note that the typical DRF list endpoint does not support PATCH, so this method is provided as a custom implementation.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the TransferOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TransferOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the TransferOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TransferOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the TransferOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TransferOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer for the TransferOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TransferOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

PUT /api/order/transfer-order-allocation/

Description

Perform a PUT operation against this list endpoint.

Simply redirects to the PATCH method.

Input parameters

Parameter	In	Type	Default	Nullable	Description
oauth2	header	string	N/A	No
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the TransferOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TransferOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the TransferOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly": true,
            "type": "integer"
        },
        "location_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "order": {
            "readOnly": true,
            "type": "integer"
        },
        "order_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/TransferOrder"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "part": {
            "readOnly": true,
            "type": "integer"
        },
        "part_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/PartBrief"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "serial": {
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "item",
        "line",
        "location",
        "order",
        "part",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "item": 0,
    "item_detail": null,
    "line": 0,
    "location": 0,
    "location_detail": null,
    "order": 0,
    "order_detail": null,
    "part": 0,
    "part_detail": null,
    "pk": 0,
    "quantity": 10.12,
    "serial": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer for the TransferOrderAllocation model.\n\nThis includes some fields from the related model objects.",
    "properties": {
        "item": {
            "description": "Select stock item to allocate",
            "type": "integer"
        },
        "item_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StockItem"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "line": {
            "readOnly": true,
            "type": "integer"
        },
        "location": {
            "readOnly":