The Item Default object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
company string required
default_warehouse string
default_price_list string
buying_cost_center string
default_supplier string
expense_account string
selling_cost_center string
income_account string
default_discount_account string
default_provisional_account string
deferred_expense_account string
deferred_revenue_account string
default_cogs_account string
purchase_expense_account string
purchase_expense_contra_account string
default_inventory_account string
inventory_account_currency string
The Item Default object 
{
  "id": "item-default_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp",
  "default_warehouse": "default_warehouse_example",
  "default_price_list": "default_price_list_example",
  "buying_cost_center": "buying_cost_center_example",
  "default_supplier": "default_supplier_example",
  "expense_account": "expense_account_example",
  "selling_cost_center": "selling_cost_center_example",
  "income_account": "income_account_example",
  "default_discount_account": "default_discount_account_example",
  "default_provisional_account": "default_provisional_account_example",
  "deferred_expense_account": "deferred_expense_account_example",
  "deferred_revenue_account": "deferred_revenue_account_example",
  "default_cogs_account": "default_cogs_account_example",
  "purchase_expense_account": "purchase_expense_account_example",
  "purchase_expense_contra_account": "purchase_expense_contra_account_example",
  "default_inventory_account": "default_inventory_account_example",
  "inventory_account_currency": "USD"
}
GET /api/stock/item-default?parent_id={id}

List item defaults by parent

Returns all item defaults belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of item default objects belonging to the parent.

GET /api/stock/item-default?parent_id={id} 
curl https://api.overplane.dev/api/stock/item-default?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "item-default_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "company": "Example Corp",
      "default_warehouse": "default_warehouse_example",
      "default_price_list": "default_price_list_example",
      "buying_cost_center": "buying_cost_center_example",
      "default_supplier": "default_supplier_example",
      "expense_account": "expense_account_example",
      "selling_cost_center": "selling_cost_center_example",
      "income_account": "income_account_example",
      "default_discount_account": "default_discount_account_example",
      "default_provisional_account": "default_provisional_account_example",
      "deferred_expense_account": "deferred_expense_account_example",
      "deferred_revenue_account": "deferred_revenue_account_example",
      "default_cogs_account": "default_cogs_account_example",
      "purchase_expense_account": "purchase_expense_account_example",
      "purchase_expense_contra_account": "purchase_expense_contra_account_example",
      "default_inventory_account": "default_inventory_account_example",
      "inventory_account_currency": "USD"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/item-default

Create a item default

Creates a new item default object.

Body parameters

idx integer
parent_id string required
parent_type string required
company string required
default_warehouse string
default_price_list string
buying_cost_center string
default_supplier string
expense_account string
selling_cost_center string
income_account string
default_discount_account string
default_provisional_account string
deferred_expense_account string
deferred_revenue_account string
default_cogs_account string
purchase_expense_account string
purchase_expense_contra_account string
default_inventory_account string
inventory_account_currency string

Returns

Returns the newly created item default object if the call succeeded.

POST /api/stock/item-default 
curl https://api.overplane.dev/api/stock/item-default \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","company":"Example Corp"}'
Response 
{
  "id": "item-default_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp",
  "default_warehouse": "default_warehouse_example",
  "default_price_list": "default_price_list_example",
  "buying_cost_center": "buying_cost_center_example",
  "default_supplier": "default_supplier_example",
  "expense_account": "expense_account_example",
  "selling_cost_center": "selling_cost_center_example",
  "income_account": "income_account_example",
  "default_discount_account": "default_discount_account_example",
  "default_provisional_account": "default_provisional_account_example",
  "deferred_expense_account": "deferred_expense_account_example",
  "deferred_revenue_account": "deferred_revenue_account_example",
  "default_cogs_account": "default_cogs_account_example",
  "purchase_expense_account": "purchase_expense_account_example",
  "purchase_expense_contra_account": "purchase_expense_contra_account_example",
  "default_inventory_account": "default_inventory_account_example",
  "inventory_account_currency": "USD"
}
PATCH /api/stock/item-default/{id}

Update a item default

Updates the specified item default by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the item default to update.

Body parameters

idx integer
parent_id string
parent_type string
company string
default_warehouse string
default_price_list string
buying_cost_center string
default_supplier string
expense_account string
selling_cost_center string
income_account string
default_discount_account string
default_provisional_account string
deferred_expense_account string
deferred_revenue_account string
default_cogs_account string
purchase_expense_account string
purchase_expense_contra_account string
default_inventory_account string
inventory_account_currency string

Returns

Returns the updated item default object.

PATCH /api/stock/item-default/{id} 
curl https://api.overplane.dev/api/stock/item-default/item-default_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "item-default_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp",
  "default_warehouse": "default_warehouse_example",
  "default_price_list": "default_price_list_example",
  "buying_cost_center": "buying_cost_center_example",
  "default_supplier": "default_supplier_example",
  "expense_account": "expense_account_example",
  "selling_cost_center": "selling_cost_center_example",
  "income_account": "income_account_example",
  "default_discount_account": "default_discount_account_example",
  "default_provisional_account": "default_provisional_account_example",
  "deferred_expense_account": "deferred_expense_account_example",
  "deferred_revenue_account": "deferred_revenue_account_example",
  "default_cogs_account": "default_cogs_account_example",
  "purchase_expense_account": "purchase_expense_account_example",
  "purchase_expense_contra_account": "purchase_expense_contra_account_example",
  "default_inventory_account": "default_inventory_account_example",
  "inventory_account_currency": "USD"
}
DELETE /api/stock/item-default/{id}

Delete a item default

Permanently deletes a item default. This cannot be undone.

Path parameters

id string required

The identifier of the item default to delete.

Returns

Returns a confirmation that the item default has been deleted.

DELETE /api/stock/item-default/{id} 
curl https://api.overplane.dev/api/stock/item-default/item-default_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "item-default_abc123",
  "deleted": true
}
POST /api/stock/item-default/reorder

Reorder item defaults

Updates the sort order of item defaults within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/stock/item-default/reorder 
curl https://api.overplane.dev/api/stock/item-default/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "item-default_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "company": "Example Corp",
  "default_warehouse": "default_warehouse_example",
  "default_price_list": "default_price_list_example",
  "buying_cost_center": "buying_cost_center_example",
  "default_supplier": "default_supplier_example",
  "expense_account": "expense_account_example",
  "selling_cost_center": "selling_cost_center_example",
  "income_account": "income_account_example",
  "default_discount_account": "default_discount_account_example",
  "default_provisional_account": "default_provisional_account_example",
  "deferred_expense_account": "deferred_expense_account_example",
  "deferred_revenue_account": "deferred_revenue_account_example",
  "default_cogs_account": "default_cogs_account_example",
  "purchase_expense_account": "purchase_expense_account_example",
  "purchase_expense_contra_account": "purchase_expense_contra_account_example",
  "default_inventory_account": "default_inventory_account_example",
  "inventory_account_currency": "USD"
}