Evenbead docs
Contents

Projects

4 operations. All areas

POST/v1/projects

Create a project (job): a reporting dimension on journal and document lines beside the class, optionally for one customer

  • Operation createProject
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Request body
  • name string, required
  • customer_id string | null
  • dry_run boolean
Responses
  • 200 Dry run (object)
  • 201 Created (object)
  • Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

GET/v1/projects

Projects, with their customers

  • Operation listProjects
  • Scope: read
  • Read
Parameters
  • active query, boolean
  • customer_id query, string
Responses
  • 200 Projects (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/projects/{id}

One project with its P&L to date (accrual)

  • Operation getProject
  • Scope: read
  • Read
Parameters
  • id path, string, required
  • from query, string
  • to query, string
Responses
  • 200 Project (object)
  • Errors 400, 401, 403, 404, 422, 429, 500 (Error: error.type, message)

POST/v1/projects/{id}

Deactivate or reactivate a project, or change its customer (never deleted; lines keep it). Audited.

  • Operation updateProject
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • active boolean
  • customer_id string | null
  • dry_run boolean
Responses
  • 200 Updated (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)