Skip to main content
GET
List cost rules

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
limit
integer
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100
vendor_id
integer

Filter by supplier / factory ID.

status
enum<string>

Filter by status. If omitted, only ACTIVE rules are returned.

Available options:
ACTIVE,
INACTIVE,
DRAFT
document_type
enum<string>

Filter to rules that include this document type.

Available options:
PURCHASE_ORDER,
WORK_ORDER,
SHIPMENT
name
string

Name contains (LIKE). Alias — search.

Name contains (LIKE). Alias for name.

description
string

Description contains (LIKE).

Response

A list of cost rules.

data
object[]
meta
object