Create expense rule

This resource is only available to subscribers of the feature, as it is a paid add-on.

Creates a recurring expense rule and assigns it to the given listings.

Status can be draft or active. For active, categoryId, the chargeable, share, vendor and channels groups, tax.isTaxEnabled and a non-empty listingIds are required. For draft, only name and status are required and listingIds may be omitted.

Currency is taken from the account. Listing assignment is processed asynchronously: the response echoes the accepted listingIds, and GET /expense-rules/{id} reflects them once processed (usually within seconds).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255

Name of the expense rule

string
enum
required

Status of the expense rule

Allowed:
string

Category ID. Required when status is active.

string
length ≤ 255

Description of the expense rule

chargeable
object
share
object
vendor
object
channels
object
tax
object
listingIds
array of strings, unique
length ≥ 1

Listing IDs to assign to the expense rule. Required and non-empty when status is active; optional when draft. Assignment is processed asynchronously and is reflected in GET /expense-rules/{id} within a few seconds.

listingIds
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json