Query Manual Invoice Reasons

You can retrieve a list of manual invoice reasons using the following endpoint and query parameters:

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

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:

Query parameters noted as Sortable can be used to organize the query results. Refer to Sort Query Parameter.

Manual Invoice Reasons Query Parameters
Name Description Data Type Notes
id The ID of the manual invoice reason. string

Sortable.

Refer to Retrieve Manual Invoice Reason by ID.
name The name of the manual invoice reason. string Sortable.
status

The status of the manual invoice reason. Available values are:

  • ACTIVE

  • SUSPENDED

  • CANCELED

string Sortable.
charge_category_id

The unique ID of the charge category.

 string  
charge_category_name The unique name of the charge category. string  

Response

Copy 
[
  {
    "id": "489",
    "name": "Default Manual Invoice Reason",
    "description": "Default Reason for Manual Invoices",
    "status": "ACTIVE"
    "reason_type": "manual-invoice",
    "charge_category": {
        "id": "4521788",
        "charge_category_type": "manual-invoice",
        "name": "Default Manual Invoice Charge Category"
    }
  },
  {
    "id": "515",
    "name": "Rebilling by Manual Invoice",
    "description": "Rebilling Reason for Manual Invoices",
    "status": "ACTIVE" 
    "reason_type": "manual-invoice",
    "charge_category": {
        "id": "4548714",
        "charge_category_type": "manual-invoice",
        "name": "Default Manual Invoice Charge Category"
  }
]

The following fields are returned when retrieving a manual invoice reason:

  • id — The ID of the manual invoice reason.

  • name — The name of the manual invoice reason.

  • description — A description of the manual invoice reason.

  • status — The status of the manual invoice reason.

    • ACTIVE: The reason is an available value for a new manual invoice or manual charge.

    • SUSPENDED: The reason is not an available value for a new manual invoice or manual charge. The reason can be made active again in the future.

    • CANCELED: The reason is not an available value for a new manual invoice or manual charge. The reason can be made active again in the future. The reason can be deleted if it has not been used in a manual invoice or manual charge.

  • reason_type — The type of reason. The only possible value is manual-invoice.

  • charge_category — The charge category associated with the manual invoice reason.

    • id: The ID of the charge category.

    • charge_category_type: The charge category type.

    • name: The name of the charge category.

 

 

 

Topic Updated: 5/2024.