GetbeelDocs

Invite a commercialista

Emails the standard team invitation with the read-only auditor role (201); the advisor appears with status invited until they accept. An address that already has a pending advisor invitation gets it back (200) and no second email. 409 already_member for an address already in the team, already_invited for one invited to another role. Live keys only (403 livemode_required). The key’s member needs the invites.manage permission (to invite or revoke) or members.manage (to remove a member), the same rules as the app; otherwise 403.

POST
/advisors

Emails the standard team invitation with the read-only auditor role (201); the advisor appears with status invited until they accept. An address that already has a pending advisor invitation gets it back (200) and no second email. 409 already_member for an address already in the team, already_invited for one invited to another role. Live keys only (403 livemode_required). The key’s member needs the invites.manage permission (to invite or revoke) or members.manage (to remove a member), the same rules as the app; otherwise 403.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Header Parameters

Idempotency-Key?string

Recommended. Retrying with the same key and body within 24 hours replays the first response (header Idempotent-Replayed: true) instead of acting twice. The same key with a different body returns 422 idempotency_key_reused.

Lengthlength <= 255
Getbeel-Company?string

Act on one of the account's client companies (its id from GET /companies) instead of the key's own account. 404 company_not_found when the key cannot act on it.

Formatuuid

Request Body

application/json
  1. body
email*string

Email the invitation is sent to

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
Lengthlength <= 320

Response Body

Already invited: the pending invitation

application/json
  1. response
id*string
object*string
email*string
name*string|null
role*string

Read-only team role ("Commercialista" in the app): reads invoices, received invoices, bank movements and taxes, exports them, changes nothing

status*string

invited: the invitation email was sent and not accepted yet; active: a member of the team

Value in"invited""active"
invited_at*|null
expires_at*|

When a pending invitation stops working

joined_at*|null
Example Request
curl -X POST 'https://www.getbeel.com/api/v1/advisors' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
Example Response
{  "id": "inv_42",  "object": "advisor",  "email": "string",  "name": "string",  "role": "auditor",  "status": "invited",  "invited_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "joined_at": "2019-08-24T14:15:22Z"}