Organization
An Organization is an outside party as one Startup knows it, keyed by its domain, such as an employer or a vendor.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
name | string | required | The name it trades under. |
hostname | string | The web domain that keys it. |
Inherits from Party, which adds no properties of its own.
Object
{
"$id": "https: //api.sb/ ledgerlark.com/ organizations/ organization_1",
"$type": "Organization",
"name": "LedgerLark",
"hostname": "ledgerlark.com"
}Relationships
- An Organization has many Bills: a Bill is owed to one outside Organization, whose page lists every Bill the Startup owes it.
bills, inverseowedTo. - An Organization has many Deals: each Deal has one buying Organization on the other side.
deals, inversecourts. - An Organization’s people are many Contacts: a Contact works for one Organization, as this Startup knows it.
people, inverseworksAt. - An Organization is reserved by one Partner: an Organization a Partner reserved before referring it, for the
partner.reservationWindowSetting (90 days by default); outbound skips it.reservedBy, inversereserves. - An Organization resolves to one Company: each Startup’s own view of an outside party resolves to the one legal entity behind it.
resolvesTo, inverseknownAs.
Verbs
createCreates an Organization.POST /{namespace}/organizationsgetReturns one Organization by id.GET /{namespace}/organizations/{id}listReturns Organizations, newest first, one page at a time.GET /{namespace}/organizationsupdateChanges the given properties of an Organization.PATCH /{namespace}/organizations/{id}deleteDeletes an Organization; its history is kept.DELETE /{namespace}/organizations/{id}mergeMerge joins a duplicate Organization into another, keeping every Contact, Deal and Event on the one that remains.POST /{namespace}/organizations/{organization}/merge
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Organization.create | Yes | Yes | Yes | No |
Organization.get | Yes | Yes | Yes | Yes |
Organization.list | Yes | Yes | Yes | Yes |
Organization.update | Yes | Yes | Yes | No |
Organization.delete | Yes | Yes | Yes | No |
Organization.merge | Yes | No | No | No |
Call it
Merge my organization.Example
To a recruiting-agency SaaS, the Organization keyed by northpeak-talent.com employs four Contacts and is the buyer on one Deal.