evenbooks
Sign inStart for free

Account

Who is calling and with what access.

Paths are relative to https://evenbooks.org/api/v1. How keys, errors, paging and versions work is in the guide; the whole reference is also an OpenAPI 3.1 document.

Administrator key marks endpoints that need a key with the admin role, Write access those a read-only key can’t call, and Idempotent those that accept an idempotency key.

Who am I

get/me

The company, role and access of the credential making the request, and its request budget. A cheap way to check that a key works.

Response 200

MeDto

  • apiVersionstring
  • companyCompanyDto
  • rolestring · MembershipRole

    One of: admin member

  • authone of 2 shapes
    Show 2 shapes

    type: "api_key"

    • typestring

      Always "api_key"

    • keyIdstring · Uuid
    • namestring
    • accessstring · ApiKeyAccess

      One of: read write

    • expiresAtstring or null

    type: "session"

    • typestring

      Always "session"

    • userIdstring
  • rateLimitRateLimitDto or null

Errors 400 · 401 · 403 · 404 · 409 · 429

Schemas

The types these endpoints take or return, by name. Type names above link here.

Address

  • line1stringoptional

    up to 200 characters

  • line2stringoptional

    up to 200 characters

  • citystringoptional

    up to 100 characters

  • regionstringoptional

    up to 100 characters

  • postalCodestringoptional

    up to 20 characters

  • countrystringoptional

    up to 2 characters

ApiKeyAccess

string

One of: read write

BusinessType

string

One of: sole_proprietor single_member_llc partnership s_corp c_corp nonprofit other

CompanyDto

  • idstring
  • clerkOrgIdstring
  • namestring
  • legalNamestring or null
  • emailstring or null
  • phonestring or null
  • addressAddress
  • baseCurrencystring · CurrencyCode
  • timeZonestring
  • fiscalYearStartMonthinteger
  • invoicePrefixstring
  • nextInvoiceNumberinteger
  • creditNotePrefixstring
  • defaultTermsDaysinteger
  • invoiceFooterstring or null
  • hasPostedEntriesboolean
  • planstring

    One of: free paid

  • transactionDeletionEnabledboolean
  • businessTypestring · BusinessType or null

    One of: sole_proprietor single_member_llc partnership s_corp c_corp nonprofit other

  • taxBasisstring · TaxBasis or null

    One of: cash accrual

  • booksStartDatestring or null
  • setupDismissedAtstring or null
  • versioninteger

CurrencyCode

string

pattern ^[A-Z]{3}$

MembershipRole

string

One of: admin member

RateLimitDto

  • perMinuteinteger
  • perDayinteger

TaxBasis

string

One of: cash accrual

Uuid

string (uuid)