Account Determination Rules
GET /inventory/account-determination-rules
Group: Inventory › Account Determination Rules · Operation ID: accountDeterminationRules
Returns a list of account determination rules, headers only. To filter by a dimension or read a whole rule, use POST inventory/account-determination-rules/search.
This collection returns the header only: id, ruleName, priority, isActive and lastModifiedDate. It returns none of the dimensions, accounts or overrides, and cannot filter by any of them. Read a whole rule, or filter by entity, book, item type, item category, location or transaction type, with GET inventory/account-determination-rules/:id or POST inventory/account-determination-rules/search. ruleName is orderable but not filterable, because matching it would mean a substring query, which no endpoint here offers.
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "v1" |
yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likepriority— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeisActive— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, ruleName, priority, isActive, lastModifiedDate
- Selectable: id, ruleName, priority, isActive, lastModifiedDate
Response
200 Success
Under data, an array of accountDeterminationRulesRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | The unique identifier for the rule. |
ruleName |
string | no | A free-text label for the rule. It is not unique and is never read when matching. |
priority |
number or null | no | The tie-breaker between rules of equal specificity. The lower number wins. An absent priority counts as 0, which outranks any positive value. |
isActive |
boolean or null | no | Whether the rule takes part in account determination. When false, the rule is skipped. |
lastModifiedDate |
string (date-time) or null | no | The date and time the rule header last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Adding or changing a reason-code override does not change it. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error