List Ad Hoc Charges

get

https://api.warehance.com/v1/adhoc-charges

Required permission: read_adhoc_charges

Get a list of ad hoc charges for your organization's clients. Ad hoc charges are one-off charges that are added to a client's bill when a bill covering the charge date is generated or regenerated. Only organization API keys can access this endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

client_id

integer

≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

start_date

date-time

Only return charges dated on or after this date.

end_date

date-time

Only return charges dated on or before this date.

order_id

integer

≥ 1

Only return charges linked to this order.

shipment_id

integer

≥ 1

Only return charges linked to this shipment.

return_id

integer

≥ 1

Only return charges linked to this return.

inbound_shipment_id

integer

≥ 1

Only return charges linked to this inbound shipment.

kit_assembly_task_id

integer

≥ 1

Only return charges linked to this kit assembly task.

sort_by

string

enum

The field to sort the ad hoc charges by

Allowed:

limit

integer

1 to 100

Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

offset

integer

≥ 0

Defaults to 0

deprecated

Deprecated. Use cursor instead. Offset pagination will be removed on November 9, 2026. See Pagination.

The number of items to skip before starting to return results. Cannot be used together with the cursor parameter.

cursor

string

A cursor for pagination. Omit it for the first page, then pass the next_cursor value from the previous response to fetch the next page. Keep the same filters and sort on every page. See Pagination.

order_by

string

enum

Defaults to asc

Specifies the sort direction of the returned items:

asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.

Allowed:

search_value

string

A value to search for within the items. The specific fields searched depend on the endpoint.

Responses

200A list of ad hoc charges

400Example Error Response

403Forbidden - API Key does not have required permissions, is a client API key, or does not have access to the client