You can retrieve a list of manual charges A manual charge represents user-defined charge information for a future invoice item charge (generated charge) based on an existing invoice item charge (source charge) from the same billing account. using the following endpoint:

GET https://example-gotransverse.com/billing/2/manual-charges

Learn what you need to know to successfully retrieve a list of manual charges 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:

Manual Charge Query Parameters

Name	Description	Data Type	Notes
id*	The ID of the manual charge.	string	Sortable. Refer to Retrieve Manual Charge Reason by ID.
status	The status of the manual charge. Available values are DRAFT, POSTED, or COMPLETED.	string	Sortable.
source_invoice_id*	The ID of the invoice associated with the source invoice item charge.	string
source_invoice_num*	The invoice number of the invoice associated with the source invoice item charge.	string
source_invoice_item_id*	The ID of the invoice item associated with the source invoice item charge.	string
source_invoice_item_charge_id*	The ID of the source invoice item charge.	string	Sortable.
generated_invoice_id*	The ID of the invoice associated with the generated invoice item charge.	string	Valid for manual charges with a Completed status.
generated_invoice_num*	The invoice number of the invoice associated with the generated invoice item charge.	string	Valid for manual charges with a Completed status.
generated_invoice_item_id*	The ID of the invoice item associated with the generated invoice item charge.	string	Valid for manual charges with a Completed status.
generated_invoice_item_charge_id*	The ID of the invoice item charge associated with the generated invoice item charge.	string	Sortable. Valid for manual charges with a Completed status.
taxable	Indicates whether the manual charge is taxable. Available values are TRUE and FALSE.	boolean
start_date	The start date and time of the manual charge.	string	Sortable. Date/Time in ISO 8601 Format. ISO 8601 Examples: 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00
end_date	The end date and time of the manual charge.	string	Sortable. Date/Time in ISO 8601 Format. ISO 8601 Examples: 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00
effective_date	The effective date and time of the manual charge.	string	Sortable. Date/Time in ISO 8601 Format. ISO 8601 Examples: 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00
amount	The amount of the manual charge. The amount is equal to the quantity multiplied by the unit price.	number	Sortable.
posted_on	The date and time the manual charge status was updated to POSTED.	string	Sortable. Date/Time in ISO 8601 Format. ISO 8601 Examples: 2015-12-12Z, 2015-12-12T12:12+02:00, 2015-12-12T12:12:14Z, 2015-12-12T12:12:14+02:00 Valid for manual charges with a Posted or Completed status.
posted_by	The username of the user who posted the manual charge.	string	Sortable. Valid for manual charges with a Posted or Completed status.
reason_id	The ID of the reason of the manual charge.	string
billing_account_id*	The ID of the billing account associated with the manual charge.	string	Sortable.
account_num*	The account number of the billing account associated with the manual charge.	string	Sortable.
external_account_num*	The external account number of the billing account associated with the manual charge.	string	Sortable.

Response

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
[
  {
    "type": "sourced",
    "id": "136496",
    "description": "string",
    "status": "COMPLETED",
    "quantity": 5,
    "amount": 625,
    "taxable": false,
    "unit_price": 125,
    "start_date": "2022-03-09T00:00:00-06:00",
    "end_date": "2022-03-09T00:00:00-06:00",
    "effective_date": "2022-03-09T00:00:00-06:00",
    "reason": {
      "reason_type": "manual-charge",
      "id": "487",
      "name": "string"
    },
    "generated_charge": {
      "invoice_item_charge_type": "manual",
      "id": "70305"
    },
    "posted_on": "2023-03-09T12:40:06-06:00",
    "posted_by": "string",
    "source_charge": {
      "invoice_item_charge_type": "charge",
      "id": "67187"
    }
  }
]

The following fields are returned when retrieving a manual charge:

• type — The type of manual charge. The available value is sourced.

• id — The ID of the manual charge.

• description — A description of the manual charge.

• status — The status of the manual charge. Possible values are:

  • DRAFT: Manual charge is created, can be edited or deleted, and is not eligible for bill cycle or bill batch processing.

  • POSTED: Manual charge is finalized, cannot be edited or deleted, and is eligible for bill cycle or bill batch processing.

  • COMPLETED: Manual charge was included in the bill cycle or bill batch process and the generated charge has been invoiced.

• quantity — The quantity of the charge.

• amount — The amount of the charge.

• taxable — Specifies whether the charge is taxable.

  • TRUE: Tax is calculated for the charge when invoiced.

  • FALSE: Tax is not calculated for the charge when invoiced.

• unit_price — The unit price of the charge.

• start_date — The date and time the charge starts.

• end_date — The date and time the charge ends.

• effective_date — The date and time the manual charge becomes effective. This date determines the bill cycle in which the charge is generated and invoiced.

• reason — The reason for the manual charge.

  • reason_type: The type of reason. Possible values are manual-charge and manual-invoice.

  • id: The ID of the reason.

  • name: The name of the reason.

The generated_charge object below is returned only when the status of the manual charge is COMPLETED or when the status is POSTED but the related invoice still has a status of PROCESSING.

• generated_charge — The invoice item charge object generated based on the manual charge and source charge details.

  • invoice_item_charge_type: The type of invoice item charge generated from the manual charge. The available value is manual.

  • id: The ID of the invoice item charge generated from the manual charge.

The posted_on and posted_by fields below are returned only when the status of the manual charge is POSTED or COMPLETED.

• posted_on — The date and time the manual charge was posted.

• posted_by — The username of the user who changed the status of the manual charge to POSTED.

• source_charge — The invoice item charge object the manual charge was based on.

  • invoice_item_charge_type: The type of source invoice item charge. Possible values are charge, manual-usage, manual-usage-discount, usage, usage-discount.

  • id: The ID of the source invoice item charge.

Topic Updated: 7/2024.