Organization

An organization is your account with Beach. An API key belongs to one organization, so requests do not take an organization id.

FBO accounts, inventory, shipments, and transfers are all scoped to that organization.

string

required

Organization ID.

name

string

required

Organization name.

createdAt

string<date-time>

required

maxInsuredValueCents

string

Insured-value ceiling for all inventory in the organization, in cents. Set by Beach.

brandName

string

Name used on statements and the account-holder portal.

brandPrimaryColor

string

brandSecondaryColor

string

statementFooterText

string

statementReplyToEmail

string

hideVaultDetails

boolean

When true, statements omit vault location details.

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "maxInsuredValueCents": "<string>",
  "brandName": "<string>",
  "brandPrimaryColor": "<string>",
  "brandSecondaryColor": "<string>",
  "statementFooterText": "<string>",
  "statementReplyToEmail": "<string>",
  "hideVaultDetails": true
}

Overview

Entities

Organizations

FBO Accounts

Products

Inventory

Inbound Shipments

Transfers

Outbound Requests

Outbound Shipments

Statements