The Share Transfer 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.

status string

Default: draft

transfer_type string required
date string required
from_shareholder string
from_folio_no string
equity_or_liability_account string required
asset_account string
to_shareholder string
to_folio_no string
share_type string required
from_no integer required
rate number required
no_of_shares integer required
to_no integer required
amount number
company string required
remarks string
The Share Transfer object 
{
  "id": "share-transfer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transfer_type": "transfer_type_example",
  "date": "2024-01-15",
  "from_shareholder": "from_shareholder_example",
  "from_folio_no": "from_folio_no_example",
  "equity_or_liability_account": "equity_or_liability_account_example",
  "asset_account": "asset_account_example",
  "to_shareholder": "to_shareholder_example",
  "to_folio_no": "to_folio_no_example",
  "share_type": "share_type_example",
  "from_no": 0,
  "rate": 0,
  "no_of_shares": 0,
  "to_no": 0,
  "amount": 0,
  "company": "Example Corp",
  "remarks": "remarks_example"
}
GET /api/accounts/share-transfer/{id}

Retrieve a share transfer

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

Path parameters

id string required

The identifier of the share transfer to retrieve.

Returns

Returns the share transfer object if a valid identifier was provided.

GET /api/accounts/share-transfer/{id} 
curl https://api.overplane.dev/api/accounts/share-transfer/share-transfer_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "share-transfer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transfer_type": "transfer_type_example",
  "date": "2024-01-15",
  "from_shareholder": "from_shareholder_example",
  "from_folio_no": "from_folio_no_example",
  "equity_or_liability_account": "equity_or_liability_account_example",
  "asset_account": "asset_account_example",
  "to_shareholder": "to_shareholder_example",
  "to_folio_no": "to_folio_no_example",
  "share_type": "share_type_example",
  "from_no": 0,
  "rate": 0,
  "no_of_shares": 0,
  "to_no": 0,
  "amount": 0,
  "company": "Example Corp",
  "remarks": "remarks_example"
}
GET /api/accounts/share-transfer

List all share transfers

Returns a list of share transfers. 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 share transfer objects.

GET /api/accounts/share-transfer 
curl https://api.overplane.dev/api/accounts/share-transfer \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "share-transfer_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "transfer_type": "transfer_type_example",
      "date": "2024-01-15",
      "from_shareholder": "from_shareholder_example",
      "from_folio_no": "from_folio_no_example",
      "equity_or_liability_account": "equity_or_liability_account_example",
      "asset_account": "asset_account_example",
      "to_shareholder": "to_shareholder_example",
      "to_folio_no": "to_folio_no_example",
      "share_type": "share_type_example",
      "from_no": 0,
      "rate": 0,
      "no_of_shares": 0,
      "to_no": 0,
      "amount": 0,
      "company": "Example Corp",
      "remarks": "remarks_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/share-transfer

Create a share transfer

Creates a new share transfer object.

Body parameters

status string

Default: draft

transfer_type string required
date string required
from_shareholder string
from_folio_no string
equity_or_liability_account string required
asset_account string
to_shareholder string
to_folio_no string
share_type string required
from_no integer required
rate number required
no_of_shares integer required
to_no integer required
amount number
company string required
remarks string

Returns

Returns the newly created share transfer object if the call succeeded.

POST /api/accounts/share-transfer 
curl https://api.overplane.dev/api/accounts/share-transfer \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"transfer_type":"transfer_type_example","date":"2024-01-15","equity_or_liability_account":"equity_or_liability_account_example","share_type":"share_type_example","from_no":0,"rate":0,"no_of_shares":0,"to_no":0,"company":"Example Corp"}'
Response 
{
  "id": "share-transfer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transfer_type": "transfer_type_example",
  "date": "2024-01-15",
  "from_shareholder": "from_shareholder_example",
  "from_folio_no": "from_folio_no_example",
  "equity_or_liability_account": "equity_or_liability_account_example",
  "asset_account": "asset_account_example",
  "to_shareholder": "to_shareholder_example",
  "to_folio_no": "to_folio_no_example",
  "share_type": "share_type_example",
  "from_no": 0,
  "rate": 0,
  "no_of_shares": 0,
  "to_no": 0,
  "amount": 0,
  "company": "Example Corp",
  "remarks": "remarks_example"
}
PATCH /api/accounts/share-transfer/{id}

Update a share transfer

Updates the specified share transfer 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 share transfer to update.

Body parameters

status string

Default: draft

transfer_type string
date string
from_shareholder string
from_folio_no string
equity_or_liability_account string
asset_account string
to_shareholder string
to_folio_no string
share_type string
from_no integer
rate number
no_of_shares integer
to_no integer
amount number
company string
remarks string

Returns

Returns the updated share transfer object.

PATCH /api/accounts/share-transfer/{id} 
curl https://api.overplane.dev/api/accounts/share-transfer/share-transfer_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","transfer_type":"transfer_type_example"}'
Response 
{
  "id": "share-transfer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transfer_type": "transfer_type_example",
  "date": "2024-01-15",
  "from_shareholder": "from_shareholder_example",
  "from_folio_no": "from_folio_no_example",
  "equity_or_liability_account": "equity_or_liability_account_example",
  "asset_account": "asset_account_example",
  "to_shareholder": "to_shareholder_example",
  "to_folio_no": "to_folio_no_example",
  "share_type": "share_type_example",
  "from_no": 0,
  "rate": 0,
  "no_of_shares": 0,
  "to_no": 0,
  "amount": 0,
  "company": "Example Corp",
  "remarks": "remarks_example"
}
DELETE /api/accounts/share-transfer/{id}

Delete a share transfer

Permanently deletes a share transfer. This cannot be undone.

Path parameters

id string required

The identifier of the share transfer to delete.

Returns

Returns a confirmation that the share transfer has been deleted.

DELETE /api/accounts/share-transfer/{id} 
curl https://api.overplane.dev/api/accounts/share-transfer/share-transfer_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "share-transfer_abc123",
  "deleted": true
}
POST /api/accounts/share-transfer/{id}/submit

Submit a share transfer

Submits a draft share transfer, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the share transfer to act on.

Returns

Returns the share transfer object with updated status.

POST /api/accounts/share-transfer/{id}/submit 
curl https://api.overplane.dev/api/accounts/share-transfer/share-transfer_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "share-transfer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transfer_type": "transfer_type_example",
  "date": "2024-01-15",
  "from_shareholder": "from_shareholder_example",
  "from_folio_no": "from_folio_no_example",
  "equity_or_liability_account": "equity_or_liability_account_example",
  "asset_account": "asset_account_example",
  "to_shareholder": "to_shareholder_example",
  "to_folio_no": "to_folio_no_example",
  "share_type": "share_type_example",
  "from_no": 0,
  "rate": 0,
  "no_of_shares": 0,
  "to_no": 0,
  "amount": 0,
  "company": "Example Corp",
  "remarks": "remarks_example"
}
POST /api/accounts/share-transfer/{id}/cancel

Cancel a share transfer

Cancels a submitted share transfer, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the share transfer to act on.

Returns

Returns the share transfer object with updated status.

POST /api/accounts/share-transfer/{id}/cancel 
curl https://api.overplane.dev/api/accounts/share-transfer/share-transfer_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "share-transfer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transfer_type": "transfer_type_example",
  "date": "2024-01-15",
  "from_shareholder": "from_shareholder_example",
  "from_folio_no": "from_folio_no_example",
  "equity_or_liability_account": "equity_or_liability_account_example",
  "asset_account": "asset_account_example",
  "to_shareholder": "to_shareholder_example",
  "to_folio_no": "to_folio_no_example",
  "share_type": "share_type_example",
  "from_no": 0,
  "rate": 0,
  "no_of_shares": 0,
  "to_no": 0,
  "amount": 0,
  "company": "Example Corp",
  "remarks": "remarks_example"
}