Supplier
A Supplier is a Person or Company that delivers work through a Startup’s human supply: recruited, credentialed, and paid out.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
status | string | required | One of recruited, onboarded, active, or suspended. |
payoutAccount | string | Where payouts land, held through Stripe. |
Inherited from Party: 1 property
| Property | Type | Required | Description |
|---|---|---|---|
name | string | required | The legal or personal name. |
Object
{
"$id": "https: //api.sb/ kilnbakery.com/ suppliers/ supplier_1",
"$type": "Supplier",
"name": "Kiln Bakery",
"status": "recruited",
"payoutAccount": "Example payout account"
}Relationships
- A Supplier delivers many Services: Suppliers staff Services through the Startup’s human supply.
delivers, inversesuppliedBy. - A Supplier holds many Credentials: the Credentials a Supplier holds decide which Reserved Acts it may perform; standing is read fresh on every use.
holds, inverseheldBySupplier.
Verbs
createCreates a Supplier.POST /{namespace}/suppliersgetReturns one Supplier by id.GET /{namespace}/suppliers/{id}listReturns Suppliers, newest first, one page at a time.GET /{namespace}/suppliersupdateChanges the given properties of a Supplier.PATCH /{namespace}/suppliers/{id}deleteDeletes a Supplier; its history is kept.DELETE /{namespace}/suppliers/{id}
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Supplier.create | Yes | Yes | Yes | No |
Supplier.get | Yes | Yes | Yes | Yes |
Supplier.list | Yes | Yes | Yes | Yes |
Supplier.update | Yes | Yes | Yes | No |
Supplier.delete | Yes | Yes | Yes | No |
Call it
Add a supplier to PetPantry.Example
A licensed home inspector recruited by an inspection-booking network is a Supplier. She holds her state Credential, takes assigned bookings, and is paid out to her payoutAccount after each accepted report.