Evenbead docs
Contents

Requests

4 operations. All areas

GET/v1/requests

Requests your accounting firms sent you, open ones first

  • Operation listRequests
  • Scope: read
  • Read
Parameters
  • status query, "open" | "answered" | "closed" | "cancelled"
Responses
  • 200 Requests (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

POST/v1/requests/{id}/answer

Answer a firm's request in words and/or with files already uploaded as receipts (receipt_ids). People of this company only; answering again adds files and replaces the words until the firm closes it.

  • Operation answerRequest
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • answer string
  • receipt_ids array of string
Responses
  • 200 Answered (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

GET/v1/requests/emails

Whether you get an email when an accounting firm sends this company a request (and reminders while it is overdue). Your own choice; people of this company only.

  • Operation getRequestEmails
  • Scope: read
  • Read
Responses
  • 200 Your choice (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

POST/v1/requests/emails

Turn your own request emails on or off (people of this company only, signed in as themselves; never agents or a firm's staff). Audited. The unsubscribe link in those emails turns it off too.

  • Operation setRequestEmails
  • Scope: read
  • Write: needs Idempotency-Key (or dry_run)
Request body
  • enabled boolean, required
Responses
  • 200 Set (object)
  • Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)