Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Billing

Get all products

Returns a list of products with optional filters.

The content field structure varies by quantity type and includes price, cost, taxable, and other type-specific fields:

  • MANUAL: price, cost, taxable, billing, quantity, productIds
  • DEVICE_COUNTS: price, cost, taxable, billing, anyRole, groupIds, allGroups, nodeRoles, productIds
  • END_USER_COUNTS: price, cost, taxable, billing, anyRole, endUserRoles, matchAllRoles, productIds
  • BACKUP_STORAGE_COUNTS: price, cost, taxable, billing, anyRole, groupIds, allGroups, nodeRoles, isStorageIncludedPerDevice, includedStorage, productIds
  • TIME_ENTRIES: price, cost, taxable, billing, autoRoundTimeEntries, laborCodes, userRoles, onSiteMultiplier, offHoursMultiplier, remoteMultiplier, normalHoursMultiplier, scheduleTypeOffHours, scheduleTypeNormalHours, locationTypeOnSite, locationTypeRemote, includeTime, includedTimeAmountUnlimited, includedHours, unusedCarryOverUnlimited, carryOverLimit, balance, productIds
get/v2/billing/products

Query parameters

namestring

Filter products by name (case-insensitive partial match)

quantityTypestring

Filter products by quantity type

accountCodestring

Filter products by account code

Response

List of products successfully retrieved

idinteger

Unique identifier of the product.

namestring

Name of the product.

descriptionstring

Description of the product.

quantityType'MANUAL' | 'DEVICE_COUNTS' | 'TIME_ENTRIES' | 'END_USER_COUNTS' | 'BACKUP_STORAGE_COUNTS' | 'SOFTWARE_LICENSE'

Quantity type of the product.

contentobject

Additional content/configuration for the product. Structure varies by quantity type. Includes price, cost, taxable, and other type-specific fields.

createTimenumber double

Timestamp when the product was created.

updateTimenumber double

Timestamp when the product was last updated.

accountIdinteger

Account ID associated with the product.

groupboolean

Whether the product is a group product.

taxIdinteger nullable

Tax ID associated with the product. Null if no specific tax is set.

inheritTaxFromAgreementboolean

Whether the product inherits tax from the agreement.

activeboolean

Indicates if the product is active.

Example response

[
  {
    "id": 1,
    "name": "Hardware Support",
    "description": "Monthly hardware support service",
    "quantityType": "DEVICE_COUNTS",
    "accountId": 8,
    "taxId": 1,
    "inheritTaxFromAgreement": true,
    "active": true
  }
]