API reference

Investor shares

Links that share the closed months with an investor, read-only, and when each was last opened.

GET/v1/investor_sharesList the links the books are shared with investors by
POST/v1/investor_sharesShare the books with an investor through a link
GET/v1/investor_shares/{share_id}Get an investor link and when it was last opened
DELETE/v1/investor_shares/{share_id}Revoke an investor link

Guides: Share your books with investors

List the links the books are shared with investors by

GET/v1/investor_shares

client.investorShares.list()

The links these books are shared with investors by, the newest first, each with when it was last opened.

Parameters

Name	Type	Description
`status`Query	string or null	Only `live`, `expired` or `revoked` links. One of `live`, `expired`, `revoked`
`limit`Query	integer	Page size, 1–200. Default 50
`cursor`Query	string or null	The `next_cursor` of the previous page.

Response

200InvestorSharePage

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/investor_shares" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Share the books with an investor through a link

POST/v1/investor_shares· Idempotent

client.investorShares.create()

Share these books with an investor through a link. The link opens a read-only page of the closed months — the board packs, the statements, or both — with no account needed, until it expires or is revoked. The answer carries the link's token and address once; nothing is emailed.

Request body

InvestorShareCreate

Response

201InvestorShareCreatedOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X POST "https://api.ledgerit.ai/v1/investor_shares" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"investor_name":"…"}'

Get an investor link and when it was last opened

GET/v1/investor_shares/{share_id}

client.investorShares.get()

One investor link: who it is for, what it shows, and when it was last opened. Its token is not in it: that is shown once, when it is made.

Parameters

Name	Type	Description
`share_id`Path · Required	string	An id that starts with `investor_share_`.

Response

200InvestorShareOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/investor_shares/{share_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Revoke an investor link

DELETE/v1/investor_shares/{share_id}

client.investorShares.revoke()

Revoke a link: from now on it opens nothing, and files already downloaded keep the watermark naming who they were shared with. A link is revoked, never erased, so the record of who was shown what stays. Revoking a revoked link changes nothing.

Parameters

Name	Type	Description
`share_id`Path · Required	string	An id that starts with `investor_share_`.

Response

200InvestorShareOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X DELETE "https://api.ledgerit.ai/v1/investor_shares/{share_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Objects

The objects these operations take and return.

InvestorSharePage

Name	Type	Description
`data`Required	array of InvestorShareOut
`has_more`Required	boolean
`next_cursor`Required	string or null

InvestorShareCreate

Name	Type	Description
`expires_at`	string (date-time) or null	When the link stops working. Left out, it works until it is revoked.
`investor_email`	string or null	Their address, for the founder's own record. LedgerIt sends nothing to it.
`investor_firm`	string or null	Their firm or fund.
`investor_name`Required	string	Who the link is for, as the founder knows them.
`scope`	array of string	What the link shows: `board_packs`, `statements`, or both (the default). One of `board_packs`, `statements`

InvestorShareCreatedOut

A link just made, with the one copy of its token there will be.

Name	Type	Description
`created_at`Required	string (date-time)
`created_by`Required	string or null	An id that starts with `usr_`.
`expires_at`Required	string (date-time) or null	When it stops working; null for a link with no expiry.
`id`Required	string	The link's id. Its token is never shown again after it is made.
`investor_email`Required	string or null	Their address, when one was given. Nothing is sent to it.
`investor_firm`Required	string or null	Their firm or fund, when one was given.
`investor_name`Required	string	Who the link is for.
`last_viewed_at`Required	string (date-time) or null	When the investor last opened it; null if never.
`revoked_at`Required	string (date-time) or null	When it was revoked.
`revoked_by`Required	string or null	An id that starts with `usr_`.
`scope`Required	array of string	What the link shows of each closed month: `board_packs` (the pack's figures and commentary), `statements` (the balance sheet, income statement and cash flow statement), or both. Never transactions, payroll or an open month. One of `board_packs`, `statements`
`status`Required	string	`live` while it opens the page, `expired` once its expiry has passed, `revoked` once revoked. One of `live`, `expired`, `revoked`
`token`Required	string	The link's secret. Shown once: LedgerIt keeps only its SHA-256, so it cannot be shown again. A retry of the same request with the same Idempotency-Key within a day returns it again.
`url`Required	string	The investor's page: send them this.
`view_count`Required	integer	How many times it was opened.

InvestorShareOut

A link that shares these books' closed months with one investor.

Name	Type	Description
`created_at`Required	string (date-time)
`created_by`Required	string or null	An id that starts with `usr_`.
`expires_at`Required	string (date-time) or null	When it stops working; null for a link with no expiry.
`id`Required	string	The link's id. Its token is never shown again after it is made.
`investor_email`Required	string or null	Their address, when one was given. Nothing is sent to it.
`investor_firm`Required	string or null	Their firm or fund, when one was given.
`investor_name`Required	string	Who the link is for.
`last_viewed_at`Required	string (date-time) or null	When the investor last opened it; null if never.
`revoked_at`Required	string (date-time) or null	When it was revoked.
`revoked_by`Required	string or null	An id that starts with `usr_`.
`scope`Required	array of string	What the link shows of each closed month: `board_packs` (the pack's figures and commentary), `statements` (the balance sheet, income statement and cash flow statement), or both. Never transactions, payroll or an open month. One of `board_packs`, `statements`
`status`Required	string	`live` while it opens the page, `expired` once its expiry has passed, `revoked` once revoked. One of `live`, `expired`, `revoked`
`view_count`Required	integer	How many times it was opened.