Retrieve Manual Invoice Reason by ID

You can retrieve a manual invoice reason by ID using the following endpoint:

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

Before You Start

You will need the following when retrieving a manual invoice reason by ID:

• The id of the manual invoice reason entity to retrieve as the endpoint's {id} path parameter.

Response

1
2
3
4
5
6
7
8
9
10
11
12
{
  "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"
    } 
}

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: 11/2023.