/v1/accounting/settingsRead accounting settings
Read this workspace's accounting settings: the default currency, the fiscal-year start month, how many days a payout may wait and an exception may sit before it is flagged, the SLA and clawback window a new deal gets when it does not say, and the wording of every closed vocabulary (allocation types, split party kinds, split bases, exception kinds with what each means and how it is fixed, bank sources, payout statuses). The answer is {settings, vocabularies}; vocabularies lists each vocabulary's fixed keys in display order; the keys never change, only their wording.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Responses
the action's answer
{
"data": {
"settings": {
"currency": "string",
"deal_clawback_window_days": 1.5,
"deal_sla_days": 1.5,
"exception_soon_days": 1.5,
"fiscal_year_start_month": 1.5,
"payout_wait_days": 1.5,
"terms": {
"allocation_types": {
"bonus": {
"label": "string"
},
"clawback_recovery": {
"label": "string"
},
"commission": {
"label": "string"
},
"management_fee": {
"label": "string"
},
"psf": {
"label": "string"
},
"syndication_fee": {
"label": "string"
}
},
"bank_sources": {
"bank_feed": {
"label": "string"
},
"csv": {
"label": "string"
},
"manual": {
"label": "string"
},
"plaid": {
"label": "string"
},
"port": {
"label": "string"
}
},
"exception_kinds": {
"clawback_open": {
"description": "string",
"fix": "string",
"label": "string"
},
"no_splits": {
"description": "string",
"fix": "string",
"label": "string"
},
"on_hold": {
"description": "string",
"fix": "string",
"label": "string"
},
"past_sla": {
"description": "string",
"fix": "string",
"label": "string"
},
"unreconciled": {
"description": "string",
"fix": "string",
"label": "string"
}
},
"payout_statuses": {
"approved": {
"label": "string"
},
"cancelled": {
"label": "string"
},
"paid": {
"label": "string"
},
"pending": {
"label": "string"
},
"rejected": {
"label": "string"
}
},
"split_bases": {
"commission": {
"label": "string"
},
"funded": {
"label": "string"
},
"gross": {
"label": "string"
},
"net": {
"label": "string"
},
"psf": {
"label": "string"
}
},
"split_party_kinds": {
"brokerage": {
"label": "string"
},
"house": {
"label": "string"
},
"lender": {
"label": "string"
},
"referrer": {
"label": "string"
},
"rep": {
"label": "string"
},
"syndicator": {
"label": "string"
},
"team_lead": {
"label": "string"
}
}
}
},
"vocabularies": {
"allocation_types": [
"string"
],
"bank_sources": [
"string"
],
"exception_kinds": [
"string"
],
"payout_statuses": [
"string"
],
"split_bases": [
"string"
],
"split_party_kinds": [
"string"
]
}
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}