FIfieldpulse
Items

Create item

Changed on

Create an invoice item

post/items

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/items
  • Auth
    API key in header x-api-key

Request body

namestring required

Unique for the company.

default_taxableboolean required
default_descriptionstring
type'service' | 'product' | 'reece-item' required
skustring nullable

Unique item sku for the company.

default_unit_pricenumber
default_unit_costnumber
default_quantitynumber required
track_inventoryboolean
is_activeboolean
xero_sales_accountinteger nullable
xero_tax_accountinteger nullable
tax_ratestring
vendor_idinteger nullable

Existing vendor id.

vendor_type'integrated' | 'third_party' nullable
vendor_namestring nullable
supplier_item_idstring nullable

Required if vendor_type is integrated.

is_automatic_replenishment_by_purchase_order_enabledboolean nullable
auto_reorder_levelinteger

Required if is_automatic_replenishment_by_purchase_order_enabled is true.

replenishment_levelstring nullable

Must be greater then auto reorder level. Required if is_automatic_replenishment_by_purchase_order_enabled is true.

minimum_order_quantitynumber nullable
price_update_method'set_price_manually' | 'automatic_markup' | 'use_cmp_pricing'
automatic_markup_percentagestring nullable

Required if price_update_method is automatic_markup.

inventory_mode'default' | 'serialized_inventory'
qbo_sales_tax_code_idinteger nullable

Existing Quickbooks Tax Code Id.

qbo_purchase_tax_code_idinteger nullable

Existing Quickbooks Tax Code Id.

qbo_income_account_idinteger nullable

Existing Quickbooks Account Id.

qbo_expense_account_idinteger nullable

Existing Quickbooks Account Id.

qbo_asset_account_idinteger nullable

Existing Quickbooks Account Id.

qbo_idinteger nullable
quantity_availablenumber
unit_measurestring
external_idinteger nullable
external_typestring nullable
external_sync_statusstring nullable
upcstring nullable
unit_cost_per_unit_measurenumber
unit_price_per_unit_measurenumber
minimum_dimensional_sizenumber
maximum_dimensional_sizenumber
is_round_up_to_even_dimensional_sizeboolean
is_labor_itemboolean
tagsinteger[] nullable

Array of tag ids.

Response

Created

errorboolean

false when the request succeeds.

responseobject

The created record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the success response with the status