Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
classifications

Archive an item

Archive an existing item. In the response, the archived field is set as true.

post/v3/classifications/items/{id}/archive

Path parameters

idstring required

BILL-generated ID of the item. The value begins with 0ii.

Example:{{item_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Archive an item response

idstring

BILL-generated ID of the item. The value begins with 0ii.

type'UNDEFINED' | 'UNKNOWN' | 'SERVICE' | 'INVENTORY' | 'NON_INVENTORY' | 'PAYMENT' | 'DISCOUNT' | 'SALES_TAX' | 'SUBTOTAL' | 'OTHER_CHARGE' | 'INVENTORY_ASSEMBLY' | 'GROUP' | 'SALES_TAX_GROUP' | 'FIXED_ASSET' | 'CATEGORY' | 'EXPENSE'

Item type

shortNamestring

Item short name

namestring

Item name

descriptionstring

Item description

archivedboolean

Set as true if the item is archived

parentIdstring

BILL-generated ID of the parent item. You can set this field if this item is a child object.

pricenumber

Item price

expenseChartOfAccountIdstring

BILL-generated ID of the chart of accounts for the item when it is used for bills or purchases in your accounting system. The value begins with 0ca.

purchaseDescriptionstring

Item description when it is used for bills or purchases in your accounting system

purchaseCostnumber

Item purchase cost set in your accounting system

chartOfAccountIdstring

BILL-generated ID of the chart of accounts for the item. The value begins with 0ca.

taxableboolean

Set as true if the item is taxable

percentagenumber

Item tax percentage

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time