v2

latestOpenAPI 3.0.12026-07-263104131.9 MB

Billing

Updates a ticket product.

Updates a ticket product from a ticket.

put/v2/billing/ticket-products/{ticketProductId}

Path parameters

ticketProductIdinteger required

Ticket product ID

Request body

namestring required

Ticket product name.

descriptionstring required

Ticket product description.

How the product quantity is calculated. in billing.

contentobject required

Product basic information needed to its calculations.

ticketIdinteger required

Ticket ID where the product is assigned.

productIdinteger nullable required

Product ID of the catalog product, if assigned.

accountIdinteger required

Account ID assigned to the product.

taxIdinteger

Tax ID assigned to the product. If null, the product will use the agreement's tax.

inheritTaxFromAgreementboolean

Whether this product inherits its tax configuration from the agreement.

integrationSettingsobject

If 3rd party integration is enabled, the settings needed to export invoices with this product.

groupboolean required

Whether the product can be built as group.

Example request

{
  "name": "Billable Ticket Product Name.",
  "description": "This is a billable ticket product description.",
  "quantityType": "MANUAL",
  "ticketId": 12,
  "productId": 19,
  "accountId": 1,
  "taxId": 5,
  "inheritTaxFromAgreement": true,
  "productUserRole": {
    "allowAllTechnicians": true,
    "userRoles": [
      1,
      2
    ]
  },
  "group": true
}

Response

Successfully updated ticket product.

idinteger

namestring

descriptionstring

billingStatus'BILLED' | 'PENDING' | 'NOT_BILLABLE' | 'UNASSIGNED'

contentobject

productIdinteger

integrationSettingsobject

taxIdinteger

inheritTaxFromAgreementboolean