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

InvenTree API 477

API for InvenTree - the intuitive open source inventory management system

---

License: MIT

Servers

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

order

---

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",
            "line": "string",
            "link": "string",
            "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"
        }
    ]
}

⚠️ 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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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,
            "internal_part": 0,
            "internal_part_name": "string",
            "ipn": "string",
            "line": "string",
            "link": "string",
            "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": 10.12
        }
    ]
}

⚠️ 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,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

---

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

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

---

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

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

---

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

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "auto_pricing": true,
    "build_order": 0,
    "build_order_detail": null,
    "destination": 0,
    "destination_detail": null,
    "internal_part": 0,
    "internal_part_name": "string",
    "ipn": "string",
    "line": "string",
    "link": "string",
    "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": 10.12
}

⚠️ 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
        },
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "internal_part",
        "internal_part_name",
        "order",
        "part",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "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
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": "string",
            "notes": "string",
            "order_currency": "string",
            "overdue": true,
            "parameters": [
                {
                    "data": "string",
                    "data_numeric": 10.12,
                    "model_id": 222,
                    "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",
            "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 70,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 227,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 148,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 51,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 81,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 146,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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": "string",
    "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,
    "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 102,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 52,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 213,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 166,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": "string",
    "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,
    "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "writeOnly": true
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "nullable": true,
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "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"
        },
        "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",
        "status_text",
        "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": 0
        }
    ],
    "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": 0
        }
    ],
    "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": 0
        }
    ],
    "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,
        "customer": 0,
        "delete_on_deplete": true,
        "expired": true,
        "expiry_date": "2022-04-13",
        "in_stock": true,
        "installed_items": 0,
        "is_building": true,
        "link": "string",
        "location": 0,
        "location_detail": null,
        "location_path": [
            {}
        ],
        "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"
}

---

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",
            "line": "string",
            "link": "string",
            "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"
        }
    ]
}

⚠️ 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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

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": [
        {
            "item": 0,
            "item_detail": null,
            "line": "string",
            "link": "string",
            "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

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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"
}

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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"
}

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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"
}

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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"
}

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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"
}

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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"
}

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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

{
    "item": 0,
    "item_detail": null,
    "line": "string",
    "link": "string",
    "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": {
        "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",
            "format": "uri",
            "maxLength": 2000,
            "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
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": "string",
            "notes": "string",
            "order_currency": "string",
            "overdue": true,
            "parameters": [
                {
                    "data": "string",
                    "data_numeric": 10.12,
                    "model_id": 245,
                    "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",
            "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 101,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 220,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 150,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 221,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 189,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 89,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 12,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 22,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 153,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 244,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 237,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 160,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": 0
        }
    ],
    "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": 0
        }
    ],
    "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": 0
        }
    ],
    "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": 0
        }
    ],
    "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"
}

---

GET /api/order/so-allocation/

Description

API endpoint for listing SalesOrderAllocation 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"
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"
}

---

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",
            "line": "string",
            "link": "string",
            "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"
        }
    ]
}

⚠️ 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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

201 Created

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "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",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Responses

200 OK

application/json

{
    "description": "string",
    "line": "string",
    "link": "string",
    "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"
}

⚠️ 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"
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

---

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,
            "line": "string",
            "link": "string",
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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,
    "line": "string",
    "link": "string",
    "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
        },
        "line": {
            "description": "Line number for this item (optional)",
            "maxLength": 20,
            "title": "Line Number",
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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
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": "string",
            "notes": "string",
            "order_currency": "string",
            "overdue": true,
            "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,
            "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",
            "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 81,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 9,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 187,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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

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",
            "invoice_number": "string",
            "link": "string",
            "notes": "string",
            "order": 0,
            "order_detail": null,
            "parameters": [
                {
                    "data": "string",
                    "data_numeric": 10.12,
                    "model_id": 132,
                    "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",
            "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 275,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 31,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 205,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "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,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": 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 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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 146,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 159,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 137,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "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,
    "reference": "string",
    "shipment_address": 0,
    "shipment_address_detail": 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 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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 281,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 19,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 12,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 118,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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",
    "invoice_number": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "order_detail": null,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 121,
            "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",
    "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"
        },
        "invoice_number": {
            "description": "Reference number for associated invoice",
            "maxLength": 100,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 2000,
            "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"
        },
        "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": "string",
    "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "string",
    "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "string",
    "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 246,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 265,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "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": "string",
    "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,
    "shipment_date": "2022-04-13",
    "shipments_count": 0,
    "start_date": "2022-04-13",
    "status": 0,
    "status_custom_key": 0,
    "status_text": "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 95,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 224,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 212,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 159,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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": "string",
    "notes": "string",
    "order_currency": "string",
    "overdue": true,
    "parameters": [
        {
            "data": "string",
            "data_numeric": 10.12,
            "model_id": 139,
            "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",
    "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/DuplicateOrder"
                }
            ],
            "description": "Specify options for duplicating this order",
            "title": "Duplicate Order",
            "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",
            "format": "uri",
            "maxLength": 2000,
            "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": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned\n\nAdditional custom status keys may be retrieved from the corresponding 'status_retrieve' call.",
            "nullable": true,
            "readOnly": true,
            "title": "Custom status key",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Timestamp of last update",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "barcode_hash",
        "created_by",
        "pk",
        "reference",
        "status",
        "status_text"
    ],
    "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}/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

---

Schemas

AddressBrief

Name	Type	Description
country	string	Address country
internal_shipping_notes	string	Shipping notes for internal use
line1	string	Address line 1
line2	string	Address line 2
pk	integer
postal_city	string	Postal code city/region
postal_code	string	Postal code
province	string	State or province
shipping_notes	string	Notes for shipping courier

BlankEnum

Type:

Build

Name	Type	Description
barcode_hash	string
batch	string | null	Batch code for this build output
completed	integer	Number of stock items which have been completed
completion_date	string(date) | null
creation_date	string(date)
destination	integer | null	Select location where the completed items will be stored
external	boolean	This build order is fulfilled externally
issued_by	integer | null	User who issued this build order
issued_by_detail
level	integer
link	string(uri)	Link to external URL
notes	string | null	Markdown notes (optional)
overdue	boolean
parameters	Array<Parameter>
parent	integer | null	Build Order to which this build is allocated
part	integer	Select part to build
part_detail
part_name	string
pk	integer
priority	integer(int64)	Priority of this build order
project_code	integer | null	Project code for this build order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string
responsible	integer | null	User or group responsible for this build order
responsible_detail
sales_order	integer | null	Sales Order to which this build is allocated
start_date	string(date) | null	Scheduled start date for this build order
status		Build status code * `10` - Pending * `20` - Production * `25` - On Hold * `30` - Cancelled * `40` - Complete
status_custom_key	integer | null	Additional status information for this item * `10` - Pending * `20` - Production * `25` - On Hold * `30` - Cancelled * `40` - Complete Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
take_from	integer | null	Select location to take stock from for this build (leave blank to take from any stock location)
target_date	string(date) | null	Target date for build completion. Build will be overdue after this date.
title	string	Brief description of the build (optional)

BuildStatusEnum

Type: integer

BulkRequest

Name	Type	Description
filters
items	Array<integer>

CompanyBrief

Name	Type	Description
active	boolean	Is this company active?
currency	string	Default currency used for this company
description	string	Description of the company
image	string(uri)
name	string	Company name
pk	integer
tax_id	string	Company Tax ID
thumbnail	string

Contact

Name	Type	Description
company	integer
company_name	string
email	string(email)
name	string
phone	string
pk	integer
role	string

DuplicateOrder

Name	Type	Description
copy_extra_lines	boolean	Copy extra line items from the original order
copy_lines	boolean	Copy line items from the original order
copy_parameters	boolean	Copy order parameters from the original order
order_id	integer	ID of the order to duplicate

GenericStateClass

Name	Type	Description
status_class	string
values

GenericStateValue

Name	Type	Description
color	string
custom	boolean
key	integer
label	string
logical_key	string
name	string

LocationBrief

Name	Type	Description
name	string	Name
pathstring	string	Path
pk	integer

ManufacturerPart

Name	Type	Description
barcode_hash	string	Unique hash of barcode data
description	string | null	Manufacturer part description
link	string(uri) | null	URL for external manufacturer part link
manufacturer	integer
manufacturer_detail
MPN	string | null	Manufacturer Part Number
notes	string | null	Markdown notes (optional)
parameters	Array<Parameter>
part	integer	Select part
part_detail
pk	integer
pretty_name	string | null
tags	Array<string>

ModelType054Enum

Type: string

NullEnum

Type:

OutcomeEnum

Type: integer

Owner

Name	Type	Description
label	string
name	string
owner_id	integer(int64) | null
owner_model	string
pk	integer

PaginatedPurchaseOrderExtraLineList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<PurchaseOrderExtraLine>

PaginatedPurchaseOrderLineItemList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<PurchaseOrderLineItem>

PaginatedPurchaseOrderList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<PurchaseOrder>

PaginatedReturnOrderExtraLineList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<ReturnOrderExtraLine>

PaginatedReturnOrderLineItemList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<ReturnOrderLineItem>

PaginatedReturnOrderList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<ReturnOrder>

PaginatedSalesOrderAllocationList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<SalesOrderAllocation>

PaginatedSalesOrderExtraLineList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<SalesOrderExtraLine>

PaginatedSalesOrderLineItemList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<SalesOrderLineItem>

PaginatedSalesOrderList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<SalesOrder>

PaginatedSalesOrderShipmentList

Name	Type	Description
count	integer
next	string(uri) | null
previous	string(uri) | null
results	Array<SalesOrderShipment>

Parameter

Name	Type	Description
data	string	Parameter Value
data_numeric	number(double) | null
model_id	integer(int64)	ID of the target model for this parameter
model_type
note	string	Optional note field
pk	integer
template	integer	Parameter template
template_detail
updated	string(date-time) | null	Timestamp of last update
updated_by	integer | null	User who last updated this object
updated_by_detail

ParameterTemplate

Name	Type	Description
checkbox	boolean	Is this parameter a checkbox?
choices	string	Valid choices for this parameter (comma-separated)
description	string	Parameter description
enabled	boolean	Is this parameter template enabled?
model_type
name	string	Parameter Name
pk	integer
selectionlist	integer | null	Selection list for this parameter
units	string	Physical units for this parameter

PartBrief

Name	Type	Description
active	boolean	Is this part active?
assembly	boolean	Can this part be built from other parts?
barcode_hash	string	Unique hash of barcode data
category_default_location	integer | null
component	boolean	Can this part be used to build other parts?
default_expiry	integer(int64)	Expiry time (in days) for stock items of this part
default_location	integer | null	Where is this item normally stored?
description	string	Part description (optional)
full_name	string	Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings.
image	string(uri) | null
IPN	string | null	Internal Part Number
is_template	boolean	Is this part a template part?
locked	boolean	Locked parts cannot be edited
minimum_stock	string(decimal)	Minimum allowed stock level
name	string	Part name
pk	integer
pricing_max	string(decimal) | null
pricing_min	string(decimal) | null
purchaseable	boolean	Can this part be purchased from external suppliers?
revision	string | null
salable	boolean	Can this part be sold to customers?
testable	boolean	Can this part have test results recorded against it?
thumbnail	string
trackable	boolean	Does this part have tracking for unique items?
units	string | null	Units of measure for this part
virtual	boolean	Is this a virtual part, such as a software product or license?

PartTestTemplate

Name	Type	Description
choices	string	Valid choices for this test (comma-separated)
description	string | null	Enter description for this test
enabled	boolean	Is this test enabled?
key	string
part	integer
pk	integer
required	boolean	Is this test required to pass?
requires_attachment	boolean	Does this test require a file attachment when adding a test result?
requires_value	boolean	Does this test require a value when adding a test result?
results	integer	Number of results recorded against this template
test_name	string	Enter a name for the test

PatchedPurchaseOrder

Name	Type	Description
address	integer | null	Company address for this order
address_detail
barcode_hash	string
complete_date	string(date) | null	Date order was completed
completed_lines	integer | null
contact	integer | null	Point of contact for this order
contact_detail
created_by
creation_date	string(date) | null
description	string	Order description (optional)
destination	integer | null	Destination for received items
duplicate		Specify options for duplicating this order
issue_date	string(date) | null	Date order was issued
line_items	integer | null
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order_currency	string | null	Currency for this order (leave blank to use company default) * `` - --------- * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
overdue	boolean | null
parameters	Array<Parameter>
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
reference	string
responsible	integer | null	User or group responsible for this order
responsible_detail
start_date	string(date) | null	Scheduled start date for this order
status	integer
status_custom_key	integer | null	Additional status information for this item * `10` - Pending * `20` - Placed * `25` - On Hold * `30` - Complete * `40` - Cancelled * `50` - Lost * `60` - Returned Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
supplier	integer | null	Company from which the items are being ordered
supplier_detail
supplier_name	string
supplier_reference	string	Supplier order reference code
target_date	string(date) | null	Expected date for order delivery. Order will be overdue after this date.
total_price	string(decimal) | null
updated_at	string(date-time) | null	Timestamp of last update

PatchedPurchaseOrderExtraLine

Name	Type	Description
description	string	Line item description (optional)
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Purchase Order
order_detail
pk	integer
price	string(decimal) | null
price_currency	string	Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
target_date	string(date) | null	Target date for this line item (leave blank to use the target date from the order)

PatchedPurchaseOrderLineItem

Name	Type	Description
auto_pricing	boolean	Automatically calculate purchase price based on supplier part data
build_order	integer | null	External Build Order to be fulfilled by this line item
build_order_detail
destination	integer | null	Destination for received items
destination_detail
internal_part	integer
internal_part_name	string
ipn	string | null
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
merge_items	boolean	Merge items with the same part, destination and target date into one line item
mpn	string | null
notes	string	Line item notes
order	integer	Purchase Order
order_detail
overdue	boolean | null
part	integer | null
part_detail
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
purchase_price	string(decimal) | null
purchase_price_currency	string	Purchase price currency * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
quantity	number(double)
received	number(double)
reference	string	Line item reference
sku	string | null
supplier_part_detail
target_date	string(date) | null
total_price	number(double)

PatchedReturnOrder

Name	Type	Description
address	integer | null	Company address for this order
address_detail
barcode_hash	string
complete_date	string(date) | null	Date order was completed
completed_lines	integer | null
contact	integer | null	Point of contact for this order
contact_detail
created_by
creation_date	string(date) | null
customer	integer | null	Company from which items are being returned
customer_detail
customer_reference	string	Customer order reference code
description	string	Order description (optional)
duplicate		Specify options for duplicating this order
issue_date	string(date) | null	Date order was issued
line_items	integer | null
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order_currency	string | null	Currency for this order (leave blank to use company default) * `` - --------- * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
overdue	boolean | null
parameters	Array<Parameter>
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
reference	string
responsible	integer | null	User or group responsible for this order
responsible_detail
start_date	string(date) | null	Scheduled start date for this order
status	integer
status_custom_key	integer | null	Additional status information for this item * `10` - Pending * `20` - In Progress * `25` - On Hold * `30` - Complete * `40` - Cancelled Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
target_date	string(date) | null	Expected date for order delivery. Order will be overdue after this date.
total_price	string(decimal) | null
updated_at	string(date-time) | null	Timestamp of last update

PatchedReturnOrderExtraLine

Name	Type	Description
description	string	Line item description (optional)
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Return Order
order_detail
pk	integer
price	string(decimal) | null
price_currency	string	Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
target_date	string(date) | null	Target date for this line item (leave blank to use the target date from the order)

PatchedReturnOrderLineItem

Name	Type	Description
item	integer	Select item to return from customer
item_detail
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Return Order
order_detail
outcome		Outcome for this line item * `10` - Pending * `20` - Return * `30` - Repair * `40` - Replace * `50` - Refund * `60` - Reject
part_detail
pk	integer
price	string(decimal) | null
price_currency	string	Line price currency * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)	Quantity to return
received_date	string(date) | null	The date this return item was received
reference	string	Line item reference
target_date	string(date) | null

PatchedSalesOrder

Name	Type	Description
address	integer | null	Company address for this order
address_detail
allocated_lines	integer | null
barcode_hash	string
completed_lines	integer | null
completed_shipments_count	integer | null
contact	integer | null	Point of contact for this order
contact_detail
created_by
creation_date	string(date) | null
customer	integer | null	Company to which the items are being sold
customer_detail
customer_reference	string	Customer order reference code
description	string	Order description (optional)
duplicate		Specify options for duplicating this order
issue_date	string(date) | null	Date order was issued
line_items	integer | null
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order_currency	string | null	Currency for this order (leave blank to use company default) * `` - --------- * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
overdue	boolean | null
parameters	Array<Parameter>
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
reference	string
responsible	integer | null	User or group responsible for this order
responsible_detail
shipment_date	string(date) | null
shipments_count	integer | null
start_date	string(date) | null	Scheduled start date for this order
status	integer
status_custom_key	integer | null	Additional status information for this item * `10` - Pending * `15` - In Progress * `20` - Shipped * `25` - On Hold * `30` - Complete * `40` - Cancelled * `50` - Lost * `60` - Returned Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
target_date	string(date) | null	Expected date for order delivery. Order will be overdue after this date.
total_price	string(decimal) | null
updated_at	string(date-time) | null	Timestamp of last update

PatchedSalesOrderAllocation

Name	Type	Description
customer_detail
item	integer	Select stock item to allocate
item_detail
line	integer
location	integer
location_detail
order	integer
order_detail
part	integer
part_detail
pk	integer
quantity	number(double)
serial	string | null
shipment	integer | null	Sales order shipment reference
shipment_detail

PatchedSalesOrderExtraLine

Name	Type	Description
description	string	Line item description (optional)
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Sales Order
order_detail
pk	integer
price	string(decimal) | null
price_currency	string	Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
target_date	string(date) | null	Target date for this line item (leave blank to use the target date from the order)

PatchedSalesOrderLineItem

Name	Type	Description
allocated	number(double)
available_stock	number(double)
available_variant_stock	number(double)
building	number(double)
customer_detail
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
on_order	number(double)
order	integer	Sales Order
order_detail
overdue	boolean | null
part	integer | null	Part
part_detail
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
sale_price	string(decimal) | null
sale_price_currency	string	Sale price currency * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
shipped	number(double)
target_date	string(date) | null

PatchedSalesOrderShipment

Name	Type	Description
allocated_items	integer | null
barcode_hash	string	Unique hash of barcode data
checked_by	integer | null	User who checked this shipment
checked_by_detail
customer_detail
delivery_date	string(date) | null	Date of delivery of shipment
invoice_number	string	Reference number for associated invoice
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order	integer	Sales Order
order_detail
parameters	Array<Parameter>
pk	integer
reference	string	Shipment number
shipment_address	integer | null	Shipping address for this shipment
shipment_address_detail
shipment_date	string(date) | null	Date of shipment
tracking_number	string	Shipment tracking information

ProjectCode

Name	Type	Description
code	string	Unique project code
description	string	Project description
pk	integer
responsible	integer | null	User or group responsible for this project
responsible_detail

PurchaseOrder

Name	Type	Description
address	integer | null	Company address for this order
address_detail
barcode_hash	string
complete_date	string(date) | null	Date order was completed
completed_lines	integer | null
contact	integer | null	Point of contact for this order
contact_detail
created_by
creation_date	string(date) | null
description	string	Order description (optional)
destination	integer | null	Destination for received items
duplicate		Specify options for duplicating this order
issue_date	string(date) | null	Date order was issued
line_items	integer | null
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order_currency	string | null	Currency for this order (leave blank to use company default) * `` - --------- * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
overdue	boolean | null
parameters	Array<Parameter>
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
reference	string
responsible	integer | null	User or group responsible for this order
responsible_detail
start_date	string(date) | null	Scheduled start date for this order
status	integer
status_custom_key	integer | null	Additional status information for this item * `10` - Pending * `20` - Placed * `25` - On Hold * `30` - Complete * `40` - Cancelled * `50` - Lost * `60` - Returned Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
supplier	integer | null	Company from which the items are being ordered
supplier_detail
supplier_name	string
supplier_reference	string	Supplier order reference code
target_date	string(date) | null	Expected date for order delivery. Order will be overdue after this date.
total_price	string(decimal) | null
updated_at	string(date-time) | null	Timestamp of last update

PurchaseOrderComplete

Name	Type	Description
accept_incomplete	boolean	Allow order to be closed with incomplete line items

PurchaseOrderExtraLine

Name	Type	Description
description	string	Line item description (optional)
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Purchase Order
order_detail
pk	integer
price	string(decimal) | null
price_currency	string	Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
target_date	string(date) | null	Target date for this line item (leave blank to use the target date from the order)

PurchaseOrderLineItem

Name	Type	Description
auto_pricing	boolean	Automatically calculate purchase price based on supplier part data
build_order	integer | null	External Build Order to be fulfilled by this line item
build_order_detail
destination	integer | null	Destination for received items
destination_detail
internal_part	integer
internal_part_name	string
ipn	string | null
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
merge_items	boolean	Merge items with the same part, destination and target date into one line item
mpn	string | null
notes	string	Line item notes
order	integer	Purchase Order
order_detail
overdue	boolean | null
part	integer | null
part_detail
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
purchase_price	string(decimal) | null
purchase_price_currency	string	Purchase price currency * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
quantity	number(double)
received	number(double)
reference	string	Line item reference
sku	string | null
supplier_part_detail
target_date	string(date) | null
total_price	number(double)

PurchaseOrderLineItemReceive

Name	Type	Description
barcode	string | null	Scanned barcode
batch_code	string	Enter batch code for incoming stock items
expiry_date	string(date) | null	Enter expiry date for incoming stock items
line_item	integer
location	integer | null	Select destination location for received items
note	string	Additional note for incoming stock items
packaging	string	Override packaging information for incoming stock items
quantity	string(decimal)
serial_numbers	string	Enter serial numbers for incoming stock items
status	integer	Stock item status code * `10` - OK * `50` - Attention needed * `55` - Damaged * `60` - Destroyed * `65` - Rejected * `70` - Lost * `75` - Quarantined * `85` - Returned Additional custom status keys may be retrieved from the 'stock_status_retrieve' call.

PurchaseOrderReceive

Name	Type	Description
items	Array<PurchaseOrderLineItemReceive>
location	integer | null	Select destination location for received items

ReturnOrder

Name	Type	Description
address	integer | null	Company address for this order
address_detail
barcode_hash	string
complete_date	string(date) | null	Date order was completed
completed_lines	integer | null
contact	integer | null	Point of contact for this order
contact_detail
created_by
creation_date	string(date) | null
customer	integer | null	Company from which items are being returned
customer_detail
customer_reference	string	Customer order reference code
description	string	Order description (optional)
duplicate		Specify options for duplicating this order
issue_date	string(date) | null	Date order was issued
line_items	integer | null
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order_currency	string | null	Currency for this order (leave blank to use company default) * `` - --------- * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
overdue	boolean | null
parameters	Array<Parameter>
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
reference	string
responsible	integer | null	User or group responsible for this order
responsible_detail
start_date	string(date) | null	Scheduled start date for this order
status	integer
status_custom_key	integer | null	Additional status information for this item * `10` - Pending * `20` - In Progress * `25` - On Hold * `30` - Complete * `40` - Cancelled Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
target_date	string(date) | null	Expected date for order delivery. Order will be overdue after this date.
total_price	string(decimal) | null
updated_at	string(date-time) | null	Timestamp of last update

ReturnOrderExtraLine

Name	Type	Description
description	string	Line item description (optional)
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Return Order
order_detail
pk	integer
price	string(decimal) | null
price_currency	string	Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
target_date	string(date) | null	Target date for this line item (leave blank to use the target date from the order)

ReturnOrderLineItem

Name	Type	Description
item	integer	Select item to return from customer
item_detail
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Return Order
order_detail
outcome		Outcome for this line item * `10` - Pending * `20` - Return * `30` - Repair * `40` - Replace * `50` - Refund * `60` - Reject
part_detail
pk	integer
price	string(decimal) | null
price_currency	string	Line price currency * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)	Quantity to return
received_date	string(date) | null	The date this return item was received
reference	string	Line item reference
target_date	string(date) | null

ReturnOrderLineItemReceive

Name	Type	Description
item	integer
status	integer	Stock item status code * `10` - OK * `50` - Attention needed * `55` - Damaged * `60` - Destroyed * `65` - Rejected * `70` - Lost * `75` - Quarantined * `85` - Returned Additional custom status keys may be retrieved from the 'stock_status_retrieve' call.

ReturnOrderReceive

Name	Type	Description
items	Array<ReturnOrderLineItemReceive>
location	integer	Select destination location for received items
note	string	Additional note for incoming stock items

SalesOrder

Name	Type	Description
address	integer | null	Company address for this order
address_detail
allocated_lines	integer | null
barcode_hash	string
completed_lines	integer | null
completed_shipments_count	integer | null
contact	integer | null	Point of contact for this order
contact_detail
created_by
creation_date	string(date) | null
customer	integer | null	Company to which the items are being sold
customer_detail
customer_reference	string	Customer order reference code
description	string	Order description (optional)
duplicate		Specify options for duplicating this order
issue_date	string(date) | null	Date order was issued
line_items	integer | null
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order_currency	string | null	Currency for this order (leave blank to use company default) * `` - --------- * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
overdue	boolean | null
parameters	Array<Parameter>
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
reference	string
responsible	integer | null	User or group responsible for this order
responsible_detail
shipment_date	string(date) | null
shipments_count	integer | null
start_date	string(date) | null	Scheduled start date for this order
status	integer
status_custom_key	integer | null	Additional status information for this item * `10` - Pending * `15` - In Progress * `20` - Shipped * `25` - On Hold * `30` - Complete * `40` - Cancelled * `50` - Lost * `60` - Returned Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
target_date	string(date) | null	Expected date for order delivery. Order will be overdue after this date.
total_price	string(decimal) | null
updated_at	string(date-time) | null	Timestamp of last update

SalesOrderAllocation

Name	Type	Description
customer_detail
item	integer	Select stock item to allocate
item_detail
line	integer
location	integer
location_detail
order	integer
order_detail
part	integer
part_detail
pk	integer
quantity	number(double)
serial	string | null
shipment	integer | null	Sales order shipment reference
shipment_detail

SalesOrderComplete

Name	Type	Description
accept_incomplete	boolean	Allow order to be closed with incomplete line items

SalesOrderExtraLine

Name	Type	Description
description	string	Line item description (optional)
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
order	integer	Sales Order
order_detail
pk	integer
price	string(decimal) | null
price_currency	string	Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
target_date	string(date) | null	Target date for this line item (leave blank to use the target date from the order)

SalesOrderLineItem

Name	Type	Description
allocated	number(double)
available_stock	number(double)
available_variant_stock	number(double)
building	number(double)
customer_detail
line	string	Line number for this item (optional)
link	string(uri)	Link to external page
notes	string	Line item notes
on_order	number(double)
order	integer	Sales Order
order_detail
overdue	boolean | null
part	integer | null	Part
part_detail
pk	integer
project_code	integer | null	Select project code for this order
project_code_detail
project_code_label	string | null
quantity	number(double)
reference	string	Line item reference
sale_price	string(decimal) | null
sale_price_currency	string	Sale price currency * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
shipped	number(double)
target_date	string(date) | null

SalesOrderSerialAllocation

Name	Type	Description
line_item	integer
quantity	integer
serial_numbers	string	Enter serial numbers to allocate
shipment	integer | null

SalesOrderShipment

Name	Type	Description
allocated_items	integer | null
barcode_hash	string	Unique hash of barcode data
checked_by	integer | null	User who checked this shipment
checked_by_detail
customer_detail
delivery_date	string(date) | null	Date of delivery of shipment
invoice_number	string	Reference number for associated invoice
link	string(uri)	Link to external page
notes	string | null	Markdown notes (optional)
order	integer	Sales Order
order_detail
parameters	Array<Parameter>
pk	integer
reference	string	Shipment number
shipment_address	integer | null	Shipping address for this shipment
shipment_address_detail
shipment_date	string(date) | null	Date of shipment
tracking_number	string	Shipment tracking information

SalesOrderShipmentAllocation

Name	Type	Description
items	Array<SalesOrderShipmentAllocationItem>
shipment	integer | null

SalesOrderShipmentAllocationItem

Name	Type	Description
line_item	integer
quantity	string(decimal)
stock_item	integer

SalesOrderShipmentComplete

Name	Type	Description
delivery_date	string(date) | null	Date of delivery of shipment
invoice_number	string	Reference number for associated invoice
link	string(uri)	Link to external page
shipment_date	string(date) | null	Date of shipment
tracking_number	string	Shipment tracking information

StockItem

Name	Type	Description
allocated	number(double) | null
barcode_hash	string	Unique hash of barcode data
batch	string | null	Batch code for this stock item
belongs_to	integer | null	Is this item installed in another item?
build	integer | null	Build for this stock item
child_items	integer | null
consumed_by	integer | null	Build order which consumed this stock item
customer	integer | null	Customer
delete_on_deplete	boolean	Delete this Stock Item when stock is depleted
expired	boolean | null
expiry_date	string(date) | null	Expiry date for stock item. Stock will be considered expired after this date
in_stock	boolean
installed_items	integer | null
is_building	boolean
link	string(uri)	Link to external URL
location	integer | null	Where is this stock item located?
location_detail
location_path	Array<>
MPN	string | null
notes	string | null	Markdown notes (optional)
owner	integer | null	Select Owner
packaging	string | null	Packaging this stock item is stored in
parent	integer | null	Parent stock item
part	integer	Base Part
part_detail
pk	integer
purchase_order	integer | null	Purchase order for this stock item
purchase_order_reference	string | null
purchase_price	string(decimal) | null	Purchase price of this stock item, per unit or pack
purchase_price_currency	string	Purchase currency of this stock item * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
quantity	number(double)
sales_order	integer | null
sales_order_reference	string | null
serial	string | null	Serial number for this item
serial_numbers	string | null	Enter serial numbers for new items
SKU	string | null
stale	boolean | null
status
status_custom_key	integer | null	Additional status information for this item * `10` - OK * `50` - Attention needed * `55` - Damaged * `60` - Destroyed * `65` - Rejected * `70` - Lost * `75` - Quarantined * `85` - Returned Additional custom status keys may be retrieved from the corresponding 'status_retrieve' call.
status_text	string
stocktake_date	string(date) | null
supplier_part	integer | null	Select a matching supplier part for this stock item
supplier_part_detail
tags	Array<string>
tests	Array<StockItemTestResult>
tracking_items	integer | null
updated	string(date-time) | null	Timestamp of last update
use_pack_size	boolean | null	Use pack size when adding: the quantity defined is the number of packs

StockItemStatusEnum

Type: integer

StockItemTestResult

Name	Type	Description
attachment	string(uri) | null	Test result attachment
date	string(date-time)
finished_datetime	string(date-time) | null	The timestamp of the test finish
notes	string	Test notes
pk	integer
result	boolean	Test result
started_datetime	string(date-time) | null	The timestamp of the test start
stock_item	integer
template	integer | null	Template
template_detail
test_station	string	The identifier of the test station where the test was performed
user	integer | null
user_detail
value	string	Test output value

SupplierPart

Name	Type	Description
active	boolean	Is this supplier part active?
availability_updated	string(date-time) | null	Date of last update of availability data
available	number(double)
barcode_hash	string	Unique hash of barcode data
description	string | null	Supplier part description
in_stock	number(double) | null
link	string(uri) | null	URL for external supplier part link
manufacturer_detail
manufacturer_part	integer | null	Select manufacturer part
manufacturer_part_detail
MPN	string | null
note	string | null	Notes
notes	string | null	Markdown notes (optional)
on_order	number(double) | null
pack_quantity	string	Total quantity supplied in a single pack. Leave empty for single items.
pack_quantity_native	number(double)
packaging	string | null	Part packaging
parameters	Array<Parameter>
part	integer	Select part
part_detail
pk	integer
pretty_name	string | null
price_breaks	Array<SupplierPriceBreakBrief>
primary	boolean	Is this the primary supplier part for the linked Part?
SKU	string	Supplier stock keeping unit
supplier	integer
supplier_detail
tags	Array<string>
updated	string(date-time) | null

SupplierPriceBreakBrief

Name	Type	Description
part	integer
pk	integer
price	string(decimal) | null
price_currency	string	Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting.
quantity	number(double)
supplier	integer
updated	string(date-time) | null	Timestamp of last update

TaskDetail

Name	Type	Description
complete	boolean
exists	boolean
http_status	integer
pending	boolean
success	boolean
task_id	string

User

Name	Type	Description
email	string(email)	Email address of the user
first_name	string	First name of the user
last_name	string	Last name of the user
pk	integer
username	string	Username

Common responses

This section describes common responses that are reused across operations.

allauth.AddAuthenticatorConflict

The account prohibits adding an authenticator, e.g. because of an unverified email address.

application/json

Schema of the response body

null

allauth.AddWebAuthnAuthenticator

A WebAuthn authenticator.

application/json

{
    "data": null,
    "meta": {
        "recovery_codes_generated": true
    },
    "status": 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": {
        "data": {
            "$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
        },
        "meta": {
            "properties": {
                "recovery_codes_generated": {
                    "description": "Whether or not recovery codes where generated automatically.\n",
                    "type": "boolean"
                }
            },
            "type": "object"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data",
        "meta"
    ],
    "type": "object"
}

allauth.Authenticated

The user is authenticated.

application/json

Schema of the response body

null

allauth.AuthenticatedByCode

Authenticated by code.

application/json

{
    "summary": "Authenticated by code.\n",
    "value": {
        "data": {
            "methods": [
                {
                    "at": 1711555057.065702,
                    "email": "email@domain.org",
                    "method": "code"
                }
            ],
            "user": {
                "display": "Magic Wizard",
                "email": "email@domain.org",
                "has_usable_password": true,
                "id": 123,
                "username": "wizard"
            }
        },
        "meta": {
            "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
            "is_authenticated": true,
            "session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
        },
        "status": 200
    }
}

Schema of the response body

null

allauth.AuthenticatedByPassword

Authenticated by password.

application/json

{
    "summary": "Authenticated by password.\n",
    "value": {
        "data": {
            "methods": [
                {
                    "at": 1711555057.065702,
                    "email": "email@domain.org",
                    "method": "password"
                }
            ],
            "user": {
                "display": "Magic Wizard",
                "email": "email@domain.org",
                "has_usable_password": true,
                "id": 123,
                "username": "wizard"
            }
        },
        "meta": {
            "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
            "is_authenticated": true,
            "session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
        },
        "status": 200
    }
}

Schema of the response body

null

allauth.AuthenticatedByPasswordAnd2FA

Authenticated by password and 2FA.

application/json

{
    "summary": "Fully authenticated using by password and 2FA.\n",
    "value": {
        "data": {
            "methods": [
                {
                    "at": 1711555057.065702,
                    "email": "email@domain.org",
                    "method": "password"
                },
                {
                    "at": 1711555060.9375854,
                    "id": 66,
                    "method": "mfa",
                    "type": "totp"
                }
            ],
            "user": {
                "display": "Magic Wizard",
                "email": "email@domain.org",
                "has_usable_password": true,
                "id": 123,
                "username": "wizard"
            }
        },
        "meta": {
            "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
            "is_authenticated": true,
            "session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
        },
        "status": 200
    }
}

Schema of the response body

null

allauth.Authentication

Not authenticated.

application/json

{
    "summary": "Reauthentication required\n",
    "value": {
        "data": {
            "flows": [
                {
                    "id": "reauthenticate"
                },
                {
                    "id": "mfa_reauthenticate"
                }
            ],
            "methods": [
                {
                    "at": 1711555057.065702,
                    "email": "email@domain.org",
                    "method": "password"
                },
                {
                    "at": 1711555060.9375854,
                    "id": 66,
                    "method": "mfa",
                    "type": "totp"
                }
            ],
            "user": {
                "display": "Magic Wizard",
                "email": "email@domain.org",
                "has_usable_password": true,
                "id": 123,
                "username": "wizard"
            }
        },
        "meta": {
            "is_authenticated": true
        },
        "status": 401
    }
}

{
    "summary": "Unauthenticated: Initial\n",
    "value": {
        "data": {
            "flows": [
                {
                    "id": "login"
                },
                {
                    "id": "signup"
                },
                {
                    "id": "provider_redirect",
                    "providers": [
                        "facebook",
                        "google",
                        "telegram"
                    ]
                },
                {
                    "id": "provider_token",
                    "providers": [
                        "google"
                    ]
                }
            ]
        },
        "meta": {
            "is_authenticated": false
        },
        "status": 401
    }
}

{
    "summary": "Unauthenticated: pending 2FA\n",
    "value": {
        "data": {
            "flows": [
                {
                    "id": "login"
                },
                {
                    "id": "signup"
                },
                {
                    "id": "provider_redirect",
                    "providers": [
                        "facebook",
                        "google",
                        "telegram"
                    ]
                },
                {
                    "id": "provider_token",
                    "providers": [
                        "google"
                    ]
                },
                {
                    "id": "mfa_authenticate",
                    "is_pending": true
                }
            ]
        },
        "meta": {
            "is_authenticated": false
        },
        "status": 401
    }
}

{
    "summary": "Unauthenticated: pending email verification\n",
    "value": {
        "data": {
            "flows": [
                {
                    "id": "login"
                },
                {
                    "id": "signup"
                },
                {
                    "id": "provider_redirect",
                    "providers": [
                        "facebook",
                        "google",
                        "telegram"
                    ]
                },
                {
                    "id": "provider_token",
                    "providers": [
                        "google"
                    ]
                },
                {
                    "id": "verify_email",
                    "is_pending": true
                }
            ]
        },
        "meta": {
            "is_authenticated": false
        },
        "status": 401
    }
}

{
    "summary": "Unauthenticated: pending provider signup\n",
    "value": {
        "data": {
            "flows": [
                {
                    "id": "login"
                },
                {
                    "id": "signup"
                },
                {
                    "id": "provider_redirect",
                    "providers": [
                        "facebook",
                        "google",
                        "telegram"
                    ]
                },
                {
                    "id": "provider_token",
                    "providers": [
                        "google"
                    ]
                },
                {
                    "id": "provider_signup",
                    "is_pending": true,
                    "provider": {
                        "client_id": "123.apps.googleusercontent.com",
                        "flows": [
                            "provider_redirect",
                            "provider_token"
                        ],
                        "id": "google",
                        "name": "Google"
                    }
                }
            ]
        },
        "meta": {
            "is_authenticated": false
        },
        "status": 401
    }
}

Schema of the response body

null

allauth.AuthenticationOrReauthentication

The response indicates authentication or re-authentication is required.

application/json

Schema of the response body

{
    "oneOf": [
        {
            "$ref": "#/components/schemas/allauth.AuthenticationResponse"
        },
        {
            "$ref": "#/components/schemas/allauth.ReauthenticationResponse"
        }
    ]
}

allauth.Authenticators

List of authenticators.

application/json

{
    "data": null,
    "status": 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": {
        "data": {
            "$ref": "#/components/schemas/allauth.AuthenticatorList"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.Configuration

The django-allauth configuration.

application/json

Schema of the response body

null

allauth.EmailAddresses

List of email addresses.

application/json

{
    "data": [
        null
    ],
    "status": 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": {
        "data": {
            "items": {
                "$ref": "#/components/schemas/allauth.EmailAddress"
            },
            "type": "array"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.EmailVerificationInfo

Email verification information.

application/json

Schema of the response body

null

allauth.Error

An input error occurred.

application/json

Schema of the response body

null

allauth.Forbidden

A forbidden response.

application/json

Schema of the response body

null

allauth.NotFound

Not found.

application/json

{
    "status": 404
}

⚠️ 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": {
        "status": {
            "enum": [
                404
            ],
            "type": "integer"
        }
    },
    "required": [
        "status"
    ],
    "type": "object"
}

allauth.PasswordResetInfo

Information about the password reset key.

application/json

{
    "data": {
        "user": null
    },
    "status": 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": {
        "data": {
            "properties": {
                "user": {
                    "$ref": "#/components/schemas/allauth.User"
                }
            },
            "type": "object"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.PhoneNumbers

List of phone numbers.

application/json

Schema of the response body

null

allauth.ProviderAccounts

List of third-party provider accounts.

application/json

{
    "data": [
        null
    ],
    "status": 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": {
        "data": {
            "items": {
                "$ref": "#/components/schemas/allauth.ProviderAccount"
            },
            "type": "array"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.ProviderSignup

Information relating to the pending provider signup.

application/json

{
    "data": {
        "account": null,
        "email": [
            null
        ],
        "user": null
    },
    "status": 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": {
        "data": {
            "properties": {
                "account": {
                    "$ref": "#/components/schemas/allauth.ProviderAccount"
                },
                "email": {
                    "items": {
                        "$ref": "#/components/schemas/allauth.EmailAddress"
                    },
                    "type": "array"
                },
                "user": {
                    "$ref": "#/components/schemas/allauth.User"
                }
            },
            "required": [
                "email",
                "account",
                "user"
            ],
            "type": "object"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.ReauthenticationRequired

The response indicates reauthentication is required.

application/json

{
    "data": {
        "flows": [
            {
                "id": "reauthenticate"
            },
            {
                "id": "mfa_reauthenticate"
            }
        ],
        "methods": [
            {
                "at": 1711555057.065702,
                "email": "email@domain.org",
                "method": "password"
            },
            {
                "at": 1711555060.9375854,
                "id": 66,
                "method": "mfa",
                "type": "totp"
            }
        ],
        "user": {
            "display": "Magic Wizard",
            "email": "email@domain.org",
            "has_usable_password": true,
            "id": 123,
            "username": "wizard"
        }
    },
    "meta": {
        "is_authenticated": true
    },
    "status": 401
}

Schema of the response body

null

allauth.RecoveryCodes

Information on the recovery codes.

application/json

{
    "data": null,
    "status": 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": {
        "data": {
            "$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.RefreshToken

A new access token (and optionally new refresh token).

application/json

{
    "data": {
        "access_token": null,
        "refresh_token": null
    },
    "status": 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": {
        "data": {
            "properties": {
                "access_token": {
                    "$ref": "#/components/schemas/allauth.AccessToken"
                },
                "refresh_token": {
                    "$ref": "#/components/schemas/allauth.RefreshToken"
                }
            },
            "required": [
                "access_token"
            ],
            "type": "object"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "data",
        "status"
    ],
    "type": "object"
}

allauth.SessionGone

The response indicates session is invalid or no longer exists.

application/json

{
    "summary": "Unauthenticated: Initial\n",
    "value": {
        "data": {
            "flows": [
                {
                    "id": "login"
                },
                {
                    "id": "signup"
                },
                {
                    "id": "provider_redirect",
                    "providers": [
                        "facebook",
                        "google",
                        "telegram"
                    ]
                },
                {
                    "id": "provider_token",
                    "providers": [
                        "google"
                    ]
                }
            ]
        },
        "meta": {
            "is_authenticated": false
        },
        "status": 401
    }
}

Schema of the response body

null

allauth.Sessions

List of sessions.

application/json

{
    "data": [
        null
    ],
    "status": 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": {
        "data": {
            "items": {
                "$ref": "#/components/schemas/allauth.Session"
            },
            "type": "array"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.StatusOK

A success response.

application/json

{
    "status": 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": {
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status"
    ],
    "type": "object"
}

allauth.TOTPAuthenticator

Information on the TOTP authenticator.

application/json

{
    "data": null,
    "meta": {
        "recovery_codes_generated": true
    },
    "status": 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": {
        "data": {
            "$ref": "#/components/schemas/allauth.TOTPAuthenticator"
        },
        "meta": {
            "properties": {
                "recovery_codes_generated": {
                    "description": "Whether or not recovery codes where generated automatically.",
                    "type": "boolean"
                }
            },
            "type": "object"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.TOTPAuthenticatorNotFound

No TOTP authenticator has been set up.

application/json

{
    "meta": {
        "secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
        "totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
    },
    "status": 404
}

⚠️ 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": {
        "meta": {
            "properties": {
                "secret": {
                    "description": "A TOTP secret that can be used to setup a new authenticator.\n",
                    "example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
                    "type": "string"
                },
                "totp_url": {
                    "description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
                    "example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
                    "type": "string"
                }
            },
            "required": [
                "secret",
                "totp_url"
            ],
            "type": "object"
        },
        "status": {
            "enum": [
                404
            ],
            "type": "integer"
        }
    },
    "required": [
        "status",
        "meta"
    ],
    "type": "object"
}

allauth.TooManyRequests

Too many requests.

application/json

{
    "status": 429
}

⚠️ 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": {
        "status": {
            "enum": [
                429
            ],
            "type": "integer"
        }
    },
    "required": [
        "status"
    ],
    "type": "object"
}

allauth.Unauthenticated

There is no authenticated session.

application/json

{
    "summary": "Unauthenticated: Initial\n",
    "value": {
        "data": {
            "flows": [
                {
                    "id": "login"
                },
                {
                    "id": "signup"
                },
                {
                    "id": "provider_redirect",
                    "providers": [
                        "facebook",
                        "google",
                        "telegram"
                    ]
                },
                {
                    "id": "provider_token",
                    "providers": [
                        "google"
                    ]
                }
            ]
        },
        "meta": {
            "is_authenticated": false
        },
        "status": 401
    }
}

Schema of the response body

null

allauth.WebAuthnAuthenticator

A WebAuthn authenticator.

application/json

{
    "data": null,
    "status": 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": {
        "data": {
            "$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.WebAuthnCreationOptionsResponse

WebAuthn credential creation options.

application/json

{
    "data": null,
    "status": 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": {
        "data": {
            "$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

allauth.WebAuthnRequestOptionsResponse

WebAuthn credential request options.

application/json

{
    "data": null,
    "status": 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": {
        "data": {
            "$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
        },
        "status": {
            "$ref": "#/components/schemas/allauth.StatusOK"
        }
    },
    "required": [
        "status",
        "data"
    ],
    "type": "object"
}

Common parameters

This section describes common parameters that are reused across operations.

allauth.EmailVerificationKey

Name	In	Type	Default	Nullable	Description
X-Email-Verification-Key	header	string		No

allauth.PasswordLess

Name	In	Type	Default	Nullable	Description
passwordless	query	boolean		No

allauth.PasswordResetKey

Name	In	Type	Default	Nullable	Description
X-Password-Reset-Key	header	string		No

Security schemes

Name	Type	Scheme	Description
basicAuth	http	basic
cookieAuth	apiKey
oauth2	oauth2
tokenAuth	apiKey		Token-based authentication with required prefix "Token"

More documentation

More information about InvenTree in the official docs

---

For more information: https://docs.inventree.org