Ask to be paid back
const url = 'https://app.grouperly.com/api/v2/groups/example/reimbursements';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"eventId":"example","memo":"example","amount":"example","noReceiptConfirmed":true,"payoutMethod":"RECORDED"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://app.grouperly.com/api/v2/groups/example/reimbursements \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "eventId": "example", "memo": "example", "amount": "example", "noReceiptConfirmed": true, "payoutMethod": "RECORDED" }'As the person and to them, as Grouperly’s own form: it goes to the event’s leaders (or an expense approver), then the treasurer, who are emailed. The person must be on the roster and not a viewer or a child’s account. Receipts are added in Grouperly, so noReceiptConfirmed must be true: tell the person approvers may deny a request without one. Returns the request (added in 2.44.0).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The credential’s group
Request Bodyrequired
Section titled “Request Bodyrequired”object
The event it was for (Event.id): it goes to whoever runs it. Leave it out for anything else, and say what it was for in memo
What was bought. Needed when there is no event
Dollars and cents, as a string: “86.40”. More than 0
Must be true: receipts are added in Grouperly, and approvers may deny a request without one. Tell the person so before sending
RECORDED (the default): the treasurer pays it outside Grouperly. CREDIT: they’d like it credited to their account, on Grouperly Plus; the treasurer pays it, as credit or another way, once it’s approved
Responses
Section titled “Responses”Created
object
“Request 12”: a counter in each group
REIMBURSEMENT: paid back for something bought for the group. CREDIT_PAYOUT: credit asked to be paid out, approved by the treasurer alone. More may be added
SUBMITTED (waiting for step 1), APPROVED (waiting for step 2, the treasurer), READY_TO_PAY, PAYING (2.46.0: sent by direct deposit from the group’s bank, on its way), PAID, DENIED (it can be edited and sent again), WITHDRAWN. More may be added
The step it waits on: 1 or 2; null once both are done or it is closed
object
A decimal string, e.g. “25.00”: never a float.
ISO 4217, e.g. “USD”.
The event it was for; null for anything else, or once the event was deleted
The event’s name when it was asked, kept if the event is deleted
What was bought, or a payout’s note
Who is paid: whoever asked, by their roster entry
object
Their roster entry; null once it is gone
Null for a youth unless the app has roster.youth.read; a key never gets a youth’s name
RECORDED: the treasurer pays it outside Grouperly. CREDIT: credited to the payee’s account at the treasurer’s approval. ACH and CHECK (2.45.0): the person would like direct deposit or a mailed check from the group’s bank; the treasurer chooses in the end. More may be added
A credit payout’s account (GET /credit)
A payout of restricted credit, against a receipt and a note
Receipts sent with it. They are opened in Grouperly
The person asked for it
When it was last sent
Step 1
Step 2, the treasurer
Examplegenerated
{ "id": "example", "number": 1, "kind": "example", "status": "example", "step": 1, "amount": { "amount": "example", "currency": "example" }, "eventId": "example", "eventName": "example", "memo": "example", "payee": { "contactId": "example", "name": "example" }, "payoutMethod": "example", "creditAccountId": "example", "creditOf": { "contactId": "example", "name": "example" }, "fromRestricted": true, "receiptCount": 1, "mine": true, "submittedAt": "2026-04-15T12:00:00Z", "firstApprovedAt": "2026-04-15T12:00:00Z", "approvedAt": "2026-04-15T12:00:00Z", "deniedAt": "2026-04-15T12:00:00Z", "denyReason": "example", "withdrawnAt": "2026-04-15T12:00:00Z", "paidAt": "2026-04-15T12:00:00Z", "paid": { "method": "example", "reference": "example", "paidOn": "2026-04-15" }}Headers
Section titled “Headers”Requests allowed per minute for this credential
Requests left in this window
When the window ends (Unix seconds)
The body isn’t a JSON object of at most 16 KB, or a field is unknown, missing or malformed (invalid_body, with parameter)
object
object
Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.
For people; wording may change.
The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.
Examplegenerated
{ "error": { "code": "example", "message": "example", "parameter": "example" }}Headers
Section titled “Headers”Requests allowed per minute for this credential
Requests left in this window
When the window ends (Unix seconds)
Missing, unknown, revoked or expired credential (unauthorized)
object
object
Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.
For people; wording may change.
The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.
Examplegenerated
{ "error": { "code": "example", "message": "example", "parameter": "example" }}A key: wrong group (forbidden), missing scope (insufficient_scope), or its creator no longer leads the group (key_owner_not_leader). An app’s token: missing scope (insufficient_scope), the group hasn’t installed the app (app_not_installed) or allowed the scope (scope_not_allowed, the message has the consent link), the person may not do this in the group (forbidden), Grouperly paused the app (app_suspended), the person hasn’t accepted Grouperly’s current Terms (terms_required: refresh their token, then send them to the hub’s /account/welcome), or it’s a child’s account (child_account). A viewer token: the same, and forbidden in any group but its own. Also: the person isn’t on the group’s roster (forbidden), or payoutMethod CREDIT on a group without Grouperly Plus (plan_required)
object
object
Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.
For people; wording may change.
The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.
Examplegenerated
{ "error": { "code": "example", "message": "example", "parameter": "example" }}Headers
Section titled “Headers”Requests allowed per minute for this credential
Requests left in this window
When the window ends (Unix seconds)
Not found (not_found)
object
object
Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.
For people; wording may change.
The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.
Examplegenerated
{ "error": { "code": "example", "message": "example", "parameter": "example" }}Headers
Section titled “Headers”Requests allowed per minute for this credential
Requests left in this window
When the window ends (Unix seconds)
Rate limited (rate_limited)
object
object
Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.
For people; wording may change.
The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.
Examplegenerated
{ "error": { "code": "example", "message": "example", "parameter": "example" }}Headers
Section titled “Headers”Requests allowed per minute for this credential
Requests left in this window
When the window ends (Unix seconds)
Seconds to wait
An app’s token for someone new, while Grouperly’s sign-in can’t be reached (unavailable); try again
object
object
Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.
For people; wording may change.
The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.
Examplegenerated
{ "error": { "code": "example", "message": "example", "parameter": "example" }}