Skip to main content
Docs vCurrent•API —
Version: Current

Billing model

The calls below generate a financial transaction (prices configurable per organization in Admin):

  • POST /api/v1/interactions/check
  • POST /api/v1/interactions/recheck
  • POST /api/v1/chat/message

Concepts​

  • transaction_fee_brl: unit price of check.
  • recheck_fee_brl: unit price of recheck.
  • chat_fee_brl: unit price per chat message.
  • transaction_charges: per-transaction entries.
  • invoices: periodic consolidation of transactions.
  1. Run the clinical integration normally.
  2. Transactions are recorded automatically per call.
  3. Generate a monthly invoice per organization.
  4. Set status: open, paid, overdue, cancelled.

Billing routes​

  • Hospital: GET /api/v1/billing/summary, GET /api/v1/billing/transactions, GET /api/v1/billing/estimate, GET /api/v1/billing/invoices