API reference

Company

The company behind the books: its name, address and fiscal year.

GET/v1/companyGet the company behind these books
PATCH/v1/companyChange what is recorded about the company

Guides: Set up your books, Settings and your team

Get the company behind these books

GET/v1/company

client.company.get()

The company behind these books: its legal name, address, what it is and what it came to LedgerIt to do, and whether its set-up is finished.

Response

200CompanyOut

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/company" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Change what is recorded about the company

PATCH/v1/company· Idempotent

client.company.update()

Change what is recorded about the company. Admins and owners only.

name renames the books everywhere they are shown, and the organization with them when it carries the same name.

Only the fields sent change. An EIN and "no EIN yet" exclude each other, so setting either clears the other; sending both is refused. The day the books start is the book's: a connection's first sync brings in nothing dated before it. A new company's books start the day it was incorporated, unless a start is sent.

Request body

CompanyPatch

Response

200CompanyOut

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 PATCH "https://api.ledgerit.ai/v1/company" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Objects

The objects these operations take and return.

CompanyOut

What the company behind these books told us about itself.

Name	Type	Description
`address_line1`Required	string or null	The first line of the address the company files taxes from.
`address_line2`Required	string or null	The second line of the address, if it has one.
`books_start_on`Required	string (date) or null	The first day the books hold. A connection's first sync brings in nothing dated before it.
`city`Required	string or null	The city of the address.
`country`Required	string or null	The country of the address: ISO 3166-1 alpha-2, “US”.
`email`Required	string or null	The address the company is reached at.
`fiscal_year_end_month`Required	integer	The month the fiscal year ends in, 1–12. 12 is a calendar year.
`goals`Required	array of string	What the company came to LedgerIt to do. One of `bank_feeds`, `categorize`, `close`, `revenue`, `payroll`, `receipts`, `reports`, `accountant`, `api`
`headcount`Required	string or null	How many people work there, as a band. One of `1_10`, `11_50`, `51_200`, `201_plus`
`incorporated_on`Required	string (date) or null	The day the company was incorporated.
`incorporation_state`Required	string or null	Where the company was incorporated: a US state's code (“DE”), or the jurisdiction as written.
`industry`Required	string or null	What the company does. One of `software`, `fintech`, `ai`, `marketplace`, `consumer`, `hardware`, `health`, `climate`, `services`, `other`
`legal_name`Required	string or null	The name the company is registered under.
`legal_structure`Required	string or null	What the company's tax return is filed as. One of `c_corp`, `s_corp`, `llc`, `partnership`, `sole_proprietorship`, `non_us`
`name`Required	string	The name these books go by in the app: on the switcher, in settings, at the top of every page. Not the legal name, which is on invoices and filings.
`no_tax_id`Required	boolean	True when the company said it has no EIN yet.
`onboarding_completed_at`Required	string (date-time) or null	When the set-up was finished. Null while it is still in progress.
`phone`Required	string or null	The company's phone number.
`postal_code`Required	string or null	The ZIP or postal code of the address.
`receipts`Required	string or null	How the company keeps receipts today. One of `paper`, `digital`, `both`, `none`
`region`Required	string or null	The state, province or county of the address.
`stage`Required	string or null	How far the company has raised. One of `pre_seed`, `seed`, `series_a`, `series_b`, `growth`, `bootstrapped`
`starting_point`Required	string or null	How the books begin: `new` (with the company), `from_date` (on a date chosen), or `migrating` (from QuickBooks or Xero). One of `new`, `from_date`, `migrating`
`tax_id`Required	string or null	The EIN, or the local equivalent outside the US. Masked (`••-•••6789`) for a caller without the sensitive-data permission (`sensitive.read`).
`timezone`Required	string or null	The company's IANA time zone, such as `America/New_York`: the weekly digest goes out on Monday in it. Null reads as UTC.
`website`Required	string or null	The company's website, as it was given.

CompanyPatch

The fields to change. A field left out is kept; null clears it.

Name	Type	Description
`address_line1`	string or null
`address_line2`	string or null
`books_start_on`	string (date) or null	Not after today.
`city`	string or null
`country`	string or null
`email`	string or null
`fiscal_year_end_month`	integer or null
`goals`	array of string or null	Replaces the list; each goal once. One of `bank_feeds`, `categorize`, `close`, `revenue`, `payroll`, `receipts`, `reports`, `accountant`, `api`
`headcount`	string or null	One of `1_10`, `11_50`, `51_200`, `201_plus`
`incorporated_on`	string (date) or null	Not after today.
`incorporation_state`	string or null
`industry`	string or null	One of `software`, `fintech`, `ai`, `marketplace`, `consumer`, `hardware`, `health`, `climate`, `services`, `other`
`legal_name`	string or null
`legal_structure`	string or null	One of `c_corp`, `s_corp`, `llc`, `partnership`, `sole_proprietorship`, `non_us`
`name`	string or null	Rename the books. It cannot be cleared: `null` is refused. The organization named after them is renamed with them.
`no_tax_id`	boolean or null	True says there is no EIN yet, and clears `tax_id`.
`onboarding_completed`	boolean or null	True finishes the set-up (the first time only); false puts it back in progress.
`phone`	string or null
`postal_code`	string or null
`receipts`	string or null	One of `paper`, `digital`, `both`, `none`
`region`	string or null
`stage`	string or null	One of `pre_seed`, `seed`, `series_a`, `series_b`, `growth`, `bootstrapped`
`starting_point`	string or null	`new` with `incorporated_on` known and no `books_start_on` sent starts the books on it. One of `new`, `from_date`, `migrating`
`tax_id`	string or null	Setting one clears `no_tax_id`.
`timezone`	string or null	An IANA time zone, such as `America/New_York`; `null` goes back to UTC.
`website`	string or null