Skip to main content
GuidesAPI Reference

List Items

GET 
/accounting/items

Returns a list of Accounting Items.

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber int32

    The page number of the results. Default is 1.

    pageSize int32

    The maximum number of results to show on a page. Default is 50. Maximum is 100.

    remoteId string

    Used to filter items with this third-party application ID.

    itemName string

    Used to filter items with the exact item name.

    itemNameContains string

    Used to filter items whose items names contain the provided value.

    itemNameNotEquals string

    Used to filter items whose item name to exclude.

    itemStatus string

    Used to filter items with the exact item status.

    itemType string

    Used to filter items with the exact item type.

    unitPrice float

    Used to filter items with the exact item unit price.

    unitPriceMin float

    Used to filter items with the minimum unit price.

    unitPriceMax float

    Used to filter items with the maximum unit price.

    unitPriceNotEquals float

    Used to filter items whose unit price to exclude.

    purchasePrice float

    Used to filter items with the exact item purchase price.

    purchasePriceMin float

    Used to filter items with the minimum purchase price.

    purchasePriceMax float

    Used to filter items with the maximum purchase price.

    purchasePriceNotEquals float

    Used to filter items whose purchase price to exclude.

    qtyOnHand int32

    Used to filter items with the exact item quantity on hand.

    qtyOnHandMin int32

    Used to filter items with the minimum quantity on hand.

    qtyOnHandMax int32

    Used to filter items with the maximum quantity on hand.

    qtyOnHandNotEquals int32

    Used to filter items whose quantity on hand to exclude.

    billAccountId string

    Used to filter items with this bill account ID.

    invoiceAccountId string

    Used to filter items with this invoice account ID.

    assetAccountId string

    Used to filter items with this asset account ID.

    companyId string

    Used to filter items with this company ID.

    remoteCreatedAtMin date

    Filter objects created in the third-party application after a specified date.

    remoteCreatedAtMax date

    Filter objects created in the third-party application before a specified date.

    remoteUpdatedAtMin date

    Filter objects last updated in the third-party application after a specified date.

    remoteUpdatedAtMax date

    Filter objects last updated in the third-party application before a specified date.

    createdAtMin date

    Filter objects created after a specified date.

    createdAtMax date

    Filter objects created before a specified date.

    updatedAtMin date

    Filter objects last updated after a specified date.

    updatedAtMax date

    Filter objects last updated before a specified date.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    items

    object[]

  • Array [

    • 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...