Skip to main content
GuidesAPI Reference

Update Item

PUT 
//accounting/items/:id/items (COPY)

Create an Accounting Item.

Request​

Path Parameters

    id stringrequired

    The ID of the item.

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    itemName string

    The unique name or label identifying the specific item.

    qtyOnHand int32

    The current quantity of the item available in stock or on-hand. Required if itemType is INVENTORY. Not allowed if itemType is SERVICE or NON_INVENTORY

    assetAccountId string

    The account ID reflecting the item's value if considered as an asset. Required if itemType is INVENTORY

    billAccountId string

    The account ID used for bills related to the item.

    itemStatus string

    The current condition or phase of the item. Possible values: ACTIVE, ARCHIVED

    unitPrice float

    The selling cost per individual unit of the item. Required if itemType is INVENTORY. Not allowed if itemType is SERVICE or NON_INVENTORY

    purchasePrice float

    The cost incurred to acquire or produce a single unit of the item.

    invoiceAccountId string

    The account ID used for invoices associated with the item.

    remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    item

    object

    remoteId string
    itemName string
    itemStatus string
    itemType string
    unitPrice
    purchasePrice
    qtyOnHand
    billAccountId string
    invoiceAccountId
    assetAccountId
    companyId
    createdTimestamp integer

    Default value: 0

    updatedTimestamp integer

    Default value: 0

    id string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...