The Shareholder object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

title string required
folio_no string
company string required
is_company boolean

Default: false

contact_list string
The Shareholder object 
{
  "id": "shareholder_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "folio_no": "folio_no_example",
  "company": "Example Corp",
  "is_company": false,
  "contact_list": "contact_list_example"
}
GET /api/accounts/shareholder/{id}

Retrieve a shareholder

Retrieves the details of an existing shareholder. Supply the unique shareholder ID that was returned from a previous request.

Path parameters

id string required

The identifier of the shareholder to retrieve.

Returns

Returns the shareholder object if a valid identifier was provided.

GET /api/accounts/shareholder/{id} 
curl https://api.overplane.dev/api/accounts/shareholder/shareholder_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "shareholder_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "folio_no": "folio_no_example",
  "company": "Example Corp",
  "is_company": false,
  "contact_list": "contact_list_example"
}
GET /api/accounts/shareholder

List all shareholders

Returns a list of shareholders. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of shareholder objects.

GET /api/accounts/shareholder 
curl https://api.overplane.dev/api/accounts/shareholder \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "shareholder_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "title": "title_example",
      "folio_no": "folio_no_example",
      "company": "Example Corp",
      "is_company": false,
      "contact_list": "contact_list_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/shareholder

Create a shareholder

Creates a new shareholder object.

Body parameters

title string required
folio_no string
company string required
is_company boolean

Default: false

contact_list string

Returns

Returns the newly created shareholder object if the call succeeded.

POST /api/accounts/shareholder 
curl https://api.overplane.dev/api/accounts/shareholder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example","company":"Example Corp"}'
Response 
{
  "id": "shareholder_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "folio_no": "folio_no_example",
  "company": "Example Corp",
  "is_company": false,
  "contact_list": "contact_list_example"
}
PATCH /api/accounts/shareholder/{id}

Update a shareholder

Updates the specified shareholder by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the shareholder to update.

Body parameters

title string
folio_no string
company string
is_company boolean

Default: false

contact_list string

Returns

Returns the updated shareholder object.

PATCH /api/accounts/shareholder/{id} 
curl https://api.overplane.dev/api/accounts/shareholder/shareholder_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example","folio_no":"folio_no_example"}'
Response 
{
  "id": "shareholder_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "folio_no": "folio_no_example",
  "company": "Example Corp",
  "is_company": false,
  "contact_list": "contact_list_example"
}
DELETE /api/accounts/shareholder/{id}

Delete a shareholder

Permanently deletes a shareholder. This cannot be undone.

Path parameters

id string required

The identifier of the shareholder to delete.

Returns

Returns a confirmation that the shareholder has been deleted.

DELETE /api/accounts/shareholder/{id} 
curl https://api.overplane.dev/api/accounts/shareholder/shareholder_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "shareholder_abc123",
  "deleted": true
}

Line items

Child objects that belong to this shareholder. These are accessed via the parent's ID.

Share Balance

Attributes

idx integer
shareholder_id string required
share_type string required
from_no integer required
rate number required
no_of_shares integer required
to_no integer required
amount number required
is_company boolean
current_state string

Endpoints

GET /api/accounts/share-balance?parent_id={id}
POST /api/accounts/share-balance
PATCH /api/accounts/share-balance/{id}
DELETE /api/accounts/share-balance/{id}
POST /api/accounts/share-balance/reorder
Share Balance object 
{
  "id": "share-balance_abc123",
  "idx": 1,
  "shareholder_id": "shareholder_id_example",
  "share_type": "share_type_example",
  "from_no": 0,
  "rate": 0,
  "no_of_shares": 0,
  "to_no": 0,
  "amount": 0,
  "is_company": false,
  "current_state": "current_state_example"
}