Bank1

Bank account7

Bank device4

Bank key4

Bank payroll13

Bank recipient6

Bank transaction8

Bill2

Budget4

Business Partner9

Card issuing request5

Card transaction2

Cartola3

Company12

Company membership11

Company role5

Company settings2

Convenio2

Credit Note1

Custom column5

Debit Note2

Exchange rate1

Fiscal Invoice3

Imprest Fund3

Integrations key2

Integrations key service1

Invoice1

Merchant1

Notification7

Payable19

Payable Comment2

Payable Transaction1

Payment1

Permission1

Purchase Order7

Purchase Order Items2

Reconciliation6

Recurring charge4

Refund request1

Review2

Reviewer3

Rule7

SII Key6

Tradable3

Transaction8

Transaction label6

Transaction rule5

User9

User settings3

Vendor card6

Company

Get reimbursement usage

Returns the company's Reembolsos (reimbursements) usage for the current period — the same ReimbursementUsage query object used by Sofia and the WhatsApp bot, so the counter is identical across channels. Powers the in-app "X of 15 free this month" view and the freemium/Pro upgrade banners.

The exact fields depend on whether the company is on the free quota, grandfathered, or subscribed to Pro; common fields are shown below.

get/v1/companies/{id}/reimbursement_usage

Path parameters

idstring required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Parameters

#/paths/~1v1~1users/get/parameters/0 — unresolved $ref

Response

Reimbursement usage snapshot.

usedinteger

Reimbursements consumed in the current period.

limitinteger nullable

Free quota for the period (null when unlimited/Pro).

remaininginteger nullable

grandfatheredboolean

subscribedboolean

pro_price_ufnumber nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.