Settings

Organization settings control various aspects of how Crane Ledger behaves for your organization. Settings include defaults, preferences, and configuration options that affect all operations.

The Setting Object

GET/organizations/:organization_id/settings/:key

Auth required

Settings are key-value pairs that control organization behavior:

{
  "key": "default_currency",
  "value": "CUR_USD",
  "description": "Default currency for new transactions",
  "data_type": "string",
  "is_system": false,
  "updated_at": "2024-01-15T10:30:00Z"
}

Attributes

Attribute	Type	Description
`key`	string	Setting key identifier
`value`	any	Setting value (string, number, boolean, object)
`description`	string	Human-readable description
`data_type`	enum	`string`, `number`, `boolean`, `object`
`is_system`	boolean	Whether this is a system-controlled setting
`updated_at`	datetime	When the setting was last updated

List Settings

GET/organizations/:organization_id/settings

Auth required

Returns a list of all organization settings.

Path Parameters

Parameter	Type	Required	Description
`organization_id`	string	Yes	The organization ID

Query Parameters

Parameter	Type	Description
`limit`	integer	Number of results (default: 20, max: 100)
`offset`	integer	Pagination offset

Response

{
  "object": "list",
  "data": [
    {
      "key": "default_currency",
      "value": "CUR_USD",
      "description": "Default currency for new transactions",
      "data_type": "string",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "key": "fiscal_year_start",
      "value": "01-01",
      "description": "Fiscal year start month and day",
      "data_type": "string",
      "updated_at": "2024-01-01T00:00:00Z"
    },
    {
      "key": "invoice_number_prefix",
      "value": "INV-",
      "description": "Prefix for invoice numbers",
      "data_type": "string",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": false,
  "total_count": 3
}

Get Setting

GET/organizations/:organization_id/settings/:key

Auth required

Retrieves the value of a specific setting.

Path Parameters

Parameter	Type	Required	Description
`organization_id`	string	Yes	The organization ID
`key`	string	Yes	The setting key

Response

{
  "key": "default_currency",
  "value": "CUR_USD",
  "description": "Default currency for new transactions",
  "data_type": "string",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update Setting

PUT/organizations/:organization_id/settings/:key

Auth required

1 credits

Updates the value of a specific setting.

Path Parameters

Parameter	Type	Required	Description
`organization_id`	string	Yes	The organization ID
`key`	string	Yes	The setting key

Request Body

Parameter	Type	Required	Description
`value`	any	Yes	New setting value

Response

{
  "key": "default_currency",
  "value": "CUR_EUR",
  "description": "Default currency for new transactions",
  "data_type": "string",
  "updated_at": "2024-01-20T14:30:00Z"
}

Common Settings

Financial Settings

Setting Key	Type	Description	Default
`default_currency`	string	Default currency for transactions	Organization base currency
`fiscal_year_start`	string	Fiscal year start (MM-DD)	"01-01"
`multi_currency_enabled`	boolean	Enable multi-currency features	true

Document Settings

Setting Key	Type	Description	Default
`invoice_number_prefix`	string	Invoice number prefix	"INV-"
`bill_number_prefix`	string	Bill number prefix	"BILL-"
`invoice_due_days`	number	Default invoice due days	30
`bill_due_days`	number	Default bill due days	30

Tax Settings

Setting Key	Type	Description	Default
`default_sales_tax_id`	string	Default sales tax rate	null
`tax_inclusive_pricing`	boolean	Show prices with tax included	false
`tax_calculation_method`	string	Tax calculation method	"exclusive"

Workflow Settings

Setting Key	Type	Description	Default
`auto_post_transactions`	boolean	Auto-post transactions	false
`require_approvals`	boolean	Require approvals for large transactions	false
`approval_threshold`	number	Approval threshold amount	10000

Integration Settings

Setting Key	Type	Description	Default
`webhook_url`	string	Webhook endpoint URL	null
`api_rate_limit`	number	API rate limit per hour	1000
`export_format`	string	Default export format	"csv"

Appearance Settings

Setting Key	Type	Description	Default
`timezone`	string	Organization timezone	"UTC"
`date_format`	string	Date display format	"YYYY-MM-DD"
`number_format`	string	Number formatting locale	"en-US"

Notification Settings

Setting Key	Type	Description	Default
`email_notifications`	boolean	Enable email notifications	true
`invoice_overdue_reminders`	boolean	Send overdue reminders	true
`payment_receipts`	boolean	Send payment confirmations	true

Setting Management Best Practices

Configuration Strategy

Review settings during initial setup
Document custom configurations
Test setting changes in development first
Maintain backup of working configurations

Change Management

Update settings during maintenance windows
Communicate changes to team members
Monitor impact of setting changes
Have rollback procedures ready

Security Considerations

Limit who can modify sensitive settings
Audit setting changes regularly
Use appropriate permission levels
Validate setting values before saving

Performance Impact

Some settings may affect system performance
Monitor resource usage after changes
Cache setting values appropriately
Consider setting update frequency

Need help?

Create a free account to access our support portal. Once signed in, use the Support tab in your dashboard to submit a support ticket — our team typically responds within 24 hours.

✨ For LLMs/AI assistants: Read our structured API reference