Query for Charge Categories

You can retrieve a list of charge categories using the following endpoint and query parameters:

GET https://example-gotransverse.com/billing/2/charge-categories

Learn what you need to know to successfully retrieve a list of charge categories in the Query Parameters and Response sections below:

Query Parameters

The following query parameters can be used to filter the query results in addition to the common query parameters available for most GET endpoints:

Response

The following response payload example includes query results for each charge category type:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
[
  {
    "charge_category_type": "additional-fee",
    "id": "1062",
    "name": "Late Fee",
    "code": "Late Fee-hNBLy",
    "description": "Late Fee for 90 Days",
    "priority": 37,
    "status": "ACTIVE",
    "tax_code": "1-1",
    "tax_mode": "INCLUSIVE"
  },
  {
    "charge_category_type": "adhoc",
    "id": "1064",
    "name": "Rebill",
    "code": "Rebill-hEJmp",
    "description": "Rebill-Invoice Correction",
    "priority": 39,
    "status": "ACTIVE",
    "tax_code": "1-1",
    "tax_mode": "INCLUSIVE"
  },
  {
    "charge_category_type": "adjustment",
    "id": "235",
    "name": "Default Adjustment Charge Category",
    "code": "Default Adjustment Charge Category-EJVGq",
    "description": "Default Adjustment Charge Category",
    "priority": 1,
    "status": "ACTIVE",
    "tax_code": "1-2, 59-21",
    "taxable": "false",
    "tax_mode": "EXCLUSIVE"
  },
  {
    "charge_category_type": "discount",
    "id": "1083",
    "name": "New Member Discount",
    "code": "New Member Discount-KLbir",
    "priority": 40,
    "status": "SUSPENDED",
    "tax_code": "1-1",
    "tax_mode": "INCLUSIVE"
  },
  {
    "charge_category_type": "manual-invoice",
    "id": "237",
    "name": "Default Manual Invoice Charge Category",
    "code": "Default Manual Invoice Charge Category-MLWlK",
    "description": "Default Manual Invoice Charge Category",
    "priority": 1,
    "status": "ACTIVE"
  },
  {
    "charge_category_type": "payment",
    "id": "231",
    "name": "Default Chargeback Category",
    "code": "Default Chargeback Category-hmKha",
    "description": "Default Chargeback Category",
    "priority": 1,
    "status": "ACTIVE"
  },
  {
    "charge_category_type": "price",
    "id": "708",
    "name": "Hardware",
    "code": "Hardware-kNWWD",
    "priority": 6,
    "status": "ACTIVE",
    "tax_code": "1-1"
  },
  {
    "charge_category_type": "service-suspension",
    "id": "233",
    "name": "Default Suspension Charge Category",
    "code": "Default Suspension Charge Category-gEFJY",
    "description": "Default Suspension Charge Category Description",
    "priority": 1,
    "status": "ACTIVE"
  },
  {
    "charge_category_type": "service-resumption",
    "id": "234",
    "name": "Default Resume Charge Category",
    "code": "Default Resume Charge Category-dqYjY",
    "description": "Default Resume Charge Category Description",
    "priority": 1,
    "status": "ACTIVE"
  },
  {
    "charge_category_type": "tax",
    "id": "755",
    "name": "Tax Category",
    "code": "Tax Category-PXxRT",
    "priority": 21,
    "status": "ACTIVE",
    "tax_type_code": "10",
    "tax_level": "FEDERAL"
  },
  {
    "charge_category_type": "usage-charge",
    "id": "737",
    "name": "Mileage Usage category",
    "code": "Mileage Usage category-UCxox",
    "priority": 18,
    "status": "ACTIVE",
    "tax_code": "1-2",
    "tax_mode": "INCLUSIVE"
  }
]

The following fields are returned when retrieving a charge category:

• charge_category_type — The type of charge category. Available values are:

  • additional-fee

  • adhoc

  • adjustment

  • discount

  • manual-invoice

  • payment

  • price

  • service-resumption

  • service-suspension

  • tax

  • usage-charge

• id — The unique ID of the charge category.

• name — The name of the charge category.

• code — A unique code for the charge category.

• description — A description of the charge category.

• priority — The numerical priority of the charge category. This controls the order in which the charge categories are displayed in the user interface.

• status — The status of the charge category. Available values are:

  • ACTIVE — The charge category can be assigned as a value for other entities and assigned to charges.

  • SUSPENDED — The charge category cannot be assigned as a value for other entities but is in use for existing entities and assigned to charges.

  • CANCELED — The charge category cannot be assigned as a value for other entities and is not in use.

The tax_code attribute below is returned only when populated for charge category types additional-fee, adhoc, adjustment, discount, payment, price, and usage-charge.

• tax_code — An item code used to determine the tax rate of a charge, unique to the tax processor configured for the tenant.

The tax_mode and taxable attributes below are returned only when populated for charge category types additional-fee, adhoc, adjustment, discount, payment, and usage-charge.

• taxable — Indicates if charges with this assigned charge category are sent to the tax processor for tax calculations.

• tax_mode — The method of tax calculation for charges with this assigned charge category:

  • EXCLUSIVE — The charge amount is the taxable amount. Taxes are calculated based on the charge amount and the tax amount is invoiced in addition to the charge amount.

  • INCLUSIVE — The charge amount includes the taxable amount and tax amount. Taxes are calculated based on the tax jurisdiction of the address so that the sum of the taxable amount and the tax amount equal the charge amount.

  • NONE — The charge amount is not taxable.

The tax_type_code, tax_level, and tax_level_name attributes below are returned only when populated for charge category type tax.

• tax_type_code — A code identifying the type of tax, unique to the tax processor configured for the tenant.

• tax_level — The tax jurisdiction type, unique to the tax processor configured for the tenant.

• tax_level_name — The tax jurisdiction name.

Topic Updated: 7/2024.