Skip to content

The Company 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

company


GET /api/company/

Description

API endpoint for accessing a list of Company objects.

Provides two methods:

  • GET: Return list of objects
  • POST: Create a new Company 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"
active query boolean No
is_customer query boolean No
is_manufacturer query boolean No
is_supplier query boolean No
limit query integer No Number of results to return per page.
name query string No
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.
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": [
        {
            "active": true,
            "address": "string",
            "address_count": 0,
            "contact": "string",
            "currency": null,
            "description": "string",
            "email": "derp@meme.org",
            "image": "string",
            "is_customer": true,
            "is_manufacturer": true,
            "is_supplier": true,
            "link": "string",
            "name": "string",
            "notes": "string",
            "parts_manufactured": 0,
            "parts_supplied": 0,
            "phone": "string",
            "pk": 0,
            "primary_address": null,
            "remote_image": "string",
            "url": "string",
            "website": "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/Company"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/

Description

API endpoint for accessing a list of Company objects.

Provides two methods:

  • GET: Return list of objects
  • POST: Create a new Company 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

{
    "active": true,
    "address": "string",
    "address_count": 0,
    "contact": "string",
    "currency": null,
    "description": "string",
    "email": "derp@meme.org",
    "image": "string",
    "is_customer": true,
    "is_manufacturer": true,
    "is_supplier": true,
    "link": "string",
    "name": "string",
    "notes": "string",
    "parts_manufactured": 0,
    "parts_supplied": 0,
    "phone": "string",
    "pk": 0,
    "primary_address": null,
    "remote_image": "string",
    "url": "string",
    "website": "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 Company object (full detail).",
    "properties": {
        "active": {
            "description": "Is this company active?",
            "type": "boolean"
        },
        "address": {
            "readOnly": true,
            "type": "string"
        },
        "address_count": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact",
            "maxLength": 100,
            "type": "string"
        },
        "currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Default currency used for this supplier\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"
        },
        "description": {
            "description": "Description of the company",
            "maxLength": 500,
            "title": "Company description",
            "type": "string"
        },
        "email": {
            "description": "Contact email address",
            "format": "email",
            "maxLength": 254,
            "nullable": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "is_customer": {
            "description": "Do you sell items to this company?",
            "type": "boolean"
        },
        "is_manufacturer": {
            "description": "Does this company manufacture parts?",
            "type": "boolean"
        },
        "is_supplier": {
            "description": "Do you purchase items from this company?",
            "type": "boolean"
        },
        "link": {
            "description": "Link to external company information",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "name": {
            "description": "Company name",
            "maxLength": 100,
            "title": "Company name",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "parts_manufactured": {
            "readOnly": true,
            "type": "integer"
        },
        "parts_supplied": {
            "readOnly": true,
            "type": "integer"
        },
        "phone": {
            "description": "Contact phone number",
            "maxLength": 50,
            "title": "Phone number",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "primary_address": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Address"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "url": {
            "readOnly": true,
            "type": "string"
        },
        "website": {
            "description": "Company website URL",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        }
    },
    "required": [
        "address",
        "address_count",
        "currency",
        "name",
        "parts_manufactured",
        "parts_supplied",
        "pk",
        "primary_address",
        "url"
    ],
    "type": "object"
}

{
    "active": true,
    "address": "string",
    "address_count": 0,
    "contact": "string",
    "currency": null,
    "description": "string",
    "email": "derp@meme.org",
    "image": "string",
    "is_customer": true,
    "is_manufacturer": true,
    "is_supplier": true,
    "link": "string",
    "name": "string",
    "notes": "string",
    "parts_manufactured": 0,
    "parts_supplied": 0,
    "phone": "string",
    "pk": 0,
    "primary_address": null,
    "remote_image": "string",
    "url": "string",
    "website": "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 Company object (full detail).",
    "properties": {
        "active": {
            "description": "Is this company active?",
            "type": "boolean"
        },
        "address": {
            "readOnly": true,
            "type": "string"
        },
        "address_count": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact",
            "maxLength": 100,
            "type": "string"
        },
        "currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Default currency used for this supplier\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"
        },
        "description": {
            "description": "Description of the company",
            "maxLength": 500,
            "title": "Company description",
            "type": "string"
        },
        "email": {
            "description": "Contact email address",
            "format": "email",
            "maxLength": 254,
            "nullable": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "is_customer": {
            "description": "Do you sell items to this company?",
            "type": "boolean"
        },
        "is_manufacturer": {
            "description": "Does this company manufacture parts?",
            "type": "boolean"
        },
        "is_supplier": {
            "description": "Do you purchase items from this company?",
            "type": "boolean"
        },
        "link": {
            "description": "Link to external company information",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "name": {
            "description": "Company name",
            "maxLength": 100,
            "title": "Company name",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "parts_manufactured": {
            "readOnly": true,
            "type": "integer"
        },
        "parts_supplied": {
            "readOnly": true,
            "type": "integer"
        },
        "phone": {
            "description": "Contact phone number",
            "maxLength": 50,
            "title": "Phone number",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "primary_address": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Address"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "url": {
            "readOnly": true,
            "type": "string"
        },
        "website": {
            "description": "Company website URL",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        }
    },
    "required": [
        "address",
        "address_count",
        "currency",
        "name",
        "parts_manufactured",
        "parts_supplied",
        "pk",
        "primary_address",
        "url"
    ],
    "type": "object"
}

{
    "active": true,
    "address": "string",
    "address_count": 0,
    "contact": "string",
    "currency": null,
    "description": "string",
    "email": "derp@meme.org",
    "image": "string",
    "is_customer": true,
    "is_manufacturer": true,
    "is_supplier": true,
    "link": "string",
    "name": "string",
    "notes": "string",
    "parts_manufactured": 0,
    "parts_supplied": 0,
    "phone": "string",
    "pk": 0,
    "primary_address": null,
    "remote_image": "string",
    "url": "string",
    "website": "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 Company object (full detail).",
    "properties": {
        "active": {
            "description": "Is this company active?",
            "type": "boolean"
        },
        "address": {
            "readOnly": true,
            "type": "string"
        },
        "address_count": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact",
            "maxLength": 100,
            "type": "string"
        },
        "currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Default currency used for this supplier\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"
        },
        "description": {
            "description": "Description of the company",
            "maxLength": 500,
            "title": "Company description",
            "type": "string"
        },
        "email": {
            "description": "Contact email address",
            "format": "email",
            "maxLength": 254,
            "nullable": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "is_customer": {
            "description": "Do you sell items to this company?",
            "type": "boolean"
        },
        "is_manufacturer": {
            "description": "Does this company manufacture parts?",
            "type": "boolean"
        },
        "is_supplier": {
            "description": "Do you purchase items from this company?",
            "type": "boolean"
        },
        "link": {
            "description": "Link to external company information",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "name": {
            "description": "Company name",
            "maxLength": 100,
            "title": "Company name",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "parts_manufactured": {
            "readOnly": true,
            "type": "integer"
        },
        "parts_supplied": {
            "readOnly": true,
            "type": "integer"
        },
        "phone": {
            "description": "Contact phone number",
            "maxLength": 50,
            "title": "Phone number",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "primary_address": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Address"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "url": {
            "readOnly": true,
            "type": "string"
        },
        "website": {
            "description": "Company website URL",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        }
    },
    "required": [
        "address",
        "address_count",
        "currency",
        "name",
        "parts_manufactured",
        "parts_supplied",
        "pk",
        "primary_address",
        "url"
    ],
    "type": "object"
}

Response 201 Created

{
    "active": true,
    "address": "string",
    "address_count": 0,
    "contact": "string",
    "currency": null,
    "description": "string",
    "email": "derp@meme.org",
    "image": "string",
    "is_customer": true,
    "is_manufacturer": true,
    "is_supplier": true,
    "link": "string",
    "name": "string",
    "notes": "string",
    "parts_manufactured": 0,
    "parts_supplied": 0,
    "phone": "string",
    "pk": 0,
    "primary_address": null,
    "remote_image": "string",
    "url": "string",
    "website": "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 Company object (full detail).",
    "properties": {
        "active": {
            "description": "Is this company active?",
            "type": "boolean"
        },
        "address": {
            "readOnly": true,
            "type": "string"
        },
        "address_count": {
            "readOnly": true,
            "type": "integer"
        },
        "contact": {
            "description": "Point of contact",
            "maxLength": 100,
            "type": "string"
        },
        "currency": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/SalePriceCurrencyEnum"
                }
            ],
            "description": "Default currency used for this supplier\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"
        },
        "description": {
            "description": "Description of the company",
            "maxLength": 500,
            "title": "Company description",
            "type": "string"
        },
        "email": {
            "description": "Contact email address",
            "format": "email",
            "maxLength": 254,
            "nullable": true,
            "type": "string"
        },
        "image": {
            "format": "uri",
            "nullable": true,
            "type": "string"
        },
        "is_customer": {
            "description": "Do you sell items to this company?",
            "type": "boolean"
        },
        "is_manufacturer": {
            "description": "Does this company manufacture parts?",
            "type": "boolean"
        },
        "is_supplier": {
            "description": "Do you purchase items from this company?",
            "type": "boolean"
        },
        "link": {
            "description": "Link to external company information",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "name": {
            "description": "Company name",
            "maxLength": 100,
            "title": "Company name",
            "type": "string"
        },
        "notes": {
            "description": "Markdown notes (optional)",
            "maxLength": 50000,
            "nullable": true,
            "type": "string"
        },
        "parts_manufactured": {
            "readOnly": true,
            "type": "integer"
        },
        "parts_supplied": {
            "readOnly": true,
            "type": "integer"
        },
        "phone": {
            "description": "Contact phone number",
            "maxLength": 50,
            "title": "Phone number",
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "primary_address": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Address"
                }
            ],
            "nullable": true,
            "readOnly": true
        },
        "remote_image": {
            "description": "URL of remote image file",
            "format": "uri",
            "type": "string",
            "writeOnly": true
        },
        "url": {
            "readOnly": true,
            "type": "string"
        },
        "website": {
            "description": "Company website URL",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        }
    },
    "required": [
        "address",
        "address_count",
        "currency",
        "name",
        "parts_manufactured",
        "parts_supplied",
        "pk",
        "primary_address",
        "url"
    ],
    "type": "object"
}

DELETE /api/company/address/

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/company/address/

Description

API endpoint for list view of Address 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"
company query integer No
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.
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": [
        {
            "company": 0,
            "country": "string",
            "internal_shipping_notes": "string",
            "line1": "string",
            "line2": "string",
            "link": "string",
            "pk": 0,
            "postal_city": "string",
            "postal_code": "string",
            "primary": true,
            "province": "string",
            "shipping_notes": "string",
            "title": "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/Address"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/address/

Description

API endpoint for list view of Address 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"

Request body

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

Response 201 Created

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

DELETE /api/company/address/{id}/

Description

API endpoint for a single Address 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/company/address/{id}/

Description

API endpoint for a single Address 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

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

PATCH /api/company/address/{id}/

Description

API endpoint for a single Address 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

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "type": "object"
}

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "type": "object"
}

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

PUT /api/company/address/{id}/

Description

API endpoint for a single Address 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

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

Response 200 OK

{
    "company": 0,
    "country": "string",
    "internal_shipping_notes": "string",
    "line1": "string",
    "line2": "string",
    "link": "string",
    "pk": 0,
    "postal_city": "string",
    "postal_code": "string",
    "primary": true,
    "province": "string",
    "shipping_notes": "string",
    "title": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer for the Address Model.",
    "properties": {
        "company": {
            "description": "Select company",
            "type": "integer"
        },
        "country": {
            "description": "Address country",
            "maxLength": 50,
            "type": "string"
        },
        "internal_shipping_notes": {
            "description": "Shipping notes for internal use",
            "maxLength": 100,
            "type": "string"
        },
        "line1": {
            "description": "Address line 1",
            "maxLength": 50,
            "title": "Line 1",
            "type": "string"
        },
        "line2": {
            "description": "Address line 2",
            "maxLength": 50,
            "title": "Line 2",
            "type": "string"
        },
        "link": {
            "description": "Link to address information (external)",
            "format": "uri",
            "maxLength": 200,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "postal_city": {
            "description": "Postal code city/region",
            "maxLength": 50,
            "title": "City/Region",
            "type": "string"
        },
        "postal_code": {
            "description": "Postal code",
            "maxLength": 10,
            "type": "string"
        },
        "primary": {
            "description": "Set as primary address",
            "title": "Primary address",
            "type": "boolean"
        },
        "province": {
            "description": "State or province",
            "maxLength": 50,
            "title": "State/Province",
            "type": "string"
        },
        "shipping_notes": {
            "description": "Notes for shipping courier",
            "maxLength": 100,
            "title": "Courier shipping notes",
            "type": "string"
        },
        "title": {
            "description": "Title describing the address entry",
            "maxLength": 100,
            "title": "Address title",
            "type": "string"
        }
    },
    "required": [
        "company",
        "pk",
        "title"
    ],
    "type": "object"
}

DELETE /api/company/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/company/attachment/

Description

API endpoint for listing, creating and bulk deleting a CompanyAttachment.

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"
company query integer No
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.
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",
            "company": 0,
            "filename": "string",
            "link": "string",
            "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/CompanyAttachment"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/attachment/

Description

API endpoint for listing, creating and bulk deleting a CompanyAttachment.

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",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 201 Created

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

DELETE /api/company/attachment/{id}/

Description

Detail endpoint for CompanyAttachment 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 204 No Content


GET /api/company/attachment/{id}/

Description

Detail endpoint for CompanyAttachment 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

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PATCH /api/company/attachment/{id}/

Description

Detail endpoint for CompanyAttachment 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

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PUT /api/company/attachment/{id}/

Description

Detail endpoint for CompanyAttachment 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

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "company": 0,
    "filename": "string",
    "link": "string",
    "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": "Serializer for the CompanyAttachment class.",
    "properties": {
        "attachment": {
            "format": "uri",
            "type": "string"
        },
        "comment": {
            "description": "File comment",
            "maxLength": 100,
            "type": "string"
        },
        "company": {
            "type": "integer"
        },
        "filename": {
            "type": "string"
        },
        "link": {
            "description": "Link to external URL",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "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": [
        "company",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

DELETE /api/company/contact/

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/company/contact/

Description

API endpoint for list view of Company 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"
company query integer No
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.
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": [
        {
            "company": 0,
            "email": "derp@meme.org",
            "name": "string",
            "phone": "string",
            "pk": 0,
            "role": "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/Contact"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/contact/

Description

API endpoint for list view of Company 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"

Request body

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

DELETE /api/company/contact/{id}/

Description

Detail endpoint for Company 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 string No

Response 204 No Content


GET /api/company/contact/{id}/

Description

Detail endpoint for Company 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 string No

Response 200 OK

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

PATCH /api/company/contact/{id}/

Description

Detail endpoint for Company 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 string No

Request body

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "type": "object"
}

Response 200 OK

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

PUT /api/company/contact/{id}/

Description

Detail endpoint for Company 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 string No

Request body

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

{
    "company": 0,
    "email": "derp@meme.org",
    "name": "string",
    "phone": "string",
    "pk": 0,
    "role": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "description": "Serializer class for the Contact model.",
    "properties": {
        "company": {
            "type": "integer"
        },
        "email": {
            "format": "email",
            "maxLength": 254,
            "type": "string"
        },
        "name": {
            "maxLength": 100,
            "type": "string"
        },
        "phone": {
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "role": {
            "maxLength": 100,
            "type": "string"
        }
    },
    "required": [
        "company",
        "name",
        "pk"
    ],
    "type": "object"
}

GET /api/company/contact/{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 string 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/company/contact/{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 string 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/company/contact/{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 string 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/company/part/

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/company/part/

Description

API endpoint for list view of SupplierPart object.

  • GET: Return list of SupplierPart objects
  • POST: Create a new SupplierPart 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"
active query boolean No Supplier Part is Active
limit query integer No Number of results to return per page.
manufacturer_part query integer No
MPN query string No Manufacturer Part Number
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.
part query integer No
part_active query boolean No Internal Part is Active
search query string No A search term.
SKU query string No
supplier query integer No
supplier_active query boolean No Supplier is Active
tags__name query string No
tags__slug query string 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": [
        {
            "MPN": "string",
            "SKU": "string",
            "active": true,
            "availability_updated": "2022-04-13T15:42:05.901Z",
            "available": 10.12,
            "barcode_hash": "string",
            "description": "string",
            "in_stock": 10.12,
            "link": "string",
            "manufacturer": "string",
            "manufacturer_part": 0,
            "name": "string",
            "note": "string",
            "pack_quantity": "string",
            "pack_quantity_native": 10.12,
            "packaging": "string",
            "part": 0,
            "pk": 0,
            "supplier": 0,
            "supplier_detail": null,
            "tags": [
                "string"
            ],
            "updated": "2022-04-13T15:42:05.901Z",
            "url": "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/SupplierPart"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/part/

Description

API endpoint for list view of SupplierPart object.

  • GET: Return list of SupplierPart objects
  • POST: Create a new SupplierPart 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

{
    "MPN": "string",
    "SKU": "string",
    "active": true,
    "availability_updated": "2022-04-13T15:42:05.901Z",
    "available": 10.12,
    "barcode_hash": "string",
    "description": "string",
    "in_stock": 10.12,
    "link": "string",
    "manufacturer": "string",
    "manufacturer_part": 0,
    "name": "string",
    "note": "string",
    "pack_quantity": "string",
    "pack_quantity_native": 10.12,
    "packaging": "string",
    "part": 0,
    "pk": 0,
    "supplier": 0,
    "supplier_detail": null,
    "tags": [
        "string"
    ],
    "updated": "2022-04-13T15:42:05.901Z",
    "url": "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 SupplierPart object.",
    "properties": {
        "MPN": {
            "readOnly": true,
            "type": "string"
        },
        "SKU": {
            "description": "Supplier stock keeping unit",
            "maxLength": 100,
            "type": "string"
        },
        "active": {
            "description": "Is this supplier part active?",
            "type": "boolean"
        },
        "availability_updated": {
            "description": "Date of last update of availability data",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "available": {
            "format": "double",
            "type": "number"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "description": {
            "description": "Supplier part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "link": {
            "description": "URL for external supplier part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "readOnly": true,
            "type": "string"
        },
        "manufacturer_part": {
            "description": "Select manufacturer part",
            "nullable": true,
            "type": "integer"
        },
        "name": {
            "readOnly": true,
            "type": "string"
        },
        "note": {
            "description": "Notes",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "pack_quantity": {
            "description": "Total quantity supplied in a single pack. Leave empty for single items.",
            "maxLength": 25,
            "type": "string"
        },
        "pack_quantity_native": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "packaging": {
            "description": "Part packaging",
            "maxLength": 50,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "supplier": {
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "updated": {
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "MPN",
        "SKU",
        "availability_updated",
        "barcode_hash",
        "in_stock",
        "manufacturer",
        "name",
        "pack_quantity_native",
        "part",
        "pk",
        "supplier",
        "supplier_detail",
        "updated",
        "url"
    ],
    "type": "object"
}

{
    "MPN": "string",
    "SKU": "string",
    "active": true,
    "availability_updated": "2022-04-13T15:42:05.901Z",
    "available": 10.12,
    "barcode_hash": "string",
    "description": "string",
    "in_stock": 10.12,
    "link": "string",
    "manufacturer": "string",
    "manufacturer_part": 0,
    "name": "string",
    "note": "string",
    "pack_quantity": "string",
    "pack_quantity_native": 10.12,
    "packaging": "string",
    "part": 0,
    "pk": 0,
    "supplier": 0,
    "supplier_detail": null,
    "tags": [
        "string"
    ],
    "updated": "2022-04-13T15:42:05.901Z",
    "url": "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 SupplierPart object.",
    "properties": {
        "MPN": {
            "readOnly": true,
            "type": "string"
        },
        "SKU": {
            "description": "Supplier stock keeping unit",
            "maxLength": 100,
            "type": "string"
        },
        "active": {
            "description": "Is this supplier part active?",
            "type": "boolean"
        },
        "availability_updated": {
            "description": "Date of last update of availability data",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "available": {
            "format": "double",
            "type": "number"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "description": {
            "description": "Supplier part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "link": {
            "description": "URL for external supplier part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "readOnly": true,
            "type": "string"
        },
        "manufacturer_part": {
            "description": "Select manufacturer part",
            "nullable": true,
            "type": "integer"
        },
        "name": {
            "readOnly": true,
            "type": "string"
        },
        "note": {
            "description": "Notes",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "pack_quantity": {
            "description": "Total quantity supplied in a single pack. Leave empty for single items.",
            "maxLength": 25,
            "type": "string"
        },
        "pack_quantity_native": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "packaging": {
            "description": "Part packaging",
            "maxLength": 50,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "supplier": {
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "updated": {
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "MPN",
        "SKU",
        "availability_updated",
        "barcode_hash",
        "in_stock",
        "manufacturer",
        "name",
        "pack_quantity_native",
        "part",
        "pk",
        "supplier",
        "supplier_detail",
        "updated",
        "url"
    ],
    "type": "object"
}

{
    "MPN": "string",
    "SKU": "string",
    "active": true,
    "availability_updated": "2022-04-13T15:42:05.901Z",
    "available": 10.12,
    "barcode_hash": "string",
    "description": "string",
    "in_stock": 10.12,
    "link": "string",
    "manufacturer": "string",
    "manufacturer_part": 0,
    "name": "string",
    "note": "string",
    "pack_quantity": "string",
    "pack_quantity_native": 10.12,
    "packaging": "string",
    "part": 0,
    "pk": 0,
    "supplier": 0,
    "supplier_detail": null,
    "tags": [
        "string"
    ],
    "updated": "2022-04-13T15:42:05.901Z",
    "url": "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 SupplierPart object.",
    "properties": {
        "MPN": {
            "readOnly": true,
            "type": "string"
        },
        "SKU": {
            "description": "Supplier stock keeping unit",
            "maxLength": 100,
            "type": "string"
        },
        "active": {
            "description": "Is this supplier part active?",
            "type": "boolean"
        },
        "availability_updated": {
            "description": "Date of last update of availability data",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "available": {
            "format": "double",
            "type": "number"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "description": {
            "description": "Supplier part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "link": {
            "description": "URL for external supplier part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "readOnly": true,
            "type": "string"
        },
        "manufacturer_part": {
            "description": "Select manufacturer part",
            "nullable": true,
            "type": "integer"
        },
        "name": {
            "readOnly": true,
            "type": "string"
        },
        "note": {
            "description": "Notes",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "pack_quantity": {
            "description": "Total quantity supplied in a single pack. Leave empty for single items.",
            "maxLength": 25,
            "type": "string"
        },
        "pack_quantity_native": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "packaging": {
            "description": "Part packaging",
            "maxLength": 50,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "supplier": {
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "updated": {
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "MPN",
        "SKU",
        "availability_updated",
        "barcode_hash",
        "in_stock",
        "manufacturer",
        "name",
        "pack_quantity_native",
        "part",
        "pk",
        "supplier",
        "supplier_detail",
        "updated",
        "url"
    ],
    "type": "object"
}

Response 201 Created

{
    "MPN": "string",
    "SKU": "string",
    "active": true,
    "availability_updated": "2022-04-13T15:42:05.901Z",
    "available": 10.12,
    "barcode_hash": "string",
    "description": "string",
    "in_stock": 10.12,
    "link": "string",
    "manufacturer": "string",
    "manufacturer_part": 0,
    "name": "string",
    "note": "string",
    "pack_quantity": "string",
    "pack_quantity_native": 10.12,
    "packaging": "string",
    "part": 0,
    "pk": 0,
    "supplier": 0,
    "supplier_detail": null,
    "tags": [
        "string"
    ],
    "updated": "2022-04-13T15:42:05.901Z",
    "url": "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 SupplierPart object.",
    "properties": {
        "MPN": {
            "readOnly": true,
            "type": "string"
        },
        "SKU": {
            "description": "Supplier stock keeping unit",
            "maxLength": 100,
            "type": "string"
        },
        "active": {
            "description": "Is this supplier part active?",
            "type": "boolean"
        },
        "availability_updated": {
            "description": "Date of last update of availability data",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "available": {
            "format": "double",
            "type": "number"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "readOnly": true,
            "type": "string"
        },
        "description": {
            "description": "Supplier part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "in_stock": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "link": {
            "description": "URL for external supplier part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "readOnly": true,
            "type": "string"
        },
        "manufacturer_part": {
            "description": "Select manufacturer part",
            "nullable": true,
            "type": "integer"
        },
        "name": {
            "readOnly": true,
            "type": "string"
        },
        "note": {
            "description": "Notes",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "pack_quantity": {
            "description": "Total quantity supplied in a single pack. Leave empty for single items.",
            "maxLength": 25,
            "type": "string"
        },
        "pack_quantity_native": {
            "format": "double",
            "readOnly": true,
            "type": "number"
        },
        "packaging": {
            "description": "Part packaging",
            "maxLength": 50,
            "nullable": true,
            "type": "string"
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "supplier": {
            "type": "integer"
        },
        "supplier_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "updated": {
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "type": "string"
        },
        "url": {
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "MPN",
        "SKU",
        "availability_updated",
        "barcode_hash",
        "in_stock",
        "manufacturer",
        "name",
        "pack_quantity_native",
        "part",
        "pk",
        "supplier",
        "supplier_detail",
        "updated",
        "url"
    ],
    "type": "object"
}

DELETE /api/company/part/manufacturer/

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/company/part/manufacturer/

Description

API endpoint for list view of ManufacturerPart object.

  • GET: Return list of ManufacturerPart objects
  • POST: Create a new ManufacturerPart 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"
limit query integer No Number of results to return per page.
manufacturer query integer No
manufacturer_active query boolean No Manufacturer is Active
MPN query string No
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.
part query integer No
part_active query boolean No Part is Active
search query string No A search term.
tags__name query string No
tags__slug query string 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": [
        {
            "MPN": "string",
            "barcode_hash": "string",
            "description": "string",
            "link": "string",
            "manufacturer": 0,
            "manufacturer_detail": null,
            "part": 0,
            "pk": 0,
            "tags": [
                "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/ManufacturerPart"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/part/manufacturer/

Description

API endpoint for list view of ManufacturerPart object.

  • GET: Return list of ManufacturerPart objects
  • POST: Create a new ManufacturerPart 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

{
    "MPN": "string",
    "barcode_hash": "string",
    "description": "string",
    "link": "string",
    "manufacturer": 0,
    "manufacturer_detail": null,
    "part": 0,
    "pk": 0,
    "tags": [
        "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 ManufacturerPart object.",
    "properties": {
        "MPN": {
            "description": "Manufacturer Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "description": {
            "description": "Manufacturer part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "URL for external manufacturer part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "type": "integer"
        },
        "manufacturer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        }
    },
    "required": [
        "MPN",
        "manufacturer",
        "manufacturer_detail",
        "part",
        "pk"
    ],
    "type": "object"
}

{
    "MPN": "string",
    "barcode_hash": "string",
    "description": "string",
    "link": "string",
    "manufacturer": 0,
    "manufacturer_detail": null,
    "part": 0,
    "pk": 0,
    "tags": [
        "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 ManufacturerPart object.",
    "properties": {
        "MPN": {
            "description": "Manufacturer Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "description": {
            "description": "Manufacturer part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "URL for external manufacturer part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "type": "integer"
        },
        "manufacturer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        }
    },
    "required": [
        "MPN",
        "manufacturer",
        "manufacturer_detail",
        "part",
        "pk"
    ],
    "type": "object"
}

{
    "MPN": "string",
    "barcode_hash": "string",
    "description": "string",
    "link": "string",
    "manufacturer": 0,
    "manufacturer_detail": null,
    "part": 0,
    "pk": 0,
    "tags": [
        "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 ManufacturerPart object.",
    "properties": {
        "MPN": {
            "description": "Manufacturer Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "description": {
            "description": "Manufacturer part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "URL for external manufacturer part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "type": "integer"
        },
        "manufacturer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        }
    },
    "required": [
        "MPN",
        "manufacturer",
        "manufacturer_detail",
        "part",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

{
    "MPN": "string",
    "barcode_hash": "string",
    "description": "string",
    "link": "string",
    "manufacturer": 0,
    "manufacturer_detail": null,
    "part": 0,
    "pk": 0,
    "tags": [
        "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 ManufacturerPart object.",
    "properties": {
        "MPN": {
            "description": "Manufacturer Part Number",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
        },
        "barcode_hash": {
            "description": "Unique hash of barcode data",
            "maxLength": 128,
            "type": "string"
        },
        "description": {
            "description": "Manufacturer part description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "link": {
            "description": "URL for external manufacturer part link",
            "format": "uri",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
        },
        "manufacturer": {
            "type": "integer"
        },
        "manufacturer_detail": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/CompanyBrief"
                }
            ],
            "readOnly": true
        },
        "part": {
            "description": "Select part",
            "title": "Base Part",
            "type": "integer"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array"
        }
    },
    "required": [
        "MPN",
        "manufacturer",
        "manufacturer_detail",
        "part",
        "pk"
    ],
    "type": "object"
}

DELETE /api/company/part/manufacturer/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/company/part/manufacturer/attachment/

Description

API endpoint for listing, creating and bulk deleting a ManufacturerPartAttachment (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.
manufacturer_part query integer No
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.
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",
            "manufacturer_part": 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/ManufacturerPartAttachment"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/part/manufacturer/attachment/

Description

API endpoint for listing, creating and bulk deleting a ManufacturerPartAttachment (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",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 201 Created

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

DELETE /api/company/part/manufacturer/attachment/{id}/

Description

Detail endpooint for ManufacturerPartAttachment 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 204 No Content


GET /api/company/part/manufacturer/attachment/{id}/

Description

Detail endpooint for ManufacturerPartAttachment 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

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PATCH /api/company/part/manufacturer/attachment/{id}/

Description

Detail endpooint for ManufacturerPartAttachment 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

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

PUT /api/company/part/manufacturer/attachment/{id}/

Description

Detail endpooint for ManufacturerPartAttachment 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

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

Response 200 OK

{
    "attachment": "string",
    "comment": "string",
    "filename": "string",
    "link": "string",
    "manufacturer_part": 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": "Serializer for the ManufacturerPartAttachment class.",
    "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"
        },
        "manufacturer_part": {
            "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": [
        "manufacturer_part",
        "pk",
        "upload_date",
        "user_detail"
    ],
    "type": "object"
}

DELETE /api/company/part/manufacturer/parameter/

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/company/part/manufacturer/parameter/

Description

API endpoint for list view of ManufacturerPartParamater 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"
limit query integer No Number of results to return per page.
manufacturer query integer No
manufacturer_part query integer No
name query string No
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.
part query integer No
search query string No A search term.
units query string No
value query string 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": [
        {
            "manufacturer_part": 0,
            "name": "string",
            "pk": 0,
            "units": "string",
            "value": "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/ManufacturerPartParameter"
            },
            "type": "array"
        }
    },
    "type": "object"
}

POST /api/company/part/manufacturer/parameter/

Description

API endpoint for list view of ManufacturerPartParamater 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"

Request body

{
    "manufacturer_part": 0,
    "name": "string",
    "pk": 0,
    "units": "string",
    "value": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the ManufacturerPartParameter model.",
    "properties": {
        "manufacturer_part": {
            "type": "integer"
        },
        "name": {
            "description": "Parameter name",
            "maxLength": 500,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "units": {
            "description": "Parameter units",
            "maxLength": 64,
            "nullable": true,
            "type": "string"
        },
        "value": {
            "description": "Parameter value",
            "maxLength": 500,
            "type": "string"
        }
    },
    "required": [
        "manufacturer_part",
        "name",
        "pk",
        "value"
    ],
    "type": "object"
}

{
    "manufacturer_part": 0,
    "name": "string",
    "pk": 0,
    "units": "string",
    "value": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the ManufacturerPartParameter model.",
    "properties": {
        "manufacturer_part": {
            "type": "integer"
        },
        "name": {
            "description": "Parameter name",
            "maxLength": 500,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "units": {
            "description": "Parameter units",
            "maxLength": 64,
            "nullable": true,
            "type": "string"
        },
        "value": {
            "description": "Parameter value",
            "maxLength": 500,
            "type": "string"
        }
    },
    "required": [
        "manufacturer_part",
        "name",
        "pk",
        "value"
    ],
    "type": "object"
}

{
    "manufacturer_part": 0,
    "name": "string",
    "pk": 0,
    "units": "string",
    "value": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "description": "Serializer for the ManufacturerPartParameter model.",
    "properties": {
        "manufacturer_part": {
            "type": "integer"
        },
        "name": {
            "description": "Parameter name",
            "maxLength": 500