Skip to content
Developerhome
Back to Sage 200
API docs by Redocly

Sage 200 v1 Extra Stock (1.0)

Download OpenAPI specification:Download

Alternative Product Views

Alternative Product Views

"This specifies a lookup linking products with products that are an alternative for it."

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Alternative Products

Alternative Products

Alternative products are suitable products that can be offered when a requested product is unavailable. An alternative product can be the preferred alternative for a product. When stock is issued for a sales order, if the product is unavailable, the preferred alternative can be chosen, if stock is available.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Alternative Products

Alternative products are suitable products that can be offered when a requested product is unavailable. An alternative product can be the preferred alternative for a product. When stock is issued for a sales order, if the product is unavailable, the preferred alternative can be chosen, if stock is available.

Request Body schema: application/json
required

Alternative product to add.

product_id
required
integer <int64>

Product record Id.

alternative_product_id
required
integer <int64>

Alternative product record Id.

is_preferred
boolean

Whether the alternative product is the preferred alternative for the product.

is_to_delete
boolean

When updating an existing product, whether to delete this alternative product from the collection of product alternative products.

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "alternative_product_id": 0,
  • "is_preferred": true,
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "alternative_product_id": 0,
  • "is_preferred": true,
  • "is_to_delete": true,
  • "alternative_product": { },
  • "product": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Alternative Product

Alternative products are suitable products that can be offered when a requested product is unavailable. An alternative product can be the preferred alternative for a product. When stock is issued for a sales order, if the product is unavailable, the preferred alternative can be chosen, if stock is available.

path Parameters
Id
required
number

Unique Id of the alternative product.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "alternative_product_id": 0,
  • "is_preferred": true,
  • "is_to_delete": true,
  • "alternative_product": { },
  • "product": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Alternative Product

Alternative products are suitable products that can be offered when a requested product is unavailable. An alternative product can be the preferred alternative for a product. When stock is issued for a sales order, if the product is unavailable, the preferred alternative can be chosen, if stock is available.

path Parameters
Id
required
number

Unique Id of the alternative product.

Request Body schema: application/json
required

Alternative product to update in Sage 200 Stock Ledger.

product_id
required
integer <int64>

Product record Id.

alternative_product_id
required
integer <int64>

Alternative product record Id.

is_preferred
boolean

Whether the alternative product is the preferred alternative for the product.

is_to_delete
boolean

When updating an existing product, whether to delete this alternative product from the collection of product alternative products.

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "alternative_product_id": 0,
  • "is_preferred": true,
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "alternative_product_id": 0,
  • "is_preferred": true,
  • "is_to_delete": true,
  • "alternative_product": { },
  • "product": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Alternative Product

Alternative products are suitable products that can be offered when a requested product is unavailable. An alternative product can be the preferred alternative for a product. When stock is issued for a sales order, if the product is unavailable, the preferred alternative can be chosen, if stock is available.

path Parameters
Id
required
number

Unique Id of the alternative product.

Responses

Auto Generate Option Types

Auto Generate Option Types

Auto generate option types are used to auto generate the batch or serial numbers associated with the product that exist within the application. Products can be 'No automatic number generation', 'Use sequence numbers', 'Use date and sequence numbers' or 'Use order number and sequence number'.

The API endpoint returns details of the auto generate option types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auto Generate Separators

Auto Generate Separators

Auto generate separators are used to auto generate the batch or serial numbers associated with the product that exist within the application. Auto generate separators can be 'None', 'Space', 'Colon', 'Forward Slash', 'Backward Slash', 'Dot' or 'Hyphen'.

The API endpoint returns details of the auto generate option types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auto Generate Separator

Auto generate separators are used to auto generate the batch or serial numbers associated with the product that exist within the application. Auto generate separators can be 'None', 'Space', 'Colon', 'Forward Slash', 'Backward Slash', 'Dot' or 'Hyphen'.

The API endpoint returns details of the auto generate option types that can be used.

path Parameters
Id
required
number

Unique Id of the auto generate separator.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "separator_character": "s",
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Bin Holdings

Bin Holdings

Bins allow you to specify a place in a Warehouse where stock is stored such as a shelf or aisle. Every Warehouse has a single Bin created by default called 'Unspecified'. If you don't want to use bins with your warehouses, all items are stored in the 'Unspecified' bin. You can rename the 'Unspecified' bin to something more meaningful for your company.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bin Holdings

Bins allow you to specify a place in a Warehouse where stock is stored such as a shelf or aisle. Every Warehouse has a single Bin created by default called 'Unspecified'. If you don't want to use bins with your warehouses, all items are stored in the 'Unspecified' bin. You can rename the 'Unspecified' bin to something more meaningful for your company.

Request Body schema: application/json
required

BinHolding to add.

product_id
required
integer <int64>

Product record Id.

warehouse_holding_id
required
integer <int64>

Warehouse holding record Id.

name
string <= 20 characters

Bin name.

allocation_priority
integer <int64>
Default: 9

Allocation priority, between 1 and 9.

is_to_delete
boolean

When updating an existing warehouse holding, whether to delete this bin holding from the collection of warehouse holding bin holdings.

product
object

Product.

warehouse_holding
object

Warehouse holding.

Responses

Request samples

Content type
application/json
{
  • "warehouse_holding_id": 0,
  • "product_id": 0,
  • "name": "string",
  • "allocation_priority": 9,
  • "is_to_delete": true,
  • "product": { },
  • "warehouse_holding": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "warehouse_holding_id": 0,
  • "product_id": 0,
  • "name": "string",
  • "allocation_priority": 9,
  • "quantity_reserved": 0,
  • "unconfirmed_qty_in_stock": 0,
  • "confirmed_qty_in_stock": 0,
  • "quantity_allocated_sop": 0,
  • "quantity_allocated_stock": 0,
  • "quantity_allocated_bom": 0,
  • "quantity_in_stock": 0,
  • "quantity_in_stock_less_reserved": 0,
  • "quantity_allocated": 0,
  • "free_stock_available": 0,
  • "free_stock_available_less_reserved": 0,
  • "last_stocktake": "2019-08-24T14:15:22Z",
  • "is_to_delete": true,
  • "product": { },
  • "warehouse_holding": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Bin Holding

Return a single bin holding resource by supplying a bin holding Id.

path Parameters
Id
required
number

Unique Id of the bin holding.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "warehouse_holding_id": 0,
  • "product_id": 0,
  • "name": "string",
  • "allocation_priority": 9,
  • "quantity_reserved": 0,
  • "unconfirmed_qty_in_stock": 0,
  • "confirmed_qty_in_stock": 0,
  • "quantity_allocated_sop": 0,
  • "quantity_allocated_stock": 0,
  • "quantity_allocated_bom": 0,
  • "quantity_in_stock": 0,
  • "quantity_in_stock_less_reserved": 0,
  • "quantity_allocated": 0,
  • "free_stock_available": 0,
  • "free_stock_available_less_reserved": 0,
  • "last_stocktake": "2019-08-24T14:15:22Z",
  • "is_to_delete": true,
  • "product": { },
  • "warehouse_holding": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Bin Holding

Update a single bin holding resource by supplying a bin holding Id.

path Parameters
Id
required
number

Unique Id of the bin holding.

Request Body schema: application/json
required

Bin holding to update.

product_id
required
integer <int64>

Product record Id.

warehouse_holding_id
required
integer <int64>

Warehouse holding record Id.

name
string <= 20 characters

Bin name.

allocation_priority
integer <int64>
Default: 9

Allocation priority, between 1 and 9.

is_to_delete
boolean

When updating an existing warehouse holding, whether to delete this bin holding from the collection of warehouse holding bin holdings.

product
object

Product.

warehouse_holding
object

Warehouse holding.

Responses

Request samples

Content type
application/json
{
  • "warehouse_holding_id": 0,
  • "product_id": 0,
  • "name": "string",
  • "allocation_priority": 9,
  • "is_to_delete": true,
  • "product": { },
  • "warehouse_holding": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "warehouse_holding_id": 0,
  • "product_id": 0,
  • "name": "string",
  • "allocation_priority": 9,
  • "quantity_reserved": 0,
  • "unconfirmed_qty_in_stock": 0,
  • "confirmed_qty_in_stock": 0,
  • "quantity_allocated_sop": 0,
  • "quantity_allocated_stock": 0,
  • "quantity_allocated_bom": 0,
  • "quantity_in_stock": 0,
  • "quantity_in_stock_less_reserved": 0,
  • "quantity_allocated": 0,
  • "free_stock_available": 0,
  • "free_stock_available_less_reserved": 0,
  • "last_stocktake": "2019-08-24T14:15:22Z",
  • "is_to_delete": true,
  • "product": { },
  • "warehouse_holding": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Bin Holding

Delete a single bin holding resource by supplying a bin holding Id.

path Parameters
Id
required
number

Unique Id of the bin holding.

Responses

Bin Holdings For Warehouse Holding

Returns collection of bin holdings for warehouse holding.

path Parameters
warehouseHoldingId
required
number

Unique Id of the warehouse holding.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bin Holdings For Product

Returns collection of bin holdings for product.

path Parameters
productId
required
number

Unique Id of the product.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bom Cost Heading Types

BOM Cost Heading Types

When calculating the cost of BOMs, estimates or works orders, the values are accumulated in a cost heading.

The API endpoint returns details of the cost heading types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bom Cost Headings

BOM Cost Headings

When calculating the cost of BOMs, estimates or works orders, the values are accumulated in a cost heading.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BOM Cost Heading

When calculating the cost of BOMs, estimates or works orders, the values are accumulated in a cost heading.

path Parameters
Id
required
number

Unique Id of the cost heading.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "bom_cost_heading_type": "string",
  • "name": "string",
  • "markup": 0,
  • "overhead_recovery_percent": 0,
  • "reserved": true,
  • "date_time_created": "2019-08-24T14:15:22Z"
}

Bom Item Types

Bill Of Materials Item Types

Bill of materials item types are used to identify how this product will be used in a bill of materials within the application. Products can be 'Component', 'Subassembly', 'Phantom' or 'Built/Bought'.

The API endpoint returns details of the bill of materials item types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Costing Method Types

Costing Method Types

Costing method types are used to calculate the cost of sales from your sales orders, the value of stock and the transactions posted to your stock nominal accounts within the application. Product groups can be 'FIFO', 'Average', 'Standard' or 'Actual'.

The API endpoint returns details of the costing method types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cross Sell Product Views

Cross Sell Product Views

"This resource returns a lookup linking products with products that it can be cross sold with."

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cross Sell Products

Cross Sell Products

Cross sell products are complimentary products which are often sold together with another product. For example, if you sell a printer, you might want to show print cartridges or cables for that printer. Cross sell products can help speed up entering a full sales order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cross Sell Products

Cross sell products are complimentary products which are often sold together with another product. For example, if you sell a printer, you might want to show print cartridges or cables for that printer. Cross sell products can help speed up entering a full sales order.

Request Body schema: application/json
required

Cross sell product to add.

product_id
required
integer <int64>

Product record Id.

cross_sell_product_id
required
integer <int64>

Cross sell product record Id.

is_to_delete
boolean

When updating an existing product, whether to delete this cross sell product from the collection of product cross sell products.

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "cross_sell_product_id": 0,
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "cross_sell_product_id": 0,
  • "is_to_delete": true,
  • "cross_sell_product": { },
  • "product": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Cross Sell Product

Cross sell products are complimentary products which are often sold together with another product. For example, if you sell a printer, you might want to show print cartridges or cables for that printer. Cross sell products can help speed up entering a full sales order.

path Parameters
Id
required
number

Unique Id of the cross sell product.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "cross_sell_product_id": 0,
  • "is_to_delete": true,
  • "cross_sell_product": { },
  • "product": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Cross Sell Product

Cross sell products are complimentary products which are often sold together with another product. For example, if you sell a printer, you might want to show print cartridges or cables for that printer. Cross sell products can help speed up entering a full sales order.

path Parameters
Id
required
number

Unique Id of the cross sell product.

Request Body schema: application/json
required

Cross sell product to update in Sage 200 Stock Ledger.

product_id
required
integer <int64>

Product record Id.

cross_sell_product_id
required
integer <int64>

Cross sell product record Id.

is_to_delete
boolean

When updating an existing product, whether to delete this cross sell product from the collection of product cross sell products.

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "cross_sell_product_id": 0,
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "cross_sell_product_id": 0,
  • "is_to_delete": true,
  • "cross_sell_product": { },
  • "product": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Cross Sell Product

Cross sell products are complimentary products which are often sold together with another product. For example, if you sell a printer, you might want to show print cartridges or cables for that printer. Cross sell products can help speed up entering a full sales order.

path Parameters
Id
required
number

Unique Id of the cross sell product.

Responses

Discrepancy Status Types

Iscrepancy Status Types

Discrepancy status types describe the possible states of a stocktake discrepancy. Discrepancy status type can be 'No Discrepancy', 'Discrepancy Found', or 'Discrepancy Resolved'.

The API endpoint returns details of the discrepancy status types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entry Source Types

Entry Source Types

Entry source types are used to describe the source module that was used to create a transaction. Entry source types can be 'EnumEntrySourceTypeStock', 'EnumEntrySourceTypeSOP', 'EnumEntrySourceTypePOP', 'EnumEntrySourceTypeBOM', 'EnumEntrySourceTypeManual'.

The API endpoint returns details of the entry source types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fulfilment Method Types

Fulfilment Method Types

Fulfilment method types are the method of fulfilment for your products on sales orders. This determines how the products are allocated. Fulfmilment methods are 'From Stock', 'From Supplier Via Stock' and 'Direct To Customer'.

The API endpoint returns details of the fulfilment method types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fulfilment Sequence Types

Fulfilment Sequence Types

Fulfilment sequence types are the sequence options for the fulfilment methods used for product allocation which determines how products are allocated to sales orders within the application. Products can sequenced by 'Bin Priority', 'Smallest Quantity First', 'Largest Quantity First', 'Oldest Sell By Date', 'Oldest Use By Date' or 'FIFO'.

The API endpoint returns details of the fulfilment sequence types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Internal Areas

Internal Areas

The internal areas represent departments such as sales, retail and production. Use them to monitor stock issued for internal use.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Internal Area

The internal areas represent departments such as sales, retail and production. Use them to monitor stock issued for internal use.

path Parameters
Id
required
number

Unique Id of the internal area.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "is_default": true,
  • "nominal_code_id": 0,
  • "nominal_code": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Label Printing Option Types

Label Printing Option Types

Label printing option types used to determine how to print order lablels. The label printing option types are 'Label not required', 'Label required per item' and 'Label required per batch'.

The API endpoint returns details of the label printing option types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Landed Costs Types

Landed Costs Types

Landed costs refer to any costs associated with the shipping, handling and importing of stock items on purchase orders. These additional costs are often invoiced separately, for example, by a courier. Landed costs type can be 'Not Applicable', 'Percentage Based', or 'Value Based'.

The API endpoint returns details of the costing method types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Product Groups

Lookup Product Groups

Gets a subset of product group information for populating a lookup.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Products

Lookup Products

Gets a subset of product information for populating a lookup.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lookup Stock Item Units

Lookup Stock Item Units

Gets a subset of Stock Item Unit information for populating a lookup.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pricing Source Types

Pricing Source Types

The pricing source type for product suppliers. Pricing source type can be 'LastBuyingPrice', or 'ListPrice'.

The API endpoint returns details of the pricing source types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Group Search Category Values

Product Group Search Category Values

This API endpoint returns a list of the allowed values for a product group search category.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Groups

Product Groups

Product groups are used to group stock items together with similar characteristics or requirements. Product Groups provide several default settings for stock items and have their own unique code and description.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Group

Product groups are used to group stock items together with similar characteristics or requirements. Product Groups provide several default settings for stock items and have their own unique code and description.

path Parameters
Id
required
number

Unique Id of the product group.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "description": "string",
  • "product_type": "string",
  • "costing_method": "string",
  • "stocktake_cycle_period": 0,
  • "label_printing_option_type": "string",
  • "keep_movement_history": true,
  • "can_levels_go_negative": true,
  • "can_over_allocate_negative_stock": true,
  • "use_description_on_documents": true,
  • "use_reverse_charge_vat_rules": true,
  • "do_items_use_units": true,
  • "this_is_the_sop_product_group": true,
  • "selling_quantities_use_multiple_units": true,
  • "selling_prices_use_multiple_units": true,
  • "buying_quantities_use_multiple_units": true,
  • "buying_prices_use_multiple_units": true,
  • "do_items_use_markup": true,
  • "use_landed_costs": true,
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "traceable_type": "string",
  • "sale_from_single_batch": true,
  • "allow_duplicate_numbers": true,
  • "uses_alternative_ref": true,
  • "uses_sell_by_date": true,
  • "uses_use_by_date": true,
  • "stock_nominal_code_id": 0,
  • "revenue_nominal_code_id": 0,
  • "accrual_nominal_code_id": 0,
  • "issue_nominal_code_id": 0,
  • "base_unit_id": 0,
  • "stock_unit_id": 0,
  • "accrual_nominal_code": { },
  • "issue_nominal_code": { },
  • "revenue_nominal_code": { },
  • "stock_nominal_code": { },
  • "base_unit": { },
  • "stock_unit": { },
  • "search_categories": [
    ],
  • "units": [
    ],
  • "bom_settings": {
    },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product Memos

Product Memos

Memos are sections of text that can be used to make comments about a product.

Multiple memos can be added to each product. The user that created the memo, the date it was created and last updated date and time are also recorded.

A user can also specify if a memo is currently 'Active' or 'Inactive'. This allows a user to keep a record of previous memos without deleting them.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Memos

Memos are sections of text that can be used to make comments about a product.

Multiple memos can be added to each product. The user that created the memo, the date it was created and last updated date and time are also recorded.

A user can also specify if a memo is currently 'Active' or 'Inactive'. This allows a user to keep a record of previous memos without deleting them.

Request Body schema: application/json
required

Product memo to add.

product_id
required
integer <int64>

Product record Id.

note
required
string <= 1000 characters

The memo text.

is_active
boolean

True if memo status is active, false if it is inactive.

is_to_delete
boolean

When updating an existing product, whether to delete this memo from the collection of product memos.

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "is_active": true,
  • "note": "string",
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "is_active": true,
  • "note": "string",
  • "is_to_delete": true,
  • "created_by": "string",
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product Memo

Memos are sections of text that can be used to make comments about a product.

Multiple memos can be added to each product. The user that created the memo, the date it was created and last updated date and time are also recorded.

A user can also specify if a memo is currently 'Active' or 'Inactive'. This allows a user to keep a record of previous memos without deleting them.

path Parameters
Id
required
number

Unique Id of the product memo.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "is_active": true,
  • "note": "string",
  • "is_to_delete": true,
  • "created_by": "string",
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product Memo

Memos are sections of text that can be used to make comments about a product.

Multiple memos can be added to each product. The user that created the memo, the date it was created and last updated date and time are also recorded.

A user can also specify if a memo is currently 'Active' or 'Inactive'. This allows a user to keep a record of previous memos without deleting them.

path Parameters
Id
required
number

Unique Id of the product memo.

Request Body schema: application/json
required

Product memo to update.

product_id
required
integer <int64>

Product record Id.

note
required
string <= 1000 characters

The memo text.

is_active
boolean

True if memo status is active, false if it is inactive.

is_to_delete
boolean

When updating an existing product, whether to delete this memo from the collection of product memos.

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "is_active": true,
  • "note": "string",
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "is_active": true,
  • "note": "string",
  • "is_to_delete": true,
  • "created_by": "string",
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product Memo

Memos are sections of text that can be used to make comments about a product.

Multiple memos can be added to each product. The user that created the memo, the date it was created and last updated date and time are also recorded.

A user can also specify if a memo is currently 'Active' or 'Inactive'. This allows a user to keep a record of previous memos without deleting them.

path Parameters
Id
required
number

Unique Id of the product memo.

Responses

Product Purchase Figures

Product Purchase Figures

Purchase trading figures are the quantities and value of goods bought in base currency. These figures are available if a stock item is set to maintain a movement history. Trading figures are not available for phantom BOM built items.

This endpoint has custom filtering on the following fields: 'no_of_periods', 'warehouse_name', 'source_area_reference' and analysis codes 1-20 (analysis_code_n).

path Parameters
Id
required
number

Unique Id of the product.

Responses

Response samples

Content type
application/json
{
  • "quantity_bought_this_period": 0,
  • "value_bought_this_period": 0,
  • "quantity_bought_last_period": 0,
  • "value_bought_last_period": 0,
  • "periods": [
    ]
}

Product Sales Figures

Product Sales Figures

Sales trading figures are the quantities and value of goods sold in base currency. These figures are available if a stock item is set to maintain a movement history. Trading figures are not available for phantom BOM built items.

This endpoint has custom filtering on the following fields: 'no_of_periods', 'warehouse_name', 'source_area_reference' and analysis codes 1-20 (analysis_code_n).

path Parameters
Id
required
number

Unique Id of the product.

Responses

Response samples

Content type
application/json
{
  • "quantity_sold_this_period": 0,
  • "value_sold_this_period": 0,
  • "quantity_sold_last_period": 0,
  • "value_sold_last_period": 0,
  • "periods": [
    ]
}

Product Search

Returns matching products associated with the search category values passed.

Responses

Response samples

Content type
application/json
{
  • "search_category_values": [
    ],
  • "show_inactive": "false",
  • "show_phantom": "false",
  • "show_only_allow_sales_order": "false",
  • "product_search_type": "EnumStockItemTypeAll",
  • "matching_products": [
    ]
}

Product Search Types

Product Search Types

Product search types.

The API endpoint returns details of the product search types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Status Types

Product Status Types

Product status types are used to identify when a product can have a stock movement recorded against it within the application. Products can be 'Active' or 'Inactive'.

The API endpoint returns details of the product status types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Suppliers

Product Suppliers

Product suppliers are used to record suppliers of products. The supplier details are used when creating purchase orders. A supplier can be the preferred supplier for a product. The preferred supplier details are suggested when entering a purchase order for the product.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Suppliers

Product suppliers are used to record suppliers of products. The supplier details are used when creating purchase orders. A supplier can be the preferred supplier for a product. The preferred supplier details are suggested when entering a purchase order for the product.

Request Body schema: application/json
required

Product supplier to add.

supplier_id
required
integer <int64>

Supplier record Id.

supplier_stock_code
string <= 60 characters

The supplier stock code.

lead_time
integer <int16>

Lead time in lead time units for the product from the supplier.

lead_time_unit
string <= 20 characters

The lead time unit of the product.

usual_order_quantity
number <decimal 5dp>

The usual order quantity for the product from the supplier.

minimum_order_quantity
number <decimal 5dp>

The minimum order quantity for the product from the supplier.

list_price
number <decimal 5dp>

The supplier's price for the product.

list_price_expiry_date
string <date-time>

The date the list price expires.

default_pricing_source_type
string <= 20 characters

The default pricing source type of the product.

landed_costs_type
string <= 20 characters

The landed costs type of the product when ordering from the supplier.

landed_costs_percentage
number <decimal 2dp>

The percentage of the product's cost which is landed costs (if the landed costs type is Percentage Based).

landed_costs_per_item
number <decimal 2dp>

The amount of the product's cost which is landed costs (if the landed costs type is Value Based).

last_buying_price
number <decimal 5dp>

The last price paid for the product from the supplier.

is_preferred
boolean

Whether the supplier is the preferred supplier for the product.

country_of_origin_id
integer <int64>

If you produce Intrastat reports, the product country of origin record Id from the supplier.

is_to_delete
boolean

When updating an existing product, whether to delete this supplier from the collection of product suppliers.

Responses

Request samples

Content type
application/json
{
  • "supplier_id": 0,
  • "supplier_stock_code": "string",
  • "lead_time": 0,
  • "lead_time_unit": "string",
  • "usual_order_quantity": 0,
  • "minimum_order_quantity": 0,
  • "list_price": 0,
  • "list_price_expiry_date": "2019-08-24T14:15:22Z",
  • "default_pricing_source_type": "string",
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "last_buying_price": 0,
  • "is_preferred": true,
  • "country_of_origin_id": 0,
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "supplier_id": 0,
  • "supplier_stock_code": "string",
  • "lead_time": 0,
  • "lead_time_unit": "string",
  • "usual_order_quantity": 0,
  • "minimum_order_quantity": 0,
  • "list_price": 0,
  • "date_list_price_changed": "2019-08-24T14:15:22Z",
  • "list_price_expiry_date": "2019-08-24T14:15:22Z",
  • "default_pricing_source_type": "string",
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "order_quantity_year_to_date": 0,
  • "order_value_year_to_date": 0,
  • "last_order_date": "2019-08-24T14:15:22Z",
  • "last_order_quantity": 0,
  • "last_buying_price": 0,
  • "quantity_on_order": 0,
  • "is_preferred": true,
  • "country_of_origin_id": 0,
  • "is_to_delete": true,
  • "country_of_origin": { },
  • "product": { },
  • "supplier": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product Supplier

Product suppliers are used to record suppliers of products. The supplier details are used when creating purchase orders. A supplier can be the preferred supplier for a product. The preferred supplier details are suggested when entering a purchase order for the product.

path Parameters
Id
required
number

Unique Id of the product supplier.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "supplier_id": 0,
  • "supplier_stock_code": "string",
  • "lead_time": 0,
  • "lead_time_unit": "string",
  • "usual_order_quantity": 0,
  • "minimum_order_quantity": 0,
  • "list_price": 0,
  • "date_list_price_changed": "2019-08-24T14:15:22Z",
  • "list_price_expiry_date": "2019-08-24T14:15:22Z",
  • "default_pricing_source_type": "string",
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "order_quantity_year_to_date": 0,
  • "order_value_year_to_date": 0,
  • "last_order_date": "2019-08-24T14:15:22Z",
  • "last_order_quantity": 0,
  • "last_buying_price": 0,
  • "quantity_on_order": 0,
  • "is_preferred": true,
  • "country_of_origin_id": 0,
  • "is_to_delete": true,
  • "country_of_origin": { },
  • "product": { },
  • "supplier": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product Supplier

Product suppliers are used to record suppliers of products. The supplier details are used when creating purchase orders. A supplier can be the preferred supplier for a product. The preferred supplier details are suggested when entering a purchase order for the product.

path Parameters
Id
required
number

Unique Id of the product supplier.

Request Body schema: application/json
required

Product supplier to update in Sage 200 Stock Ledger.

supplier_id
required
integer <int64>

Supplier record Id.

supplier_stock_code
string <= 60 characters

The supplier stock code.

lead_time
integer <int16>

Lead time in lead time units for the product from the supplier.

lead_time_unit
string <= 20 characters

The lead time unit of the product.

usual_order_quantity
number <decimal 5dp>

The usual order quantity for the product from the supplier.

minimum_order_quantity
number <decimal 5dp>

The minimum order quantity for the product from the supplier.

list_price
number <decimal 5dp>

The supplier's price for the product.

list_price_expiry_date
string <date-time>

The date the list price expires.

default_pricing_source_type
string <= 20 characters

The default pricing source type of the product.

landed_costs_type
string <= 20 characters

The landed costs type of the product when ordering from the supplier.

landed_costs_percentage
number <decimal 2dp>

The percentage of the product's cost which is landed costs (if the landed costs type is Percentage Based).

landed_costs_per_item
number <decimal 2dp>

The amount of the product's cost which is landed costs (if the landed costs type is Value Based).

last_buying_price
number <decimal 5dp>

The last price paid for the product from the supplier.

is_preferred
boolean

Whether the supplier is the preferred supplier for the product.

country_of_origin_id
integer <int64>

If you produce Intrastat reports, the product country of origin record Id from the supplier.

is_to_delete
boolean

When updating an existing product, whether to delete this supplier from the collection of product suppliers.

Responses

Request samples

Content type
application/json
{
  • "supplier_id": 0,
  • "supplier_stock_code": "string",
  • "lead_time": 0,
  • "lead_time_unit": "string",
  • "usual_order_quantity": 0,
  • "minimum_order_quantity": 0,
  • "list_price": 0,
  • "list_price_expiry_date": "2019-08-24T14:15:22Z",
  • "default_pricing_source_type": "string",
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "last_buying_price": 0,
  • "is_preferred": true,
  • "country_of_origin_id": 0,
  • "is_to_delete": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "product_id": 0,
  • "supplier_id": 0,
  • "supplier_stock_code": "string",
  • "lead_time": 0,
  • "lead_time_unit": "string",
  • "usual_order_quantity": 0,
  • "minimum_order_quantity": 0,
  • "list_price": 0,
  • "date_list_price_changed": "2019-08-24T14:15:22Z",
  • "list_price_expiry_date": "2019-08-24T14:15:22Z",
  • "default_pricing_source_type": "string",
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "order_quantity_year_to_date": 0,
  • "order_value_year_to_date": 0,
  • "last_order_date": "2019-08-24T14:15:22Z",
  • "last_order_quantity": 0,
  • "last_buying_price": 0,
  • "quantity_on_order": 0,
  • "is_preferred": true,
  • "country_of_origin_id": 0,
  • "is_to_delete": true,
  • "country_of_origin": { },
  • "product": { },
  • "supplier": { },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product Supplier

Product suppliers are used to record suppliers of products. The supplier details are used when creating purchase orders. A supplier can be the preferred supplier for a product. The preferred supplier details are suggested when entering a purchase order for the product.

path Parameters
Id
required
number

Unique Id of the product supplier.

Responses

Product Transaction Group Types

Product Transaction Group Types

Product transaction group types are used to group the different (secondary) transaction types of the product within the application. Product transaction group types can be 'Allocation', 'Goods Out', 'Goods In', 'On POP Order'.

The API endpoint returns details of the product transaction group types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Transaction Types

Product Transaction Types

Product transaction types are used to identify the different types of product movement transactions. These transactions are created when products are moved in and out of stock and, can be from various sources such as purchase orders or sales orders.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Transaction Views

Product Transaction Views

A product transaction is created each time a product is moved in, or out of stock. Product transactions are created from various sources such as purchase orders, sales orders, transfers between warehouses etc.. This resource returns the details of product transactions. The default sort (orderby) field is by 'id' descending.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Types

Product Types

Product types are used to identify the different types of product that exist within the application. Products can be 'Stock', 'Miscellaneous' or 'Service/Labour'.

The API endpoint returns details of the product types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Views

Product Views

When making larger requests for product information, the Product Views resource can be a faster alternative to the 'Product' resource. The Product Views resource also returns a wider breadth of information than the Product resource. Using Product Views could therefore reduce the quantity of API requests needed to return the same information from multiple API resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Warehouse Bin Views

Warehouses And Bins For A Product View

Returns the collection of warehouses and bins for a product. This view filters out the return and direct delivery warehouses. The default sort (orderby) field are by 'warehouse_name' and 'bin_holding_name' ascending.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Warehouse Views

Warehouses For A Product View

Returns the collection of warehouses for a product. This view filters out the return and direct delivery warehouses. The default sort (orderby) field is by 'warehouse_name' ascending.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products

Products

Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.

Each stock item has default settings that are used each time the item is bought or sold. Some of these are inherited from the product group and some are set on each item.

If stock setting UseMultipleLocations is true, you must specify warehouse holding(s) when creating products.

If stock setting UseMultipleLocations is false, then new product will be automatically linked to the default (home) warehouse.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products

Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.

Each stock item has default settings that are used each time the item is bought or sold. Some of these are inherited from the product group and some are set on each item.

Request Body schema: application/json
required

Product to add.

code
required
string <= 30 characters

Product code.

name
required
string <= 60 characters

Product name.

product_group_id
required
integer <int64>

Product group record Id.

description
string <= 1000 characters

Product description.

use_description_on_documents
boolean

Whether to use the product description on order and invoice documents.

barcode
string <= 60 characters

Product bar code.

allow_sales_order
boolean
Default: "true"

Indicates whether the product is allowed on sales orders and invoicing.

tax_code_id
integer <int64>

Tax code record Id.

product_status_type
string <= 20 characters

The product status type.

fulfilment_method_type
string <= 50 characters

The fulfilment method type of the product.

fulfilment_sequence_type
string <= 50 characters

The fulfilment sequence type of the product.

inactivation_date
string <date-time>

If the product was made inactive, the date on which the product was made inactive.

manufacturer
string <= 40 characters

The product manufacturer.

part_number
string <= 60 characters

The product part number.

label_printing_option_type
string <= 60 characters

The label printing option type. (Sage 200 Professional only).

traceable_type
string <= 50 characters

The traceable type of the product. (Sage 200 Professional only).

sale_from_single_batch
boolean

Indicates whether the product is sold from a single batch. (Sage 200 Professional only).

allow_duplicate_numbers
boolean

Indicates whether the product allows duplicate numbers. (Sage 200 Professional only).

uses_alternative_ref
boolean

Indicates whether the product uses alternative references. (Sage 200 Professional only).

uses_sell_by_date
boolean

Indicates whether the product uses sell by dates. (Sage 200 Professional only).

uses_use_by_date
boolean

Indicates whether the product uses use by dates. (Sage 200 Professional only).

shelf_life
integer <int32>

The shelf life of the product. (Sage 200 Professional only).

shelf_life_type
string <= 50 characters

The shelf life type of the product. (Sage 200 Professional only).

record_nos_on_goods_received
boolean

Indicates whether the product is assigned batch/serial numbers when received. (Sage 200 Professional only).

include_nos_on_count_sheets
boolean

Indicates whether the products batch/serial numbers are displayed on stocktake sheets. (Sage 200 Professional only).

auto_generate_option_type
string <= 50 characters

The auto generate option of the product. (Sage 200 Professional only).

auto_generate_separator_id
integer <int64>

Auto generate separator record id. (Sage 200 Professional only).

auto_generate_prefix
string <= 20 characters

Products auto generated prefix. (Sage 200 Professional only).

auto_generate_next_number
integer <int64>

Products next auto generated number. (Sage 200 Professional only).

auto_generate_padding
integer <int32>

Products auto generated padding. (Sage 200 Professional only).

stocktake_cycle_period
integer <int16>

The period of time in days between each stocktake of the product.

standard_cost
number <decimal 5dp>

The standard cost of the product, if the product group uses the Standard costing method.

average_buying_price
number <decimal 5dp>

The average buying price of the product, if the product group uses either the FIFO or Average costing method.

default_picking_list_comment
string <= 160 characters

The default comment to print on picking lists for the product.

default_despatch_note_comment
string <= 160 characters

The default comment to print on despatch notes for the product.

commodity_code
string <= 10 characters

The product commodity code as defined by HM Revenue and Customs, or Irish Revenue Commissioners, as applicable.

country_of_origin_id
integer <int64>

The product country of origin. Country code record Id.

weight
number <decimal 4dp>

The product weight per stock unit, in kilograms.

suppress_mass_on_declaration
boolean

Whether to suppress the net weight on Intrastat declaration.

is_weee_item
boolean

Whether the product is subject to Waste Electrical and Electronic Equipment directives.

use_supplementary_units
boolean

Whether the product uses supplementary units.

supplementary_unit_conversion_ratio
number <decimal 9dp>

The ratio to convert to supplementary unit.

use_reverse_charge_vat_rules
boolean

Whether the product is subject to domestic reverse charge VAT rules.

landed_costs_type
string <= 20 characters

The landed costs type of the product.

landed_costs_percentage
number <decimal 2dp>

The percentage of the product's cost which is landed costs (if the landed costs type is Percentage Based).

landed_costs_per_item
number <decimal 2dp>

The amount of the product's cost which is landed costs (if the landed costs type is Value Based).

bom_item_type
string <= 30 characters

The BOM item type of the product.

stock_nominal_code_id
integer <int64>

Stock nominal code record Id. Use custom expand 'nominal_codes' to include in the response.

revenue_nominal_code_id
integer <int64>

Revenue nominal code record Id. Use custom expand 'nominal_codes' to include in the response.

accrual_nominal_code_id
integer <int64>

Accrual nominal code record Id. (Sage 200 Professional only). Use custom expand 'nominal_codes' to include in the response.

issue_nominal_code_id
integer <int64>

Issue nominal code record Id. (Sage 200 Professional only). Use custom expand 'nominal_codes' to include in the response.

base_unit_id
integer <int64>

Base unit record Id. Use custom expand 'units' or 'base_unit' to include in the response.

stock_unit_id
integer <int64>

Stock unit record Id. Use custom expand 'units' or 'stock_unit' to include in the response.

analysis_code_1
string <= 60 characters

Analysis Code 1.

analysis_code_2
string <= 60 characters

Analysis Code 2.

analysis_code_3
string <= 60 characters

Analysis Code 3.

analysis_code_4
string <= 60 characters

Analysis Code 4.

analysis_code_5
string <= 60 characters

Analysis Code 5.

analysis_code_6
string <= 60 characters

Analysis Code 6.

analysis_code_7
string <= 60 characters

Analysis Code 7.

analysis_code_8
string <= 60 characters

Analysis Code 8.

analysis_code_9
string <= 60 characters

Analysis Code 9.

analysis_code_10
string <= 60 characters

Analysis Code 10.

analysis_code_11
string <= 60 characters

Analysis Code 11.

analysis_code_12
string <= 60 characters

Analysis Code 12.

analysis_code_13
string <= 60 characters

Analysis Code 13.

analysis_code_14
string <= 60 characters

Analysis Code 14.

analysis_code_15
string <= 60 characters

Analysis Code 15.

analysis_code_16
string <= 60 characters

Analysis Code 16.

analysis_code_17
string <= 60 characters

Analysis Code 17.

analysis_code_18
string <= 60 characters

Analysis Code 18.

analysis_code_19
string <= 60 characters

Analysis Code 19.

analysis_code_20
string <= 60 characters

Analysis Code 20.

object (bom_settings)

A group of BOM related settings for a product.

Array of objects (alternative_product)

Alternative products are suitable products that can be offered when a requested product is unavailable. An alternative product can be the preferred alternative for a product. When stock is issued for a sales order, if the product is unavailable, the preferred alternative can be chosen, if stock is available.

Array of objects (cross_sell_product)

Cross sell products are complimentary products which are often sold together with another product. For example, if you sell a printer, you might want to show print cartridges or cables for that printer. Cross sell products can help speed up entering a full sales order.

Array of objects (product_memo)

Memos are sections of text that can be used to make comments about a product.

Multiple memos can be added to each product. The user that created the memo, the date it was created and last updated date and time are also recorded.

A user can also specify if a memo is currently 'Active' or 'Inactive'. This allows a user to keep a record of previous memos without deleting them.

Array of objects (product_search_category_value)

Search categories are used to help you search for stock items without knowing the item's stock code.

A search category consists of:

  • A category. This is the type such as colour, size or voltage.
  • A value. This is the specifics of the category such as green, red and blue for the category colour.
Search categories are inherited from the product group.

Array of objects (product_supplier)

Product suppliers are used to record suppliers of products. The supplier details are used when creating purchase orders. A supplier can be the preferred supplier for a product. The preferred supplier details are suggested when entering a purchase order for the product.

Array of objects (product_unit)

The products units of measure.

Array of objects (warehouse_holding)

If stock setting UseMultipleLocations is true, you must specify warehouse holding(s) when creating products.

If stock setting UseMultipleLocations is false, then new product will be automatically linked to the default (home) warehouse.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "use_description_on_documents": true,
  • "barcode": "string",
  • "allow_sales_order": "true",
  • "product_group_id": 0,
  • "tax_code_id": 0,
  • "product_status_type": "string",
  • "fulfilment_method_type": "string",
  • "fulfilment_sequence_type": "string",
  • "inactivation_date": "2019-08-24T14:15:22Z",
  • "manufacturer": "string",
  • "part_number": "string",
  • "label_printing_option_type": "string",
  • "traceable_type": "string",
  • "sale_from_single_batch": true,
  • "allow_duplicate_numbers": true,
  • "uses_alternative_ref": true,
  • "uses_sell_by_date": true,
  • "uses_use_by_date": true,
  • "shelf_life": 0,
  • "shelf_life_type": "string",
  • "record_nos_on_goods_received": true,
  • "include_nos_on_count_sheets": true,
  • "auto_generate_option_type": "string",
  • "auto_generate_separator_id": 0,
  • "auto_generate_prefix": "string",
  • "auto_generate_next_number": 0,
  • "auto_generate_padding": 0,
  • "stocktake_cycle_period": 0,
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "default_picking_list_comment": "string",
  • "default_despatch_note_comment": "string",
  • "commodity_code": "string",
  • "country_of_origin_id": 0,
  • "weight": 0,
  • "suppress_mass_on_declaration": true,
  • "is_weee_item": true,
  • "use_supplementary_units": true,
  • "supplementary_unit_conversion_ratio": 0,
  • "use_reverse_charge_vat_rules": true,
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "bom_item_type": "string",
  • "stock_nominal_code_id": 0,
  • "revenue_nominal_code_id": 0,
  • "accrual_nominal_code_id": 0,
  • "issue_nominal_code_id": 0,
  • "base_unit_id": 0,
  • "stock_unit_id": 0,
  • "analysis_code_1": "string",
  • "analysis_code_2": "string",
  • "analysis_code_3": "string",
  • "analysis_code_4": "string",
  • "analysis_code_5": "string",
  • "analysis_code_6": "string",
  • "analysis_code_7": "string",
  • "analysis_code_8": "string",
  • "analysis_code_9": "string",
  • "analysis_code_10": "string",
  • "analysis_code_11": "string",
  • "analysis_code_12": "string",
  • "analysis_code_13": "string",
  • "analysis_code_14": "string",
  • "analysis_code_15": "string",
  • "analysis_code_16": "string",
  • "analysis_code_17": "string",
  • "analysis_code_18": "string",
  • "analysis_code_19": "string",
  • "analysis_code_20": "string",
  • "bom_settings": {
    },
  • "alternative_products": [
    ],
  • "cross_sell_products": [
    ],
  • "memos": [
    ],
  • "search_category_values": [
    ],
  • "suppliers": [
    ],
  • "units": [
    ],
  • "warehouse_holdings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "use_description_on_documents": true,
  • "barcode": "string",
  • "allow_sales_order": "true",
  • "free_stock_quantity": 0,
  • "product_group_id": 0,
  • "tax_code_id": 0,
  • "product_status_type": "string",
  • "fulfilment_method_type": "string",
  • "fulfilment_sequence_type": "string",
  • "inactivation_date": "2019-08-24T14:15:22Z",
  • "manufacturer": "string",
  • "part_number": "string",
  • "label_printing_option_type": "string",
  • "traceable_type": "string",
  • "sale_from_single_batch": true,
  • "allow_duplicate_numbers": true,
  • "uses_alternative_ref": true,
  • "uses_sell_by_date": true,
  • "uses_use_by_date": true,
  • "shelf_life": 0,
  • "shelf_life_type": "string",
  • "record_nos_on_goods_received": true,
  • "include_nos_on_count_sheets": true,
  • "auto_generate_option_type": "string",
  • "auto_generate_separator_id": 0,
  • "auto_generate_prefix": "string",
  • "auto_generate_next_number": 0,
  • "auto_generate_padding": 0,
  • "stocktake_cycle_period": 0,
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "default_picking_list_comment": "string",
  • "default_despatch_note_comment": "string",
  • "commodity_code": "string",
  • "country_of_origin_id": 0,
  • "weight": 0,
  • "suppress_mass_on_declaration": true,
  • "is_weee_item": true,
  • "use_supplementary_units": true,
  • "supplementary_unit_conversion_ratio": 0,
  • "use_reverse_charge_vat_rules": true,
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "bom_item_type": "string",
  • "stock_nominal_code_id": 0,
  • "revenue_nominal_code_id": 0,
  • "accrual_nominal_code_id": 0,
  • "issue_nominal_code_id": 0,
  • "base_unit_id": 0,
  • "stock_unit_id": 0,
  • "has_alternative_products": true,
  • "has_cross_sell_products": true,
  • "has_preferred_supplier": true,
  • "analysis_code_1": "string",
  • "analysis_code_2": "string",
  • "analysis_code_3": "string",
  • "analysis_code_4": "string",
  • "analysis_code_5": "string",
  • "analysis_code_6": "string",
  • "analysis_code_7": "string",
  • "analysis_code_8": "string",
  • "analysis_code_9": "string",
  • "analysis_code_10": "string",
  • "analysis_code_11": "string",
  • "analysis_code_12": "string",
  • "analysis_code_13": "string",
  • "analysis_code_14": "string",
  • "analysis_code_15": "string",
  • "analysis_code_16": "string",
  • "analysis_code_17": "string",
  • "analysis_code_18": "string",
  • "analysis_code_19": "string",
  • "analysis_code_20": "string",
  • "accrual_nominal_code": { },
  • "auto_generate_separator": { },
  • "base_unit": { },
  • "bom_settings": {
    },
  • "country_of_origin": { },
  • "holding": {
    },
  • "issue_nominal_code": { },
  • "product_group": { },
  • "revenue_nominal_code": { },
  • "status": {
    },
  • "stock_nominal_code": { },
  • "stock_unit": { },
  • "tax_code": { },
  • "alternative_products": [
    ],
  • "cross_sell_products": [
    ],
  • "memos": [
    ],
  • "search_category_values": [
    ],
  • "suppliers": [
    ],
  • "units": [
    ],
  • "warehouse_holdings": [
    ],
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product

Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.

Each stock item has default settings that are used each time the item is bought or sold. Some of these are inherited from the product group and some are set on each item.

path Parameters
Id
required
number

Unique Id of the product.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "use_description_on_documents": true,
  • "barcode": "string",
  • "allow_sales_order": "true",
  • "free_stock_quantity": 0,
  • "product_group_id": 0,
  • "tax_code_id": 0,
  • "product_status_type": "string",
  • "fulfilment_method_type": "string",
  • "fulfilment_sequence_type": "string",
  • "inactivation_date": "2019-08-24T14:15:22Z",
  • "manufacturer": "string",
  • "part_number": "string",
  • "label_printing_option_type": "string",
  • "traceable_type": "string",
  • "sale_from_single_batch": true,
  • "allow_duplicate_numbers": true,
  • "uses_alternative_ref": true,
  • "uses_sell_by_date": true,
  • "uses_use_by_date": true,
  • "shelf_life": 0,
  • "shelf_life_type": "string",
  • "record_nos_on_goods_received": true,
  • "include_nos_on_count_sheets": true,
  • "auto_generate_option_type": "string",
  • "auto_generate_separator_id": 0,
  • "auto_generate_prefix": "string",
  • "auto_generate_next_number": 0,
  • "auto_generate_padding": 0,
  • "stocktake_cycle_period": 0,
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "default_picking_list_comment": "string",
  • "default_despatch_note_comment": "string",
  • "commodity_code": "string",
  • "country_of_origin_id": 0,
  • "weight": 0,
  • "suppress_mass_on_declaration": true,
  • "is_weee_item": true,
  • "use_supplementary_units": true,
  • "supplementary_unit_conversion_ratio": 0,
  • "use_reverse_charge_vat_rules": true,
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "bom_item_type": "string",
  • "stock_nominal_code_id": 0,
  • "revenue_nominal_code_id": 0,
  • "accrual_nominal_code_id": 0,
  • "issue_nominal_code_id": 0,
  • "base_unit_id": 0,
  • "stock_unit_id": 0,
  • "has_alternative_products": true,
  • "has_cross_sell_products": true,
  • "has_preferred_supplier": true,
  • "analysis_code_1": "string",
  • "analysis_code_2": "string",
  • "analysis_code_3": "string",
  • "analysis_code_4": "string",
  • "analysis_code_5": "string",
  • "analysis_code_6": "string",
  • "analysis_code_7": "string",
  • "analysis_code_8": "string",
  • "analysis_code_9": "string",
  • "analysis_code_10": "string",
  • "analysis_code_11": "string",
  • "analysis_code_12": "string",
  • "analysis_code_13": "string",
  • "analysis_code_14": "string",
  • "analysis_code_15": "string",
  • "analysis_code_16": "string",
  • "analysis_code_17": "string",
  • "analysis_code_18": "string",
  • "analysis_code_19": "string",
  • "analysis_code_20": "string",
  • "accrual_nominal_code": { },
  • "auto_generate_separator": { },
  • "base_unit": { },
  • "bom_settings": {
    },
  • "country_of_origin": { },
  • "holding": {
    },
  • "issue_nominal_code": { },
  • "product_group": { },
  • "revenue_nominal_code": { },
  • "status": {
    },
  • "stock_nominal_code": { },
  • "stock_unit": { },
  • "tax_code": { },
  • "alternative_products": [
    ],
  • "cross_sell_products": [
    ],
  • "memos": [
    ],
  • "search_category_values": [
    ],
  • "suppliers": [
    ],
  • "units": [
    ],
  • "warehouse_holdings": [
    ],
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product

Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.

Each stock item has default settings that are used each time the item is bought or sold. Some of these are inherited from the product group and some are set on each item.

path Parameters
Id
required
number

Unique Id of the product.

Request Body schema: application/json
required

Product to update in Sage 200 Stock Ledger.

code
required
string <= 30 characters

Product code.

name
required
string <= 60 characters

Product name.

product_group_id
required
integer <int64>

Product group record Id.

description
string <= 1000 characters

Product description.

use_description_on_documents
boolean

Whether to use the product description on order and invoice documents.

barcode
string <= 60 characters

Product bar code.

allow_sales_order
boolean
Default: "true"

Indicates whether the product is allowed on sales orders and invoicing.

tax_code_id
integer <int64>

Tax code record Id.

product_status_type
string <= 20 characters

The product status type.

fulfilment_method_type
string <= 50 characters

The fulfilment method type of the product.

fulfilment_sequence_type
string <= 50 characters

The fulfilment sequence type of the product.

inactivation_date
string <date-time>

If the product was made inactive, the date on which the product was made inactive.

manufacturer
string <= 40 characters

The product manufacturer.

part_number
string <= 60 characters

The product part number.

label_printing_option_type
string <= 60 characters

The label printing option type. (Sage 200 Professional only).

traceable_type
string <= 50 characters

The traceable type of the product. (Sage 200 Professional only).

sale_from_single_batch
boolean

Indicates whether the product is sold from a single batch. (Sage 200 Professional only).

allow_duplicate_numbers
boolean

Indicates whether the product allows duplicate numbers. (Sage 200 Professional only).

uses_alternative_ref
boolean

Indicates whether the product uses alternative references. (Sage 200 Professional only).

uses_sell_by_date
boolean

Indicates whether the product uses sell by dates. (Sage 200 Professional only).

uses_use_by_date
boolean

Indicates whether the product uses use by dates. (Sage 200 Professional only).

shelf_life
integer <int32>

The shelf life of the product. (Sage 200 Professional only).

shelf_life_type
string <= 50 characters

The shelf life type of the product. (Sage 200 Professional only).

record_nos_on_goods_received
boolean

Indicates whether the product is assigned batch/serial numbers when received. (Sage 200 Professional only).

include_nos_on_count_sheets
boolean

Indicates whether the products batch/serial numbers are displayed on stocktake sheets. (Sage 200 Professional only).

auto_generate_option_type
string <= 50 characters

The auto generate option of the product. (Sage 200 Professional only).

auto_generate_separator_id
integer <int64>

Auto generate separator record id. (Sage 200 Professional only).

auto_generate_prefix
string <= 20 characters

Products auto generated prefix. (Sage 200 Professional only).

auto_generate_next_number
integer <int64>

Products next auto generated number. (Sage 200 Professional only).

auto_generate_padding
integer <int32>

Products auto generated padding. (Sage 200 Professional only).

stocktake_cycle_period
integer <int16>

The period of time in days between each stocktake of the product.

standard_cost
number <decimal 5dp>

The standard cost of the product, if the product group uses the Standard costing method.

average_buying_price
number <decimal 5dp>

The average buying price of the product, if the product group uses either the FIFO or Average costing method.

default_picking_list_comment
string <= 160 characters

The default comment to print on picking lists for the product.

default_despatch_note_comment
string <= 160 characters

The default comment to print on despatch notes for the product.

commodity_code
string <= 10 characters

The product commodity code as defined by HM Revenue and Customs, or Irish Revenue Commissioners, as applicable.

country_of_origin_id
integer <int64>

The product country of origin. Country code record Id.

weight
number <decimal 4dp>

The product weight per stock unit, in kilograms.

suppress_mass_on_declaration
boolean

Whether to suppress the net weight on Intrastat declaration.

is_weee_item
boolean

Whether the product is subject to Waste Electrical and Electronic Equipment directives.

use_supplementary_units
boolean

Whether the product uses supplementary units.

supplementary_unit_conversion_ratio
number <decimal 9dp>

The ratio to convert to supplementary unit.

use_reverse_charge_vat_rules
boolean

Whether the product is subject to domestic reverse charge VAT rules.

landed_costs_type
string <= 20 characters

The landed costs type of the product.

landed_costs_percentage
number <decimal 2dp>

The percentage of the product's cost which is landed costs (if the landed costs type is Percentage Based).

landed_costs_per_item
number <decimal 2dp>

The amount of the product's cost which is landed costs (if the landed costs type is Value Based).

bom_item_type
string <= 30 characters

The BOM item type of the product.

stock_nominal_code_id
integer <int64>

Stock nominal code record Id. Use custom expand 'nominal_codes' to include in the response.

revenue_nominal_code_id
integer <int64>

Revenue nominal code record Id. Use custom expand 'nominal_codes' to include in the response.

accrual_nominal_code_id
integer <int64>

Accrual nominal code record Id. (Sage 200 Professional only). Use custom expand 'nominal_codes' to include in the response.

issue_nominal_code_id
integer <int64>

Issue nominal code record Id. (Sage 200 Professional only). Use custom expand 'nominal_codes' to include in the response.

base_unit_id
integer <int64>

Base unit record Id. Use custom expand 'units' or 'base_unit' to include in the response.

stock_unit_id
integer <int64>

Stock unit record Id. Use custom expand 'units' or 'stock_unit' to include in the response.

analysis_code_1
string <= 60 characters

Analysis Code 1.

analysis_code_2
string <= 60 characters

Analysis Code 2.

analysis_code_3
string <= 60 characters

Analysis Code 3.

analysis_code_4
string <= 60 characters

Analysis Code 4.

analysis_code_5
string <= 60 characters

Analysis Code 5.

analysis_code_6
string <= 60 characters

Analysis Code 6.

analysis_code_7
string <= 60 characters

Analysis Code 7.

analysis_code_8
string <= 60 characters

Analysis Code 8.

analysis_code_9
string <= 60 characters

Analysis Code 9.

analysis_code_10
string <= 60 characters

Analysis Code 10.

analysis_code_11
string <= 60 characters

Analysis Code 11.

analysis_code_12
string <= 60 characters

Analysis Code 12.

analysis_code_13
string <= 60 characters

Analysis Code 13.

analysis_code_14
string <= 60 characters

Analysis Code 14.

analysis_code_15
string <= 60 characters

Analysis Code 15.

analysis_code_16
string <= 60 characters

Analysis Code 16.

analysis_code_17
string <= 60 characters

Analysis Code 17.

analysis_code_18
string <= 60 characters

Analysis Code 18.

analysis_code_19
string <= 60 characters

Analysis Code 19.

analysis_code_20
string <= 60 characters

Analysis Code 20.

object (bom_settings)

A group of BOM related settings for a product.

Array of objects (alternative_product)

Alternative products are suitable products that can be offered when a requested product is unavailable. An alternative product can be the preferred alternative for a product. When stock is issued for a sales order, if the product is unavailable, the preferred alternative can be chosen, if stock is available.

Array of objects (cross_sell_product)

Cross sell products are complimentary products which are often sold together with another product. For example, if you sell a printer, you might want to show print cartridges or cables for that printer. Cross sell products can help speed up entering a full sales order.

Array of objects (product_memo)

Memos are sections of text that can be used to make comments about a product.

Multiple memos can be added to each product. The user that created the memo, the date it was created and last updated date and time are also recorded.

A user can also specify if a memo is currently 'Active' or 'Inactive'. This allows a user to keep a record of previous memos without deleting them.

Array of objects (product_search_category_value)

Search categories are used to help you search for stock items without knowing the item's stock code.

A search category consists of:

  • A category. This is the type such as colour, size or voltage.
  • A value. This is the specifics of the category such as green, red and blue for the category colour.
Search categories are inherited from the product group.

Array of objects (product_supplier)

Product suppliers are used to record suppliers of products. The supplier details are used when creating purchase orders. A supplier can be the preferred supplier for a product. The preferred supplier details are suggested when entering a purchase order for the product.

Array of objects (product_unit)

The products units of measure.

Array of objects (warehouse_holding)

If stock setting UseMultipleLocations is true, you must specify warehouse holding(s) when creating products.

If stock setting UseMultipleLocations is false, then new product will be automatically linked to the default (home) warehouse.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "use_description_on_documents": true,
  • "barcode": "string",
  • "allow_sales_order": "true",
  • "product_group_id": 0,
  • "tax_code_id": 0,
  • "product_status_type": "string",
  • "fulfilment_method_type": "string",
  • "fulfilment_sequence_type": "string",
  • "inactivation_date": "2019-08-24T14:15:22Z",
  • "manufacturer": "string",
  • "part_number": "string",
  • "label_printing_option_type": "string",
  • "traceable_type": "string",
  • "sale_from_single_batch": true,
  • "allow_duplicate_numbers": true,
  • "uses_alternative_ref": true,
  • "uses_sell_by_date": true,
  • "uses_use_by_date": true,
  • "shelf_life": 0,
  • "shelf_life_type": "string",
  • "record_nos_on_goods_received": true,
  • "include_nos_on_count_sheets": true,
  • "auto_generate_option_type": "string",
  • "auto_generate_separator_id": 0,
  • "auto_generate_prefix": "string",
  • "auto_generate_next_number": 0,
  • "auto_generate_padding": 0,
  • "stocktake_cycle_period": 0,
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "default_picking_list_comment": "string",
  • "default_despatch_note_comment": "string",
  • "commodity_code": "string",
  • "country_of_origin_id": 0,
  • "weight": 0,
  • "suppress_mass_on_declaration": true,
  • "is_weee_item": true,
  • "use_supplementary_units": true,
  • "supplementary_unit_conversion_ratio": 0,
  • "use_reverse_charge_vat_rules": true,
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "bom_item_type": "string",
  • "stock_nominal_code_id": 0,
  • "revenue_nominal_code_id": 0,
  • "accrual_nominal_code_id": 0,
  • "issue_nominal_code_id": 0,
  • "base_unit_id": 0,
  • "stock_unit_id": 0,
  • "analysis_code_1": "string",
  • "analysis_code_2": "string",
  • "analysis_code_3": "string",
  • "analysis_code_4": "string",
  • "analysis_code_5": "string",
  • "analysis_code_6": "string",
  • "analysis_code_7": "string",
  • "analysis_code_8": "string",
  • "analysis_code_9": "string",
  • "analysis_code_10": "string",
  • "analysis_code_11": "string",
  • "analysis_code_12": "string",
  • "analysis_code_13": "string",
  • "analysis_code_14": "string",
  • "analysis_code_15": "string",
  • "analysis_code_16": "string",
  • "analysis_code_17": "string",
  • "analysis_code_18": "string",
  • "analysis_code_19": "string",
  • "analysis_code_20": "string",
  • "bom_settings": {
    },
  • "alternative_products": [
    ],
  • "cross_sell_products": [
    ],
  • "memos": [
    ],
  • "search_category_values": [
    ],
  • "suppliers": [
    ],
  • "units": [
    ],
  • "warehouse_holdings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "use_description_on_documents": true,
  • "barcode": "string",
  • "allow_sales_order": "true",
  • "free_stock_quantity": 0,
  • "product_group_id": 0,
  • "tax_code_id": 0,
  • "product_status_type": "string",
  • "fulfilment_method_type": "string",
  • "fulfilment_sequence_type": "string",
  • "inactivation_date": "2019-08-24T14:15:22Z",
  • "manufacturer": "string",
  • "part_number": "string",
  • "label_printing_option_type": "string",
  • "traceable_type": "string",
  • "sale_from_single_batch": true,
  • "allow_duplicate_numbers": true,
  • "uses_alternative_ref": true,
  • "uses_sell_by_date": true,
  • "uses_use_by_date": true,
  • "shelf_life": 0,
  • "shelf_life_type": "string",
  • "record_nos_on_goods_received": true,
  • "include_nos_on_count_sheets": true,
  • "auto_generate_option_type": "string",
  • "auto_generate_separator_id": 0,
  • "auto_generate_prefix": "string",
  • "auto_generate_next_number": 0,
  • "auto_generate_padding": 0,
  • "stocktake_cycle_period": 0,
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "default_picking_list_comment": "string",
  • "default_despatch_note_comment": "string",
  • "commodity_code": "string",
  • "country_of_origin_id": 0,
  • "weight": 0,
  • "suppress_mass_on_declaration": true,
  • "is_weee_item": true,
  • "use_supplementary_units": true,
  • "supplementary_unit_conversion_ratio": 0,
  • "use_reverse_charge_vat_rules": true,
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "bom_item_type": "string",
  • "stock_nominal_code_id": 0,
  • "revenue_nominal_code_id": 0,
  • "accrual_nominal_code_id": 0,
  • "issue_nominal_code_id": 0,
  • "base_unit_id": 0,
  • "stock_unit_id": 0,
  • "has_alternative_products": true,
  • "has_cross_sell_products": true,
  • "has_preferred_supplier": true,
  • "analysis_code_1": "string",
  • "analysis_code_2": "string",
  • "analysis_code_3": "string",
  • "analysis_code_4": "string",
  • "analysis_code_5": "string",
  • "analysis_code_6": "string",
  • "analysis_code_7": "string",
  • "analysis_code_8": "string",
  • "analysis_code_9": "string",
  • "analysis_code_10": "string",
  • "analysis_code_11": "string",
  • "analysis_code_12": "string",
  • "analysis_code_13": "string",
  • "analysis_code_14": "string",
  • "analysis_code_15": "string",
  • "analysis_code_16": "string",
  • "analysis_code_17": "string",
  • "analysis_code_18": "string",
  • "analysis_code_19": "string",
  • "analysis_code_20": "string",
  • "accrual_nominal_code": { },
  • "auto_generate_separator": { },
  • "base_unit": { },
  • "bom_settings": {
    },
  • "country_of_origin": { },
  • "holding": {
    },
  • "issue_nominal_code": { },
  • "product_group": { },
  • "revenue_nominal_code": { },
  • "status": {
    },
  • "stock_nominal_code": { },
  • "stock_unit": { },
  • "tax_code": { },
  • "alternative_products": [
    ],
  • "cross_sell_products": [
    ],
  • "memos": [
    ],
  • "search_category_values": [
    ],
  • "suppliers": [
    ],
  • "units": [
    ],
  • "warehouse_holdings": [
    ],
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Product

Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.

Each stock item has default settings that are used each time the item is bought or sold. Some of these are inherited from the product group and some are set on each item.

path Parameters
Id
required
number

Unique Id of the product.

Responses

Products For Product Group

Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.

Each stock item has default settings that are used each time the item is bought or sold. Some of these are inherited from the product group and some are set on each item.

path Parameters
productGroupId
required
number

Unique Id of the product group.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products Duplicate

Duplicate Product

Returns a duplicate product using the product options specified.

Request Body schema: application/json
required

The options to duplicate the product.

source_id
required
integer <int64>

Product unique Id.

new_code
string <= 30 characters

Product code.

new_name
string <= 60 characters

Product name.

locations
boolean

Indicates whether to duplicate locations for the product.

location_stocking_levels
boolean

Indicates whether to duplicate warehouse stocking levels for the product.

units
boolean

Indicates whether to duplicate units of measure for the product (Sage 200 Professional only).

alternative_items
boolean

Indicates whether to duplicate alternative items for the product.

cross_selling_items
boolean

Indicates whether to duplicate cross-selling items for the product.

attachments
boolean

Indicates whether to duplicate attachments for the product.

memos
boolean

Indicates whether to duplicate memos for the product.

suppliers
boolean

Indicates whether to duplicate suppliers for the product.

Responses

Request samples

Content type
application/json
{
  • "source_id": 0,
  • "new_code": "string",
  • "new_name": "string",
  • "locations": true,
  • "location_stocking_levels": true,
  • "units": true,
  • "alternative_items": true,
  • "cross_selling_items": true,
  • "attachments": true,
  • "memos": true,
  • "suppliers": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "use_description_on_documents": true,
  • "barcode": "string",
  • "allow_sales_order": "true",
  • "free_stock_quantity": 0,
  • "product_group_id": 0,
  • "tax_code_id": 0,
  • "product_status_type": "string",
  • "fulfilment_method_type": "string",
  • "fulfilment_sequence_type": "string",
  • "inactivation_date": "2019-08-24T14:15:22Z",
  • "manufacturer": "string",
  • "part_number": "string",
  • "label_printing_option_type": "string",
  • "traceable_type": "string",
  • "sale_from_single_batch": true,
  • "allow_duplicate_numbers": true,
  • "uses_alternative_ref": true,
  • "uses_sell_by_date": true,
  • "uses_use_by_date": true,
  • "shelf_life": 0,
  • "shelf_life_type": "string",
  • "record_nos_on_goods_received": true,
  • "include_nos_on_count_sheets": true,
  • "auto_generate_option_type": "string",
  • "auto_generate_separator_id": 0,
  • "auto_generate_prefix": "string",
  • "auto_generate_next_number": 0,
  • "auto_generate_padding": 0,
  • "stocktake_cycle_period": 0,
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "default_picking_list_comment": "string",
  • "default_despatch_note_comment": "string",
  • "commodity_code": "string",
  • "country_of_origin_id": 0,
  • "weight": 0,
  • "suppress_mass_on_declaration": true,
  • "is_weee_item": true,
  • "use_supplementary_units": true,
  • "supplementary_unit_conversion_ratio": 0,
  • "use_reverse_charge_vat_rules": true,
  • "landed_costs_type": "string",
  • "landed_costs_percentage": 0,
  • "landed_costs_per_item": 0,
  • "bom_item_type": "string",
  • "stock_nominal_code_id": 0,
  • "revenue_nominal_code_id": 0,
  • "accrual_nominal_code_id": 0,
  • "issue_nominal_code_id": 0,
  • "base_unit_id": 0,
  • "stock_unit_id": 0,
  • "has_alternative_products": true,
  • "has_cross_sell_products": true,
  • "has_preferred_supplier": true,
  • "analysis_code_1": "string",
  • "analysis_code_2": "string",
  • "analysis_code_3": "string",
  • "analysis_code_4": "string",
  • "analysis_code_5": "string",
  • "analysis_code_6": "string",
  • "analysis_code_7": "string",
  • "analysis_code_8": "string",
  • "analysis_code_9": "string",
  • "analysis_code_10": "string",
  • "analysis_code_11": "string",
  • "analysis_code_12": "string",
  • "analysis_code_13": "string",
  • "analysis_code_14": "string",
  • "analysis_code_15": "string",
  • "analysis_code_16": "string",
  • "analysis_code_17": "string",
  • "analysis_code_18": "string",
  • "analysis_code_19": "string",
  • "analysis_code_20": "string",
  • "accrual_nominal_code": { },
  • "auto_generate_separator": { },
  • "base_unit": { },
  • "bom_settings": {
    },
  • "country_of_origin": { },
  • "holding": {
    },
  • "issue_nominal_code": { },
  • "product_group": { },
  • "revenue_nominal_code": { },
  • "status": {
    },
  • "stock_nominal_code": { },
  • "stock_unit": { },
  • "tax_code": { },
  • "alternative_products": [
    ],
  • "cross_sell_products": [
    ],
  • "memos": [
    ],
  • "search_category_values": [
    ],
  • "suppliers": [
    ],
  • "units": [
    ],
  • "warehouse_holdings": [
    ],
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Search Values

Search Values

This API endpoint returns a list of allowed search values.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search Values

This API endpoint returns the search value matching the specified id.

path Parameters
Id
required
number

Unique Id of the search value.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "search_category_id": 0,
  • "is_none_value": true,
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Serial Allocated To Who Types

Serial Allocated To Who Types

The serial allocated to who type, used to determine the type of allocation of a serial number.

The API endpoint returns the following values: EnumSerialAllocatedToWhoNot, EnumSerialAllocatedToWhoThis, EnumSerialAllocatedToWhoOther.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Source Area Types

Source Area Types

Source area types are used to describe the area or account type applicable to a stock transaction. Source area types can be 'EnumSourceAreaTypeSupplier', 'EnumSourceAreaTypeCustomer', 'EnumSourceAreaTypeInternal', 'EnumSourceAreaTypeWriteOff', 'EnumSourceAreaTypeOpeningBalance', 'EnumSourceAreaTypeBOM'.

The API endpoint returns details of the source area types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stock Settings

Stock Settings

The Stock Settings are used to choose how to process and manage your stock.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stock Settings

The Stock Settings are used to choose how to process and manage your stock.

path Parameters
Id
required
number

Unique Id of the stock settings.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "use_multiple_locations": false,
  • "use_search_categories": false,
  • "integrate_stock_management_with_nominal": false,
  • "generate_cos_for_sop": false,
  • "allow_negative_stocktake": false,
  • "allow_negative_stocktake_with_purchase_order": false,
  • "profit_percent_of_revenue": true,
  • "record_numbers_on_goods_received": false,
  • "allocate_individual_items": true,
  • "allow_fulfilment_from_stock": true,
  • "allow_fulfilment_from_supplier_via_stock": false,
  • "allow_fulfilment_from_supplier_direct_to_customer": false,
  • "use_landed_costs": false,
  • "landed_costs_nominal_code_id": 0,
  • "internal_areas": [
    ],
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Stock Transfer Traceable Items

Stock Transfer - Get Traceable Items

Gets the list of traceable items for a product and bin.

Request Body schema: application/json
required

Product to transfer.

product_id
required
integer <int64>

Product record Id.

bin_holding_from_id
required
integer <int64>

Bin holding record Id for the product location.

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "bin_holding_from_id": 0
}

Response samples

Content type
application/json
{
  • "product_id": 0,
  • "bin_holding_from_id": 0,
  • "bin_holding_to_id": 0,
  • "quantity": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "reference": "string",
  • "second_reference": "string",
  • "traceable_adjustment_items": [
    ]
}

Stock Transfers

Stock Transfers

A stock transfer is used to move stock from one location to another.

Request Body schema: application/json
required

Product to transfer.

product_id
required
integer <int64>

Product record Id.

bin_holding_from_id
required
integer <int64>

Bin holding record Id for the source location.

bin_holding_to_id
required
integer <int64>

Bin holding record Id for the destination location.

quantity
required
number <decimal 5dp>

The quantity to transfer.

date
string <date-time>

The date of the transfer.

reference
string <= 20 characters

The transfer reference.

second_reference
string <= 20 characters

The transfer second reference.

Array of objects

Traceable adjustment items. (Sage 200 Professional only).

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "bin_holding_from_id": 0,
  • "bin_holding_to_id": 0,
  • "quantity": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "reference": "string",
  • "second_reference": "string",
  • "traceable_adjustment_items": [
    ]
}

Response samples

Content type
application/json
{ }

Stocktake Approve Complete

Stocktake Approve And Complete

Returns stocktake count sheet items for the approve and complete of a stocktake.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "stocktake_status": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "stock_variance_nominal_code": { },
  • "nominal_narrative": "string",
  • "can_modify_stocktake_type": false,
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "failed_stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Stocktake Count Sheet Items

Stocktake Count Sheet Items

Stocktake count sheet items for the stocktake.

path Parameters
Id
required
number

Unique Id of the stocktake count sheet item.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_id": 0,
  • "bin_item_id": 0,
  • "bin_name": "string",
  • "item_code": "string",
  • "item_name": "string",
  • "stock_unit_name": "string",
  • "include_nos_on_count_sheets": true,
  • "traceable_type": "string",
  • "costing_method_type": "string",
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "recorded_quantity_in_stock": 0,
  • "has_negative_quantity_in_stock": true,
  • "quantity_on_pop_order": 0,
  • "quantity_allocated": 0,
  • "actual_quantity_entered": true,
  • "actual_quantity_in_stock": 0,
  • "discrepancy_status": "string",
  • "discrepancy_narrative": "string",
  • "allows_negative_stock": true,
  • "stocktake_trace_count_sheet_items": [
    ]
}

Stocktake Count Sheet Items

Stocktake count sheet items for the stocktake.

path Parameters
Id
required
number

Unique Id of the stocktake count sheet item.

Request Body schema: application/json
required

Stocktake count sheet item to update.

actual_quantity_entered
boolean

Indicates whether actual stock quantity has been entered.

actual_quantity_in_stock
number <decimal 5dp>

The actual stock quantity.

discrepancy_narrative
string <= 6000 characters

Discrepancy narrative.

Responses

Request samples

Content type
application/json
{
  • "actual_quantity_entered": true,
  • "actual_quantity_in_stock": 0,
  • "discrepancy_narrative": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_id": 0,
  • "bin_item_id": 0,
  • "bin_name": "string",
  • "item_code": "string",
  • "item_name": "string",
  • "stock_unit_name": "string",
  • "include_nos_on_count_sheets": true,
  • "traceable_type": "string",
  • "costing_method_type": "string",
  • "standard_cost": 0,
  • "average_buying_price": 0,
  • "recorded_quantity_in_stock": 0,
  • "has_negative_quantity_in_stock": true,
  • "quantity_on_pop_order": 0,
  • "quantity_allocated": 0,
  • "actual_quantity_entered": true,
  • "actual_quantity_in_stock": 0,
  • "discrepancy_status": "string",
  • "discrepancy_narrative": "string",
  • "allows_negative_stock": true,
  • "stocktake_trace_count_sheet_items": [
    ]
}

Stocktake Criteria Templates

Stocktake Criteria Templates

Stocktake criteria templates are a set of criteria used for auto selection of stock items to add to a stocktake sheet.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stocktake Criteria Templates

Stocktake criteria templates are a set of criteria used for auto selection of stock items to add to a stocktake sheet.

Request Body schema: application/json
required

Stocktake criteria template to add.

name
required
string <= 50 characters

The stocktake criteria template name.

last_sold_date
string <date-time>

Include stock items by the date they were last sold.

due_date
string <date-time>

Include stock items by when they are due to have a stocktake.

stocktake_traceable_type
string <= 50 characters

Include only traceable or non-traceable stock items.

stock_value_type
string <= 50 characters

Include stock items by a selected stock value.

stock_value_number_of_items
integer <int32>
Default: 100

Number of stock items to include on the stocktake.

quantity_from
number <decimal 5dp>

Include stock items by the amount in stock.

quantity_to
number <decimal 5dp>

Include stock items by the amount in stock.

Array of objects (lookup_product_group)

Include stock items that are associated with these product groups.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "last_sold_date": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "stocktake_traceable_type": "string",
  • "stock_value_type": "string",
  • "stock_value_number_of_items": 100,
  • "quantity_from": 0,
  • "quantity_to": 0,
  • "product_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "last_sold_date": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "stocktake_traceable_type": "string",
  • "stock_value_type": "string",
  • "stock_value_number_of_items": 100,
  • "quantity_from": 0,
  • "quantity_to": 0,
  • "product_groups": [
    ]
}

Stocktake Criteria Templates

Stocktake criteria templates are a set of criteria used for auto selection of stock items to add to a stocktake sheet.

path Parameters
Id
required
number

Unique Id of the stocktake criteria template.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "last_sold_date": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "stocktake_traceable_type": "string",
  • "stock_value_type": "string",
  • "stock_value_number_of_items": 100,
  • "quantity_from": 0,
  • "quantity_to": 0,
  • "product_groups": [
    ]
}

Stocktake Criteria Templates

Stocktake criteria templates are a set of criteria used for auto selection of stock items to add to a stocktake sheet.

path Parameters
Id
required
number

Unique Id of the stocktake criteria template.

Request Body schema: application/json
required

Stocktake criteria template to update.

name
required
string <= 50 characters

The stocktake criteria template name.

last_sold_date
string <date-time>

Include stock items by the date they were last sold.

due_date
string <date-time>

Include stock items by when they are due to have a stocktake.

stocktake_traceable_type
string <= 50 characters

Include only traceable or non-traceable stock items.

stock_value_type
string <= 50 characters

Include stock items by a selected stock value.

stock_value_number_of_items
integer <int32>
Default: 100

Number of stock items to include on the stocktake.

quantity_from
number <decimal 5dp>

Include stock items by the amount in stock.

quantity_to
number <decimal 5dp>

Include stock items by the amount in stock.

Array of objects (lookup_product_group)

Include stock items that are associated with these product groups.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "last_sold_date": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "stocktake_traceable_type": "string",
  • "stock_value_type": "string",
  • "stock_value_number_of_items": 100,
  • "quantity_from": 0,
  • "quantity_to": 0,
  • "product_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "last_sold_date": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "stocktake_traceable_type": "string",
  • "stock_value_type": "string",
  • "stock_value_number_of_items": 100,
  • "quantity_from": 0,
  • "quantity_to": 0,
  • "product_groups": [
    ]
}

Stocktake Criteria Templates

Stocktake criteria templates are a set of criteria used for auto selection of stock items to add to a stocktake sheet.

path Parameters
Id
required
number

Unique Id of the stocktake criteria template.

Responses

Stocktake Enter Values

Stocktake Enter Values

Returns stocktake count sheet items to allow entry of actual quantities in stock for a stocktake.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "stocktake_status": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "stock_variance_nominal_code": { },
  • "nominal_narrative": "string",
  • "can_modify_stocktake_type": false,
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "failed_stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Stocktake Selector Value Types

Stocktake Selector Value Types

Stocktake selector value types are used to select stock items by stock value to be included on a stocktake. Stocktake selector value types can be either 'Average buying price' or 'Value of stock'.

The API endpoint returns details of the stocktake selector value types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stocktake Status Types

Stocktake Status Types

Stocktake status types describe the possible states in which a stocktake can be. Stocktake status type can be 'No stocktake', 'Selecting items', 'Sheets printed', 'Entering counts', or 'Complete'.

The API endpoint returns details of the stocktake status types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stocktake Traceable Types

Stocktake Traceable Types

Stocktake traceable types are used to select stock items by stock traceable type to be included on a stocktake. Selection can be on 'Non-Traceable', 'Serial Numbered', 'Batch Numbered' or 'Batch and Serial'.

The API endpoint returns details of the traceable types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stocktake Types

Stocktake Types

Stocktake method for selecting stocktake items. Stocktake type can be 'By Stock Item', or 'By Bin'.

The API endpoint returns details of the stocktake types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stocktake View Adjustments

Stocktake View Adjustments

Returns stocktake count sheet items on a stocktake including discrepancies.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "stocktake_status": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "stock_variance_nominal_code": { },
  • "nominal_narrative": "string",
  • "can_modify_stocktake_type": false,
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "failed_stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Stocktake Views

Stocktake Views

Gets the collection of stocktakes including warehouse name. The default sort (orderby) field is by 'stocktake_name' ascending.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stocktakes

Stocktakes

Stocktakes adjust the recorded stock levels in Sage 200 with actual stock levels in order to maintain accurate stock records. Stocktakes are recorded per warehouse. Items for a stocktake can be selected individually (by Stock Item) or by the bin they are stored in.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stocktakes

Stocktakes adjust the recorded stock levels in Sage 200 with actual stock levels in order to maintain accurate stock records. Stocktakes are recorded per warehouse. Items for a stocktake can be selected individually (by Stock Item) or by the bin they are stored in.

Request Body schema: application/json
required

Stocktake to add.

warehouse_id
required
integer <int64>

Warehouse record Id. Note: This is required for getting a list of items for a new stocktake.

stocktake_name
string <= 60 characters

Stocktake name.

stocktake_date
string <date-time>

The created or last updated date of the stocktake, or the current stocktake date if counts have been entered.

stocktake_type
string <= 50 characters

The type of counting method for the stocktake; e.g. by Stock Item, or by Bin. Note: If other stocktakes exist for the same warehouse, this value can't be changed.

exclude_inactive_stock
boolean
Default: false

Whether to exclude inactive stock items from the list of items.

show_expected_quantities
boolean
Default: false

Whether to show expected quantities when entering counts.

stock_variance_nominal_code_id
integer <int64>

Stock variance nominal record Id. Note: for setting this, the status must be at Requires Approval.

nominal_narrative
string <= 6000 characters

The nominal narrative. Note: for setting this, the status must be at Requires Approval.

advance_status
boolean
Default: false

Whether to advance to the next status.

pre_fill_actual_with_expected
boolean
Default: false

Whether to pre-fill actual count values with expected values.

Array of objects

Stocktake items. Note: this collection is only used when the status is at Selecting Items.

Array of objects (stocktake_count_sheet_item)

Stocktake count sheet items. Note: this collection is only used when the status has advanced past Selecting Items.

Responses

Request samples

Content type
application/json
{
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "nominal_narrative": "string",
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "stocktake_status": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "stock_variance_nominal_code": { },
  • "nominal_narrative": "string",
  • "can_modify_stocktake_type": false,
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "failed_stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Stocktakes

Stocktakes adjust the recorded stock levels in Sage 200 with actual stock levels in order to maintain accurate stock records. Stocktakes are recorded per warehouse. Items for a stocktake can be selected individually (by Stock Item) or by the bin they are stored in.

path Parameters
Id
required
number

Unique Id of the stocktake.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "stocktake_status": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "stock_variance_nominal_code": { },
  • "nominal_narrative": "string",
  • "can_modify_stocktake_type": false,
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "failed_stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Stocktakes

Stocktakes adjust the recorded stock levels in Sage 200 with actual stock levels in order to maintain accurate stock records. Stocktakes are recorded per warehouse. Items for a stocktake can be selected individually (by Stock Item) or by the bin they are stored in.

path Parameters
Id
required
number

Unique Id of the stocktake.

Request Body schema: application/json
required

Stocktake to update.

warehouse_id
required
integer <int64>

Warehouse record Id. Note: This is required for getting a list of items for a new stocktake.

stocktake_name
string <= 60 characters

Stocktake name.

stocktake_date
string <date-time>

The created or last updated date of the stocktake, or the current stocktake date if counts have been entered.

stocktake_type
string <= 50 characters

The type of counting method for the stocktake; e.g. by Stock Item, or by Bin. Note: If other stocktakes exist for the same warehouse, this value can't be changed.

exclude_inactive_stock
boolean
Default: false

Whether to exclude inactive stock items from the list of items.

show_expected_quantities
boolean
Default: false

Whether to show expected quantities when entering counts.

stock_variance_nominal_code_id
integer <int64>

Stock variance nominal record Id. Note: for setting this, the status must be at Requires Approval.

nominal_narrative
string <= 6000 characters

The nominal narrative. Note: for setting this, the status must be at Requires Approval.

advance_status
boolean
Default: false

Whether to advance to the next status.

pre_fill_actual_with_expected
boolean
Default: false

Whether to pre-fill actual count values with expected values.

Array of objects

Stocktake items. Note: this collection is only used when the status is at Selecting Items.

Array of objects (stocktake_count_sheet_item)

Stocktake count sheet items. Note: this collection is only used when the status has advanced past Selecting Items.

Responses

Request samples

Content type
application/json
{
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "nominal_narrative": "string",
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stocktake_name": "string",
  • "warehouse_id": 0,
  • "warehouse_name": "string",
  • "stocktake_date": "2019-08-24T14:15:22Z",
  • "stocktake_type": "string",
  • "stocktake_status": "string",
  • "exclude_inactive_stock": false,
  • "show_expected_quantities": false,
  • "stock_variance_nominal_code_id": 0,
  • "stock_variance_nominal_code": { },
  • "nominal_narrative": "string",
  • "can_modify_stocktake_type": false,
  • "advance_status": false,
  • "pre_fill_actual_with_expected": false,
  • "stocktake_items": [
    ],
  • "failed_stocktake_items": [
    ],
  • "stocktake_count_sheet_items": [
    ]
}

Stocktakes

Stocktakes adjust the recorded stock levels in Sage 200 with actual stock levels in order to maintain accurate stock records. Stocktakes are recorded per warehouse. Items for a stocktake can be selected individually (by Stock Item) or by the bin they are stored in.

path Parameters
Id
required
number

Unique Id of the stocktake.

Responses

Traceable Issue Status Types

Traceable Issue Status Types

Traceable issue status types are used to describe the issued status of traceable items. Traceable issue status types can be 'All', 'Issued Only', or 'Not Issued'.

The API endpoint returns details of the traceable issue status types.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Traceable Types

Traceable Types

Traceable types are used to identify the different traceable options of the product that exist within the application. Products can be 'Non-Traceable', 'Serial Numbered' or 'Batch Numbered'.

The API endpoint returns details of the traceable types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Unit Types

Unit Types

Unit types are used to indicate the unit of measure type within the application. The types can be 'Base', 'Stock' or 'Additional'.

The API endpoint returns details of the unit of measure types that can be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Units

Units

The units of measure in which products are stored as well as those used when buying or selling products.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Units

The units of measure in which products are stored as well as those used when buying or selling products.

path Parameters
Id
required
number

Unique Id of the unit.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "multiple_of_base_unit": 0,
  • "each_value": true,
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Warehouse Holdings

Warehouse Holdings

All stock within Sage 200 regardless of type (Stock, Service/labour, or Miscellaneous), require a holding location. The location indicates where an item is stored and the stock level settings for each product in the warehouse i.e. the re-order level, the minimum and maximum stock levels.

Items with a type of 'Stock' have levels recorded for each warehouse location and the levels are used when allocating, issuing and receiving stock.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warehouse Holdings

All stock within Sage 200 regardless of type (Stock, Service/labour, or Miscellaneous), require a holding location. The location indicates where an item is stored and the stock level settings for each product in the warehouse i.e. the re-order level, the minimum and maximum stock levels.

Items with a type of 'Stock' have levels recorded for each warehouse location and the levels are used when allocating, issuing and receiving stock.

Request Body schema: application/json
required

WarehouseHolding to add.

product_id
required
integer <int64>

Product record Id.

warehouse_id
required
integer <int64>

Warehouse record Id.

is_default_manufacturing_warehouse
boolean

True if the item is a built or built/bought item and that warehouse is marked as the default manufacturing warehouse; otherwise false.

reorder_level
number <decimal 5dp>

Reorder stock level.

minimum_level
number <decimal 5dp>

Minimum stock quantity level.

maximum_level
number <decimal 5dp>

Maximum stock quantity level.

is_to_delete
boolean

When updating an existing product, whether to delete this warehouse holding from the collection of product warehouse holdings.

product
object

Product.

warehouse
object

Warehouse.

Array of objects (bin_holding)

The stock holding details for each bin in the warehouse.

Responses

Request samples

Content type
application/json
{
  • "warehouse_id": 0,
  • "product_id": 0,
  • "is_default_manufacturing_warehouse": true,
  • "reorder_level": 0,
  • "minimum_level": 0,
  • "maximum_level": 0,
  • "is_to_delete": true,
  • "product": { },
  • "warehouse": { },
  • "bin_holdings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "warehouse_id": 0,
  • "product_id": 0,
  • "is_default_manufacturing_warehouse": true,
  • "reorder_level": 0,
  • "minimum_level": 0,
  • "maximum_level": 0,
  • "quantity_reserved": 0,
  • "confirmed_qty_in_stock": 0,
  • "unconfirmed_qty_in_stock": 0,
  • "quantity_in_stock": 0,
  • "quantity_in_stock_less_reserved": 0,
  • "quantity_on_order": 0,
  • "quantity_allocated_stock": 0,
  • "quantity_allocated_sop": 0,
  • "quantity_allocated_bom": 0,
  • "quantity_allocated": 0,
  • "free_stock_available": 0,
  • "free_stock_available_less_reserved": 0,
  • "warehouse_name": "string",
  • "is_to_delete": true,
  • "product": { },
  • "warehouse": { },
  • "bin_holdings": [
    ],
  • "status": {
    },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Warehouse Holding

Return a single warehouse holding resource by supplying a warehouse holding Id.

path Parameters
Id
required
number

Unique Id of the warehouse holding.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "warehouse_id": 0,
  • "product_id": 0,
  • "is_default_manufacturing_warehouse": true,
  • "reorder_level": 0,
  • "minimum_level": 0,
  • "maximum_level": 0,
  • "quantity_reserved": 0,
  • "confirmed_qty_in_stock": 0,
  • "unconfirmed_qty_in_stock": 0,
  • "quantity_in_stock": 0,
  • "quantity_in_stock_less_reserved": 0,
  • "quantity_on_order": 0,
  • "quantity_allocated_stock": 0,
  • "quantity_allocated_sop": 0,
  • "quantity_allocated_bom": 0,
  • "quantity_allocated": 0,
  • "free_stock_available": 0,
  • "free_stock_available_less_reserved": 0,
  • "warehouse_name": "string",
  • "is_to_delete": true,
  • "product": { },
  • "warehouse": { },
  • "bin_holdings": [
    ],
  • "status": {
    },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Warehouse Holding

Update a single warehouse holding resource by supplying a warehouse holding Id.

path Parameters
Id
required
number

Unique Id of the warehouse holding.

Request Body schema: application/json
required

Warehouse holding to update.

product_id
required
integer <int64>

Product record Id.

warehouse_id
required
integer <int64>

Warehouse record Id.

is_default_manufacturing_warehouse
boolean

True if the item is a built or built/bought item and that warehouse is marked as the default manufacturing warehouse; otherwise false.

reorder_level
number <decimal 5dp>

Reorder stock level.

minimum_level
number <decimal 5dp>

Minimum stock quantity level.

maximum_level
number <decimal 5dp>

Maximum stock quantity level.

is_to_delete
boolean

When updating an existing product, whether to delete this warehouse holding from the collection of product warehouse holdings.

product
object

Product.

warehouse
object

Warehouse.

Array of objects (bin_holding)

The stock holding details for each bin in the warehouse.

Responses

Request samples

Content type
application/json
{
  • "warehouse_id": 0,
  • "product_id": 0,
  • "is_default_manufacturing_warehouse": true,
  • "reorder_level": 0,
  • "minimum_level": 0,
  • "maximum_level": 0,
  • "is_to_delete": true,
  • "product": { },
  • "warehouse": { },
  • "bin_holdings": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "warehouse_id": 0,
  • "product_id": 0,
  • "is_default_manufacturing_warehouse": true,
  • "reorder_level": 0,
  • "minimum_level": 0,
  • "maximum_level": 0,
  • "quantity_reserved": 0,
  • "confirmed_qty_in_stock": 0,
  • "unconfirmed_qty_in_stock": 0,
  • "quantity_in_stock": 0,
  • "quantity_in_stock_less_reserved": 0,
  • "quantity_on_order": 0,
  • "quantity_allocated_stock": 0,
  • "quantity_allocated_sop": 0,
  • "quantity_allocated_bom": 0,
  • "quantity_allocated": 0,
  • "free_stock_available": 0,
  • "free_stock_available_less_reserved": 0,
  • "warehouse_name": "string",
  • "is_to_delete": true,
  • "product": { },
  • "warehouse": { },
  • "bin_holdings": [
    ],
  • "status": {
    },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Warehouse Holding

Delete a single warehouse holding resource by supplying a warehouse holding Id.

path Parameters
Id
required
number

Unique Id of the warehouse holding.

Responses

Warehouse Holdings For Warehouse

Returns collection of warehouse holdings for warehouse.

path Parameters
warehouseId
required
number

Unique Id of the warehouse.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warehouse Holdings For Product

Returns collection of warehouse holdings for product.

path Parameters
productId
required
number

Unique Id of the product.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warehouse Holdings For Warehouse And Product

Returns collection of warehouse holdings for a warehouse and product.

path Parameters
productId
required
number

Unique Id of the product.

warehouseId
required
number

Unique Id of the warehouse.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warehouse Holdings For Product And Warehouse

Returns collection of warehouse holdings for a product and warehouse.

path Parameters
productId
required
number

Unique Id of the product.

warehouseId
required
number

Unique Id of the warehouse.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warehouse Types

Warehouse Types

The warehouse type.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warehouses

Warehouses

All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warehouses

All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses.

Request Body schema: application/json
required

Warehouse to add.

name
required
string <= 20 characters

Warehouse name.

description
string <= 50 characters

Warehouse description.

warehouse_type
string <= 50 characters

The warehouse type.

use_for_sales_trading
boolean
Default: true

Indicates that the warehouse is used for sales trading (Sage 200 Professional only).

postal_name
string <= 60 characters

Warehouse postal name.

address_1
string <= 60 characters

Warehouse address line 1.

address_2
string <= 60 characters

Warehouse address line 2.

address_3
string <= 60 characters

Warehouse address line 3.

address_4
string <= 60 characters

Warehouse address line 4.

city
string <= 60 characters

Warehouse city.

county
string <= 60 characters

Warehouse county.

postcode
string <= 10 characters

Warehouse post code.

country
string <= 60 characters

Warehouse country.

contact
string <= 50 characters

Warehouse contact.

telephone_number
string <= 30 characters

Warehouse telephone number.

fax_number
string <= 30 characters

Warehouse fax number.

email
string <= 255 characters

Warehouse email address.

website
string <= 200 characters

Warehouse web address.

country_code_id
integer <int64>

Warehouse country code id.

object (warehouse_bom_settings)

The BOM related settings for the warehouse

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "warehouse_type": "string",
  • "use_for_sales_trading": true,
  • "postal_name": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "address_4": "string",
  • "city": "string",
  • "county": "string",
  • "postcode": "string",
  • "country": "string",
  • "contact": "string",
  • "telephone_number": "string",
  • "fax_number": "string",
  • "email": "string",
  • "website": "string",
  • "country_code_id": 0,
  • "bom_settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "warehouse_type": "string",
  • "use_for_sales_trading": true,
  • "postal_name": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "address_4": "string",
  • "city": "string",
  • "county": "string",
  • "postcode": "string",
  • "country": "string",
  • "contact": "string",
  • "telephone_number": "string",
  • "fax_number": "string",
  • "email": "string",
  • "website": "string",
  • "country_code_id": 0,
  • "country_code": { },
  • "bom_settings": {
    },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Warehouse

Return a single warehouse resource by supplying a warehouse Id.

path Parameters
Id
required
number

Unique Id of the warehouse.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "warehouse_type": "string",
  • "use_for_sales_trading": true,
  • "postal_name": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "address_4": "string",
  • "city": "string",
  • "county": "string",
  • "postcode": "string",
  • "country": "string",
  • "contact": "string",
  • "telephone_number": "string",
  • "fax_number": "string",
  • "email": "string",
  • "website": "string",
  • "country_code_id": 0,
  • "country_code": { },
  • "bom_settings": {
    },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Warehouse

All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses.

path Parameters
Id
required
number

Unique Id of the warehouse.

Request Body schema: application/json
required

Warehouse to update.

name
required
string <= 20 characters

Warehouse name.

description
string <= 50 characters

Warehouse description.

warehouse_type
string <= 50 characters

The warehouse type.

use_for_sales_trading
boolean
Default: true

Indicates that the warehouse is used for sales trading (Sage 200 Professional only).

postal_name
string <= 60 characters

Warehouse postal name.

address_1
string <= 60 characters

Warehouse address line 1.

address_2
string <= 60 characters

Warehouse address line 2.

address_3
string <= 60 characters

Warehouse address line 3.

address_4
string <= 60 characters

Warehouse address line 4.

city
string <= 60 characters

Warehouse city.

county
string <= 60 characters

Warehouse county.

postcode
string <= 10 characters

Warehouse post code.

country
string <= 60 characters

Warehouse country.

contact
string <= 50 characters

Warehouse contact.

telephone_number
string <= 30 characters

Warehouse telephone number.

fax_number
string <= 30 characters

Warehouse fax number.

email
string <= 255 characters

Warehouse email address.

website
string <= 200 characters

Warehouse web address.

country_code_id
integer <int64>

Warehouse country code id.

object (warehouse_bom_settings)

The BOM related settings for the warehouse

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "warehouse_type": "string",
  • "use_for_sales_trading": true,
  • "postal_name": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "address_4": "string",
  • "city": "string",
  • "county": "string",
  • "postcode": "string",
  • "country": "string",
  • "contact": "string",
  • "telephone_number": "string",
  • "fax_number": "string",
  • "email": "string",
  • "website": "string",
  • "country_code_id": 0,
  • "bom_settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "warehouse_type": "string",
  • "use_for_sales_trading": true,
  • "postal_name": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "address_4": "string",
  • "city": "string",
  • "county": "string",
  • "postcode": "string",
  • "country": "string",
  • "contact": "string",
  • "telephone_number": "string",
  • "fax_number": "string",
  • "email": "string",
  • "website": "string",
  • "country_code_id": 0,
  • "country_code": { },
  • "bom_settings": {
    },
  • "date_time_created": "2019-08-24T14:15:22Z",
  • "date_time_updated": "2019-08-24T14:15:22Z"
}

Warehouse

All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses.

path Parameters
Id
required
number

Unique Id of the warehouse.

Responses

Warehouses For A Product

Returns the collection of warehouses for a product.

path Parameters
productId
required
number

Unique Id of a product.

Responses

Response samples

Content type
application/json
[
  • {
    }
]