Skip to main content
POST
/
companies
Create a company
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corporation",
  "client_type": {
    "id": 123,
    "name": "Retail"
  },
  "parent_company_id": 456,
  "address": "123 Main St",
  "address_line_2": "Suite 500",
  "city": "Austin",
  "state": "TX",
  "postal_code": "78701",
  "country": "USA",
  "phone": "555-123-4567",
  "fein": "12-3456789",
  "tax_exempt": false,
  "notes": "Key account, requires special handling",
  "payment_term": "Net 30",
  "due_date_days": 45,
  "tags": [
    "wholesale",
    "preferred"
  ],
  "custom_fields": {
    "Industry": "Manufacturing",
    "Region": "Southwest"
  },
  "shipping_addresses": [
    {
      "address_1": "456 Warehouse Blvd",
      "city": "Austin",
      "state": "TX",
      "country": "USA",
      "zip": "78745",
      "address_2": "Building 2",
      "first_name": "John",
      "last_name": "Doe",
      "email": "shipping@acmecorp.com",
      "phone": "555-987-6543",
      "is_default": true
    }
  ]
}
'
{
  "data": {
    "id": 123456,
    "status": "active",
    "name": "Acme Corporation",
    "created_at": "2023-03-15T14:30:00Z",
    "updated_at": "2023-03-15T14:30:00Z",
    "type": "Retail",
    "phone": "555-123-4567",
    "address": "123 Main St",
    "address_line_2": "Suite 500",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701",
    "country": "USA",
    "full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
    "shipping_first_name": "John",
    "shipping_last_name": "Doe",
    "shipping_email": "shipping@acmecorp.com",
    "shipping_phone": "555-987-6543",
    "shipping_address": "456 Warehouse Blvd",
    "shipping_city": "Austin",
    "shipping_state": "TX",
    "shipping_postal_code": "78745",
    "shipping_country": "USA",
    "shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
    "payment_term": "Net 30",
    "tax_exempt": false,
    "tax_rate": 8.25,
    "due_date_days": 30,
    "price_level": {
      "id": 123,
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "status": "active",
      "name": "Wholesale",
      "type": "percentage",
      "percent_increase": 15.5
    },
    "notes": "Key account, requires special handling",
    "fein": "12-3456789",
    "tags": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "color": "<string>"
      }
    ],
    "default_shipping": {
      "id": 789,
      "company_id": 123456,
      "address": "456 Warehouse Blvd",
      "city": "Austin",
      "state": "TX",
      "postal_code": "78745",
      "country": "USA",
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "company_name": "Acme Corporation",
      "address_line_2": "Building 2",
      "full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
      "full_name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "555-987-6543",
      "email": "shipping@acmecorp.com",
      "is_default": true
    },
    "shipping_addresses": [
      {
        "id": 789,
        "company_id": 123456,
        "address": "456 Warehouse Blvd",
        "city": "Austin",
        "state": "TX",
        "postal_code": "78745",
        "country": "USA",
        "created_at": "2023-03-15T14:30:00Z",
        "updated_at": "2023-03-15T14:30:00Z",
        "company_name": "Acme Corporation",
        "address_line_2": "Building 2",
        "full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
        "full_name": "John Doe",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "555-987-6543",
        "email": "shipping@acmecorp.com",
        "is_default": true
      }
    ],
    "billing_info": {
      "id": 456,
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "accounting@acmecorp.com",
      "receiving_bank_name": "First National Bank",
      "receiving_bank_address": "789 Finance Street, Austin, TX 78701"
    },
    "client_type": {
      "id": 123,
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "name": "Retail",
      "description": "Retail business client"
    },
    "parent_company_id": 456,
    "invoice_export_template_id": 789,
    "custom_fields": {
      "Industry": "Manufacturing",
      "Region": "Southwest",
      "Annual Revenue": "$5M-$10M"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

Company name

Maximum string length: 255
Example:

"Acme Corporation"

​
client_type
object

Client type information. Can provide either id or name. If name is provided and type doesn't exist, it will be created.

​
parent_company_id
integer | null

ID of the parent company

Example:

456

​
address
string | null

Street address for the company

Maximum string length: 255
Example:

"123 Main St"

​
address_line_2
string | null

Additional address information

Maximum string length: 255
Example:

"Suite 500"

​
city
string | null

City

Maximum string length: 255
Example:

"Austin"

​
state
string | null

State/province

Maximum string length: 255
Example:

"TX"

​
postal_code
string | null

Postal/ZIP code

Maximum string length: 255
Example:

"78701"

​
country
string | null

Country

Maximum string length: 255
Example:

"USA"

​
phone
string | null

Primary phone number for the company

Maximum string length: 255
Example:

"555-123-4567"

​
fein
string | null

Federal Employer Identification Number

Maximum string length: 255
Example:

"12-3456789"

​
tax_exempt
boolean | null

Whether the company is exempt from taxes

Example:

false

​
notes
string | null

Additional notes about the company

Example:

"Key account, requires special handling"

​
payment_term
string | null

Payment terms label (e.g. "Net 30"). Must match a supported payment term.

Example:

"Net 30"

​
due_date_days
integer | null

Number of days until payment is due (used when payment_term is "Custom")

Required range: x >= 0
Example:

45

​
tags
string[] | null

List of tags to associate with the company

Maximum string length: 255
Example:
["wholesale", "preferred"]
​
custom_fields
object

Custom field values for the company

Example:
{
  "Industry": "Manufacturing",
  "Region": "Southwest"
}
​
shipping_addresses
object[] | null

Array of shipping addresses to create for the company

Response

Company successfully created

​
data
object