Skip to main content
POST
/
api
/
organization
/
build
Build organization database
curl --request POST \
  --url https://api.example.com/api/organization/build \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "name": "Acme Inc.",
  "location": "US",
  "baseCurrency": "USD",
  "timezone": "America/New_York",
  "fiscalYear": "January",
  "language": "en-US",
  "industry": "Technology",
  "dateFormat": "MM/DD/YYYY"
}
'
{
  "type": "success",
  "code": "ORGANIZATION.DATABASE.INITIALIZED",
  "message": "The organization database has been initialized.",
  "data": {
    "job_id": "1"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
​
name
string
required

Organization name

Example:

"Acme Inc."

​
location
string
required

Country location in ISO 3166-1 alpha-2 format

Example:

"US"

​
baseCurrency
string
required

Base currency in ISO 4217 format

Example:

"USD"

​
timezone
string
required

Timezone of the organization

Example:

"America/New_York"

​
fiscalYear
string
required

Starting month of fiscal year

Example:

"January"

​
language
string
required

Language/locale of the organization

Example:

"en-US"

​
industry
string

Industry of the organization

Example:

"Technology"

​
dateFormat
string

Date format used by the organization

Example:

"MM/DD/YYYY"

Response

The organization database has been initialized