Skip to content

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

InvenTree API 198

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

Generic handler for a download request.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
order query integer No
ordering query string No Which field to use when ordering the results.
search query string No A search term.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "context": null,
            "description": "string",
            "link": "string",
            "notes": "string",
            "order": 0,
            "pk": 0,
            "price": "string",
            "price_currency": null,
            "quantity": 10.12,
            "reference": "string"
        }
    ]
}
⚠️ 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"
        }
    },
    "type": "object"
}

POST /api/order/po-extra-line/

Description

API endpoint for accessing a list of PurchaseOrderExtraLine objects.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Response 201 Created

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

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

Description

API endpoint for detail view of a PurchaseOrderExtraLine object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


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

Description

API endpoint for detail view of a PurchaseOrderExtraLine object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

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

Description

API endpoint for detail view of a PurchaseOrderExtraLine object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

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

Description

API endpoint for detail view of a PurchaseOrderExtraLine object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ This example has 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

Response 200 OK

{
    "context": null,
    "description": "string",
    "link": "string",
    "notes": "string",
    "order": 0,
    "pk": 0,
    "price": "string",
    "price_currency": null,
    "quantity": 10.12,
    "reference": "string"
}
⚠️ 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": {
        "context": {
            "description": "Additional context for this line",
            "nullable": true
        },
        "description": {
            "description": "Line item description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "order",
        "pk",
        "quantity"
    ],
    "type": "object"
}

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

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "metadata": null
}
⚠️ 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 model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

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

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has 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 model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

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

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has 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 model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

DELETE /api/order/po-line/

Description

Perform a DELETE operation against this list endpoint.

We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Response 204 No Content


GET /api/order/po-line/

Description

Generic handler for a download request.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
base_part query integer No Internal Part
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_status query integer No Order Status
ordering query string No Which field to use when ordering the results.
part query integer No Supplier Part
pending query boolean No Order Pending
received query boolean No Items Received
search query string No A search term.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "auto_pricing": true,
            "destination": 0,
            "destination_detail": null,
            "link": "string",
            "merge_items": true,
            "notes": "string",
            "order": 0,
            "overdue": true,
            "part": 0,
            "pk": 0,
            "purchase_price": "string",
            "purchase_price_currency": null,
            "quantity": 10.12,
            "received": 10.12,
            "reference": "string",
            "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"
        }
    },
    "type": "object"
}

POST /api/order/po-line/

Description

API endpoint for accessing a list of PurchaseOrderLineItem objects.

  • GET: Return a list of PurchaseOrder Line Item objects
  • POST: Create a new PurchaseOrderLineItem object

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

Response 201 Created

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "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
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


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

Description

Detail API endpoint for PurchaseOrderLineItem object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "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
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "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
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

Response 200 OK

{
    "auto_pricing": true,
    "destination": 0,
    "destination_detail": null,
    "link": "string",
    "merge_items": true,
    "notes": "string",
    "order": 0,
    "overdue": true,
    "part": 0,
    "pk": 0,
    "purchase_price": "string",
    "purchase_price_currency": null,
    "quantity": 10.12,
    "received": 10.12,
    "reference": "string",
    "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": true,
            "description": "Automatically calculate purchase price based on supplier part data",
            "type": "boolean"
        },
        "destination": {
            "description": "Where does the Purchaser want this item to be stored?",
            "nullable": true,
            "type": "integer"
        },
        "destination_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/LocationBrief"
                }
            ],
            "readOnly": true
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "merge_items": {
            "default": true,
            "description": "Merge items with the same part, destination and target date into one line item",
            "type": "boolean"
        },
        "notes": {
            "description": "Line item notes",
            "maxLength": 500,
            "type": "string"
        },
        "order": {
            "description": "Purchase Order",
            "type": "integer"
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "part": {
            "description": "Supplier part",
            "nullable": true,
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "purchase_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "type": "string"
        },
        "purchase_price_currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "title": "Currency"
        },
        "quantity": {
            "format": "double",
            "minimum": 0,
            "type": "number"
        },
        "received": {
            "default": 0.0,
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "reference": {
            "description": "Line item reference",
            "maxLength": 100,
            "type": "string"
        },
        "target_date": {
            "description": "Target date for this line item (leave blank to use the target date from the order)",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        }
    },
    "required": [
        "destination_detail",
        "order",
        "overdue",
        "pk",
        "quantity",
        "received",
        "total_price"
    ],
    "type": "object"
}

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

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "metadata": null
}
⚠️ 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 model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

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

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has 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 model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

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

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "metadata": null
}
⚠️ This example has 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 model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

{
    "metadata": 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 class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

GET /api/order/po/

Description

Generic handler for a download request.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
assigned_to query integer No
assigned_to_me query boolean No assigned_to_me
has_project_code query boolean No has_project_code
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
ordering query string No Which field to use when ordering the results.
outstanding query boolean No outstanding
overdue query boolean No overdue
project_code query integer No
reference query string No Filter by exact reference
search query string No A search term.
status query integer No Order Status
supplier query integer No

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "address": 0,
            "address_detail": null,
            "barcode_hash": "string",
            "complete_date": "2022-04-13",
            "completed_lines": 0,
            "contact": 0,
            "contact_detail": null,
            "creation_date": "2022-04-13",
            "description": "string",
            "issue_date": "2022-04-13",
            "line_items": 0,
            "link": "string",
            "notes": "string",
            "order_currency": null,
            "overdue": true,
            "pk": 0,
            "project_code": 0,
            "project_code_detail": null,
            "reference": "string",
            "responsible": 0,
            "responsible_detail": null,
            "status": 0,
            "status_text": "string",
            "supplier": 0,
            "supplier_reference": "string",
            "target_date": "2022-04-13",
            "total_price": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "properties": {
        "count": {
            "example": 123,
            "type": "integer"
        },
        "next": {
            "example": "http://api.example.org/accounts/?offset=400&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "previous": {
            "example": "http://api.example.org/accounts/?offset=200&limit=100",
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "results": {
            "items": {
                "$ref": "#/components/schemas/PurchaseOrder"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/order/po/

Description

API endpoint for accessing a list of PurchaseOrder objects.

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

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "address_detail",
        "barcode_hash",
        "complete_date",
        "completed_lines",
        "contact_detail",
        "issue_date",
        "line_items",
        "overdue",
        "pk",
        "project_code_detail",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "supplier",
        "total_price"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "address_detail",
        "barcode_hash",
        "complete_date",
        "completed_lines",
        "contact_detail",
        "issue_date",
        "line_items",
        "overdue",
        "pk",
        "project_code_detail",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "supplier",
        "total_price"
    ],
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "address_detail",
        "barcode_hash",
        "complete_date",
        "completed_lines",
        "contact_detail",
        "issue_date",
        "line_items",
        "overdue",
        "pk",
        "project_code_detail",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "supplier",
        "total_price"
    ],
    "type": "object"
}

Response 201 Created

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "address_detail",
        "barcode_hash",
        "complete_date",
        "completed_lines",
        "contact_detail",
        "issue_date",
        "line_items",
        "overdue",
        "pk",
        "project_code_detail",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "supplier",
        "total_price"
    ],
    "type": "object"
}

DELETE /api/order/po/attachment/

Description

Perform a DELETE operation against this list endpoint.

We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Response 204 No Content


GET /api/order/po/attachment/

Description

API endpoint for listing, creating and bulk deleting) a PurchaseOrderAttachment (file upload).

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
limit query integer No Number of results to return per page.
offset query integer No The initial index from which to return the results.
order query integer No
ordering query string No Which field to use when ordering the results.
search query string No A search term.

Response 200 OK

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "attachment": "string",
            "comment": "string",
            "filename": "string",
            "link": "string",
            "order": 0,
            "pk": 0,
            "upload_date": "2022-04-13",
            "user": 0,
            "user_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/PurchaseOrderAttachment"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/order/po/attachment/

Description

API endpoint for listing, creating and bulk deleting) a PurchaseOrderAttachment (file upload).

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Request body

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 201 Created

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

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

Description

Detail endpoint for a PurchaseOrderAttachment.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


GET /api/order/po/attachment/{id}/

Description

Detail endpoint for a PurchaseOrderAttachment.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PATCH /api/order/po/attachment/{id}/

Description

Detail endpoint for a PurchaseOrderAttachment.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "type": "object"
}

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PUT /api/order/po/attachment/{id}/

Description

Detail endpoint for a PurchaseOrderAttachment.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "order": 0,
    "pk": 0,
    "upload_date": "2022-04-13",
    "user": 0,
    "user_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": "Serializers for the PurchaseOrderAttachment model.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "order": {
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "upload_date": {
            "format": "date",
            "readOnly": true,
            "type": "string"
        },
        "user": {
            "description": "User",
            "nullable": true,
            "type": "integer"
        },
        "user_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/User"
                }
            ],
            "readOnly": true
        }
    },
    "required": [
        "order",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

GET /api/order/po/status/

Description

Retrieve information about a specific status code

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"

Response 200 OK

Response 400 Bad Request


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

Description

API endpoint for detail view of a PurchaseOrder object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 204 No Content


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

Description

API endpoint for detail view of a PurchaseOrder object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Response 200 OK

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "address_detail",
        "barcode_hash",
        "complete_date",
        "completed_lines",
        "contact_detail",
        "issue_date",
        "line_items",
        "overdue",
        "pk",
        "project_code_detail",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "supplier",
        "total_price"
    ],
    "type": "object"
}

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

Description

API endpoint for detail view of a PurchaseOrder object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "address": 0,
    "address_detail": null,
    "barcode_hash": "string",
    "complete_date": "2022-04-13",
    "completed_lines": 0,
    "contact": 0,
    "contact_detail": null,
    "creation_date": "2022-04-13",
    "description": "string",
    "issue_date": "2022-04-13",
    "line_items": 0,
    "link": "string",
    "notes": "string",
    "order_currency": null,
    "overdue": true,
    "pk": 0,
    "project_code": 0,
    "project_code_detail": null,
    "reference": "string",
    "responsible": 0,
    "responsible_detail": null,
    "status": 0,
    "status_text": "string",
    "supplier": 0,
    "supplier_reference": "string",
    "target_date": "2022-04-13",
    "total_price": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for a PurchaseOrder object.",
    "properties": {
        "address": {
            "description": "Company address for this order",
            "nullable": true,
            "type": "integer"
        },
        "address_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/AddressBrief"
                }
            ],
            "readOnly": true
        },
        "barcode_hash": {
            "readOnly": true,
            "type": "string"
        },
        "complete_date": {
            "description": "Date order was completed",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "title": "Completion Date",
            "type": "string"
        },
        "completed_lines": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact for this order",
            "nullable": true,
            "type": "integer"
        },
        "contact_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Contact"
                }
            ],
            "readOnly": true
        },
        "creation_date": {
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "description": {
            "description": "Order description (optional)",
            "maxLength": 250,
            "type": "string"
        },
        "issue_date": {
            "description": "Date order was issued",
            "format": "date",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "line_items": {
            "readOnly": true,
            "type": "integer"
        },
        "link": {
            "description": "Link to external page",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "order_currency": {
            "description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CAD` - Canadian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `GBP` - British Pound\n* `JPY` - Japanese Yen\n* `NZD` - New Zealand Dollar\n* `USD` - US Dollar",
            "nullable": true,
            "oneOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                },
                {
                    "$ref": "#/components/schemas/BlankEnum"
                },
                {
                    "$ref": "#/components/schemas/NullEnum"
                }
            ]
        },
        "overdue": {
            "readOnly": true,
            "type": "boolean"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "project_code": {
            "description": "Select project code for this order",
            "nullable": true,
            "type": "integer"
        },
        "project_code_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/ProjectCode"
                }
            ],
            "readOnly": true
        },
        "reference": {
            "type": "string"
        },
        "responsible": {
            "description": "User or group responsible for this order",
            "nullable": true,
            "type": "integer"
        },
        "responsible_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Owner"
                }
            ],
            "readOnly": true
        },
        "status": {
            "readOnly": true,
            "title": "Order Status",
            "type": "integer"
        },
        "status_text": {
            "readOnly": true,
            "type": "string"
        },
        "supplier": {
            "description": "Company from which the items are being ordered",
            "nullable": true,
            "type": "integer"
        },
        "supplier_reference": {
            "description": "Supplier order reference code",
            "maxLength": 64,
            "type": "string"
        },
        "target_date": {
            "description": "Expected date for order delivery. Order will be overdue after this date.",
            "format": "date",
            "nullable": true,
            "type": "string"
        },
        "total_price": {
            "format": "decimal",
            "nullable": true,
            "pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "address_detail",
        "barcode_hash",
        "complete_date",
        "completed_lines",
        "contact_detail",
        "issue_date",
        "line_items",
        "overdue",
        "pk",
        "project_code_detail",
        "reference",
        "responsible_detail",
        "status",
        "status_text",
        "supplier",
        "total_price"
    ],
    "type": "object"
}

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

Description

API endpoint for detail view of a PurchaseOrder object.

Input parameters

Parameter In Type Default Nullable Description
cookieAuth cookie string N/A No API key
basicAuth header string N/A No Basic authentication
tokenAuth header string N/A No Token-based authentication with required prefix "Token"
id path integer No

Request body