Add Rate Table Entries

You can create a rate table entry using the following endpoint and sample payload:

POST https://example-gotransverse.com/billing/2/rate-tables/{rate_table_id}/entries

Request

The following is an example of a request payload for creating a new rate table entry:

Copy

1
2
3
4
5
6
{
    "rate": 60.00,
    "lookup": "Minivan",
    "valid_from": "2024-01-01",
    "valid_to": "2024-12-31"
}

The following table indicates which fields are required in the request payload to successfully create a rate table entry:

Create Rate Table Entry Request Fields
Name	Description	Data Type	Required or Optional	Notes
rate	The rate that is applied to each unit of measure.	number	Required
lookup	The lookup value to which the rate will apply. The lookup value cannot duplicate any existing lookup value in the table unless the date range for the new entry does not overlap the existing.	string	Required
valid_from	The date and time since when the rate becomes effective. By default, the current date is set, you can change it by entering the needed date. If the new entry’s lookup value duplicates another existing lookup value, the valid from date cannot overlap the existing date range used by the other existing lookup value.	string	Required	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_to	The date and time until when the rate is effective. If you leave this field empty, the rate will not expire. If the new entry’s lookup value duplicates another existing lookup value, the valid to date cannot overlap the existing date range used by another existing lookup value.	string	Optional	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

Response

When successful, the new rate table entity is returned with an id assigned and a reference to the related rate table.

Copy

1
2
3
4
5
6
7
8
9
10
11
{
    "id": "6045",
    "rate": 60.00,
    "lookup": "Minivan",
    "valid_from": "2024-01-01T00:00:00-06:00",
    "rate_table": {
        "id": "671",
        "name": "Vehicle Rental Rates"
    },
    "valid_to": "2024-12-31T00:00:00-06:00"
}

Topic Updated: 1/2025.