Organization

Organization management, statistics, and user membership

List user's organizations#

GET /api/v1/organizations

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/organizations" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get organization details#

GET /api/v1/organizations/{id}

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/organizations/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Update organization#

PUT /api/v1/organizations/{id}

Requires authentication (Bearer token) and the X-Organization-Id header.

country is immutable once the organization exists and is not accepted here. currency is locked once any financial document (invoice/quote/expense/credit note) exists — attempting to change it then returns 422. subdivision_code is editable going-forward. (#635, #638)

Parameters#

Request body#

Responses#

Example request#

curl -X PUT "https://app.encryptinvoice.com/api/v1/organizations/{id}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "currency": "string",
    "timezone": "string",
    "language": "string",
    "subdivision_code": "string",
    "settings": [],
    "address_line1": "string",
    "address_line2": "string",
    "city": "string",
    "postal_code": "string",
    "state": "string",
    "contact_name": "string",
    "contact_email": "string",
    "contact_phone": "string",
    "logo": "string",
    "tax_number": "string",
    "registration_number": "string",
    "legal_form": "string",
    "website": "string"
}'

Get organization statistics (Core only)#

GET /api/v1/organizations/{id}/statistics

Requires authentication (Bearer token) and the X-Organization-Id header.

NOTE: Invoicing statistics moved to ReportingController (Invoicing plugin) to maintain plugin architecture. Core should not depend on plugins.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/organizations/{id}/statistics" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

List organization users#

GET /api/v1/organizations/{id}/users

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/organizations/{id}/users" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Invite user to organization#

POST /api/v1/organizations/{id}/users/invite

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Request body#

Responses#

Example request#

curl -X POST "https://app.encryptinvoice.com/api/v1/organizations/{id}/users/invite" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "role": "string"
}'

Update user role#

PUT /api/v1/organizations/{id}/users/{userId}

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Request body#

Responses#

Example request#

curl -X PUT "https://app.encryptinvoice.com/api/v1/organizations/{id}/users/{userId}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "string"
}'

Remove user from organization#

DELETE /api/v1/organizations/{id}/users/{userId}

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X DELETE "https://app.encryptinvoice.com/api/v1/organizations/{id}/users/{userId}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"