ADM-BUYING-POLICY-551 - List all grace amounts

get

https://example.com/v1/buying-policies/credit-control/grace-amounts

Retrieves all configured credit tolerance (grace amount) entries with optional filters.

Each entry adds a temporary or permanent allowance to a Customer Account's available credit.

Filter behaviour

- If customerAccountIds[] contains both valid and invalid IDs, the valid IDs are applied and the invalid ones are silently ignored.

Sorting

- Default By createdAt:desc (most recent first).

- When sorting by endDate, null values are always placed last.

- Invalid or malformed sort entries are silently ignored.

Sorting expressed as field:direction.

- Allowed fields: createdAt, updatedAt, startDate, endDate, amount, accountId

- Allowed directions: asc, desc

- Multiple sorts are supported by repeating the parameter: ?sort=createdAt:desc&sort=amount:asc

⚠️ This endpoint is only accessible when the dj-client header is set to OPERATOR.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

size

int32

sort

array of strings

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

sort

customerAccountIds

string

External IDs of Customer Accounts to filter on.

startDateFrom

date-time

Include entries with startDate ≥ this timestamp (ISO 8601: YYYY-MM-DDTHH:MM:SSZ).

endDateFrom

date-time

Include entries with endDate ≥ this timestamp (ISO 8601: YYYY-MM-DDTHH:MM:SSZ).

startDateTo

date-time

Include entries with startDate ≤ this timestamp (ISO 8601: YYYY-MM-DDTHH:MM:SSZ).

endDateTo

date-time

Include entries with endDate ≤ this timestamp (ISO 8601: YYYY-MM-DDTHH:MM:SSZ).

amountMin

string

≥ 0

Minimum grace amount (inclusive). Must be ≥ 0.

amountMax

string

≥ 0

Maximum grace amount (inclusive). Must be ≥ 0 and ≥ amountMin when both are provided.

customerAccountName

string

    Filter by Customer Account display name (case-insensitive, contains).<br>
    Repeat the parameter to provide multiple values (logical OR).<br>
    If a value is empty or only whitespace, it is ignored.<br>

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200List of all grace amount entries. Each item includes timestamps for creation and last update.

400Invalid request parameters. This error occurs when: amountMin > amountMax Invalid date-time format (must be ISO 8601: YYYY-MM-DDTHH:MM:SSZ)

401Authentication required.

403Access forbidden.

500Unexpected server error.