Finans API

Müşterilerin borçları ve ödemeleri, işletmenin harcamaları.

Modül kodu finance · 42 işlem · 13 veri modeli · 30 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: finance (hepsi), finance:read (yalnız okuma) ya da finance:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

finance.accrue_commission

Komisyon tahakkuk ettir — Satış ortağına borçlu olunanı, sözleşme günü dondurulan oranla açar.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.accrue_commission

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.commission_accrued

Neye yazar: commission (insert) — Opens the commission

curl -X POST https://app.getera.io/api/v1/commissions/actions/accrue_commission \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"agreementId":"AGREEMENT_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.commission_accrued"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.commissions.accrueCommission({
  agreementId: "AGREEMENT_ID"
})

era commissions accrue_commission \
  --agreement-id "AGREEMENT_ID"

{
  "name": "era__finance__accrue_commission",
  "arguments": {
    "agreementId": "AGREEMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 agreement_not_found, commission_already_exists, agreement_has_no_affiliate, affiliate_not_active · 429 çok sık istek

finance.allocate_payment

Tahsilatı dağıt — Tek bir tahsilatı kapattığı taksitlere dağıtır.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.allocate_payment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_allocated

Neye yazar: payment_allocation (insert) — Writes the allocations

curl -X POST https://app.getera.io/api/v1/payment_allocations/actions/allocate_payment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"paymentId":"PAYMENT_ID","allocations":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.payment_allocated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.paymentAllocations.allocatePayment({
  paymentId: "PAYMENT_ID",
  allocations: {}
})

era payment_allocations allocate_payment --data '{"paymentId":"PAYMENT_ID","allocations":{}}'

{
  "name": "era__finance__allocate_payment",
  "arguments": {
    "paymentId": "PAYMENT_ID",
    "allocations": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 payment_not_found, no_allocations, unknown_allocation_target, invalid_allocation_amount, duplicate_allocation_target, allocation_exceeds_payment, allocation_target_not_found, allocation_currency_mismatch, allocation_customer_mismatch, allocation_exceeds_target · 429 çok sık istek

finance.apply_discount

İndirim uygula — Sözleşmeyi düşürür ve indirimli tutarı satırda dondurur.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.apply_discount

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.discount_applied

Neye yazar: discount_line (insert) — Writes the discount; agreement (update) — Freezes the discounted total

curl -X POST https://app.getera.io/api/v1/agreements/AGREEMENT_ID/actions/apply_discount \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"value":1,"reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.discount_applied"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.agreements.applyDiscount("AGREEMENT_ID", {
  value: 1,
  reason: "Reason"
})

era agreements apply_discount AGREEMENT_ID \
  --value 1 \
  --reason "Reason"

{
  "name": "era__finance__apply_discount",
  "arguments": {
    "agreementId": "AGREEMENT_ID",
    "value": 1,
    "reason": "Reason"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 agreement_not_found, agreement_closed, discount_value_negative, discount_percentage_over_100, discount_after_collection, discount_over_cap, discount_actor_required · 429 çok sık istek

finance.approve_expense

Gideri onayla — Bir gideri onaylar. Kendi gideriniz asla.

Gereken izin finance:approve · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.approve_expense

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.expense_approved

Neye yazar: expense (update) — Stamps the approval

curl -X POST https://app.getera.io/api/v1/expenses/EXPENSE_ID/actions/approve_expense \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.expense_approved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.expenses.approveExpense("EXPENSE_ID")

era expenses approve_expense EXPENSE_ID

{
  "name": "era__finance__approve_expense",
  "arguments": {
    "id": "EXPENSE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:approve izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 expense_not_found, expense_already_decided, cannot_approve_own_expense · 429 çok sık istek

finance.approve_refund

İadeyi onayla — Talebi onaylar ve uygular: para geri gönderilmiş olarak kaydedilir.

Gereken izin finance:approve · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.approve_refund

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.refund_approved, finance.payment_refunded

Neye yazar: payment_event (insert) — Records the refund step; payment (update) — Moves the pending and refunded amounts; payment_allocation (insert) — Writes the negative allocation; installment (update) — Reopens an instalment it no longer covers

curl -X POST https://app.getera.io/api/v1/payment_events/PAYMENT_EVENT_ID/actions/approve_refund \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.refund_approved",
    "finance.payment_refunded"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.paymentEvents.approveRefund("PAYMENT_EVENT_ID")

era payment_events approve_refund PAYMENT_EVENT_ID

{
  "name": "era__finance__approve_refund",
  "arguments": {
    "requestId": "PAYMENT_EVENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:approve izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 refund_request_not_found, refund_request_resolved, refund_not_available, payment_app_not_connected, payment_credentials_invalid · 429 çok sık istek

finance.cancel_agreement

Sözleşmeyi iptal et — Sözleşmeyi ve bekleyen taksitlerini kapatır. Hiçbir şey silinmez.

Gereken izin finance:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.cancel_agreement

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.agreement_cancelled

Neye yazar: agreement (update) — Marks it cancelled; installment (update) — Cancels the pending instalments

curl -X POST https://app.getera.io/api/v1/agreements/AGREEMENT_ID/actions/cancel_agreement \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.agreement_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.agreements.cancelAgreement("AGREEMENT_ID", {
  reason: "Reason"
})

era agreements cancel_agreement AGREEMENT_ID \
  --reason "Reason"

{
  "name": "era__finance__cancel_agreement",
  "arguments": {
    "id": "AGREEMENT_ID",
    "reason": "Reason"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 agreement_not_found, already_cancelled, agreement_has_collection · 429 çok sık istek

finance.cancel_commission

Komisyonu iptal et — Ödenmemiş bir komisyonu sıfırlar. Ödenmiş olan asla kaldırılmaz.

Gereken izin finance:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.cancel_commission

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.commission_cancelled

Neye yazar: commission (update) — Cancels it and zeroes the amount

curl -X POST https://app.getera.io/api/v1/commissions/COMMISSION_ID/actions/cancel_commission \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.commission_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.commissions.cancelCommission("COMMISSION_ID")

era commissions cancel_commission COMMISSION_ID

{
  "name": "era__finance__cancel_commission",
  "arguments": {
    "id": "COMMISSION_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 commission_not_found, paid_commission_not_deletable · 429 çok sık istek

finance.cancel_installment

Taksiti iptal et — Bir taksiti silmeden plandan çıkarır.

Gereken izin finance:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.cancel_installment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.installment_cancelled

Neye yazar: installment (update) — Marks it cancelled

curl -X POST https://app.getera.io/api/v1/installments/INSTALLMENT_ID/actions/cancel_installment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.installment_cancelled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.installments.cancelInstallment("INSTALLMENT_ID")

era installments cancel_installment INSTALLMENT_ID

{
  "name": "era__finance__cancel_installment",
  "arguments": {
    "id": "INSTALLMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 installment_not_found, installment_has_collection · 429 çok sık istek

finance.cancel_payment

Provizyonu serbest bırak — Provizyonu alınmış ama tahsil edilmemiş olanı iptal eder.

Gereken izin finance:write · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.cancel_payment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_provider_event

Neye yazar: payment (update) — Moves the amounts and stores what the provider now allows; payment_event (insert) — Records the provider’s answer

curl -X POST https://app.getera.io/api/v1/payments/PAYMENT_ID/actions/cancel_payment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"outcome":"success"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.payment_provider_event"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.payments.cancelPayment("PAYMENT_ID", {
  outcome: "success"
})

era payments cancel_payment PAYMENT_ID \
  --outcome "success"

{
  "name": "era__finance__cancel_payment",
  "arguments": {
    "paymentId": "PAYMENT_ID",
    "outcome": "success"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 payment_not_found, cancel_not_available, payment_app_not_connected, payment_credentials_invalid · 429 çok sık istek

finance.capture_payment

Ödemeyi tahsil et — Yalnızca provizyon alınmış parayı tahsil eder.

Gereken izin finance:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.capture_payment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_provider_event, finance.payment_recorded

Neye yazar: payment (update) — Moves the amounts and stores what the provider now allows; payment_event (insert) — Records the provider’s answer; payment_allocation (insert) — Puts charged money on the instalment; installment (update) — Closes the instalment once covered

curl -X POST https://app.getera.io/api/v1/payments/PAYMENT_ID/actions/capture_payment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"amount":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.payment_provider_event",
    "finance.payment_recorded"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.payments.capturePayment("PAYMENT_ID", {
  amount: 1
})

era payments capture_payment PAYMENT_ID \
  --amount 1

{
  "name": "era__finance__capture_payment",
  "arguments": {
    "paymentId": "PAYMENT_ID",
    "amount": 1
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 payment_not_found, charge_not_available, capture_exceeds_authorized, payment_app_not_connected, payment_credentials_invalid · 429 çok sık istek

finance.configure_payment_app

Ödeme uygulamasını yapılandır — Bağlı bir ödeme uygulamasını açar, sırasını belirler ve test modunu seçer.

Gereken izin finance:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.configure_payment_app

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_method_changed

Neye yazar: payment_provider_config (upsert) — Saves checkout enablement, order and test mode

curl -X POST https://app.getera.io/api/v1/payment_provider_configs/actions/configure_payment_app \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"provider":"Provider","credentialId":"CREDENTIAL_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.payment_method_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.paymentProviderConfigs.configurePaymentApp({
  provider: "Provider",
  credentialId: "CREDENTIAL_ID"
})

era payment_provider_configs configure_payment_app \
  --provider "Provider" \
  --credential-id "CREDENTIAL_ID"

{
  "name": "era__finance__configure_payment_app",
  "arguments": {
    "provider": "Provider",
    "credentialId": "CREDENTIAL_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 unsupported_payment_app, payment_credential_mismatch, payment_app_unavailable · 429 çok sık istek

finance.create_agreement

Sözleşme aç — Birinin ne borçlu olduğunu kaydeder; aksi belirtilmedikçe çalışma alanının para biriminde.

Gereken izin finance:write · veriyi değiştirir

• REST kısayolu: POST /api/v1/agreements
• Asıl adres: POST /api/v1/actions/finance.create_agreement

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.agreement_created

Neye yazar: agreement (insert) — Opens the agreement; agreement_line (insert) — Writes its lines

curl -X POST https://app.getera.io/api/v1/agreements/actions/create_agreement \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"customerId":"CUSTOMER_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.agreement_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.agreements.create({
  customerId: "CUSTOMER_ID"
})

era agreements create \
  --customer-id "CUSTOMER_ID"

{
  "name": "era__finance__create_agreement",
  "arguments": {
    "customerId": "CUSTOMER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 customer_not_found, customer_archived, invalid_currency, affiliate_not_active, agreement_total_not_positive · 429 çok sık istek

finance.create_expense

Gider kaydet — Bir kategoriye karşılık çıkan para; onay bekler.

Gereken izin finance:write · veriyi değiştirir

• REST kısayolu: POST /api/v1/expenses
• Asıl adres: POST /api/v1/actions/finance.create_expense

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.expense_created

Neye yazar: expense (insert) — Records the expense

curl -X POST https://app.getera.io/api/v1/expenses/actions/create_expense \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"categoryId":"EXPENSE_CATEGORY_ID","title":"What it was","amount":1,"expenseDate":"2026-11-02"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.expense_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.expenses.create({
  categoryId: "EXPENSE_CATEGORY_ID",
  title: "What it was",
  amount: 1,
  expenseDate: "2026-11-02"
})

era expenses create \
  --category-id "EXPENSE_CATEGORY_ID" \
  --title "What it was" \
  --amount 1 \
  --expense-date "2026-11-02"

{
  "name": "era__finance__create_expense",
  "arguments": {
    "categoryId": "EXPENSE_CATEGORY_ID",
    "title": "What it was",
    "amount": 1,
    "expenseDate": "2026-11-02"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 expense_category_not_available, invalid_currency, expense_amount_negative, expense_amount_over_cap, expense_date_in_future, expense_recurring_period_required · 429 çok sık istek

finance.deactivate_expense_category

Gider kategorisini kapat — Yeni giderlerin ona yazılmasını durdurur. Var olanlar kategorisini korur.

Gereken izin finance:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.deactivate_expense_category

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.expense_category_changed

Neye yazar: expense_category (update) — Clears is_active

curl -X POST https://app.getera.io/api/v1/expense_categories/EXPENSE_CATEGORY_ID/actions/deactivate_expense_category \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.expense_category_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.expenseCategories.deactivateExpenseCategory("EXPENSE_CATEGORY_ID")

era expense_categories deactivate_expense_category EXPENSE_CATEGORY_ID

{
  "name": "era__finance__deactivate_expense_category",
  "arguments": {
    "id": "EXPENSE_CATEGORY_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 expense_category_not_found · 429 çok sık istek

finance.mark_expense_paid

Gideri ödendi işaretle — Paranın çıktığı günü işler. Burada “ödendi” o tarih demektir.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.mark_expense_paid

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.expense_paid

Neye yazar: expense (update) — Stamps the payment date

curl -X POST https://app.getera.io/api/v1/expenses/EXPENSE_ID/actions/mark_expense_paid \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"paymentDate":"2026-11-02"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.expense_paid"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.expenses.markExpensePaid("EXPENSE_ID", {
  paymentDate: "2026-11-02"
})

era expenses mark_expense_paid EXPENSE_ID \
  --payment-date "2026-11-02"

{
  "name": "era__finance__mark_expense_paid",
  "arguments": {
    "id": "EXPENSE_ID",
    "paymentDate": "2026-11-02"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 expense_not_found, expense_not_approved, expense_paid_without_date · 429 çok sık istek

finance.open_draft_for_source

Kayıt için sözleşme taslağı hazırla — Otomatik: kazanılan bir potansiyel müşteri, randevu, paket, sipariş veya abonelik döneminin gerektirdiği sözleşme.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.open_draft_for_source

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.agreement_created, finance.payment_recorded

Neye yazar: agreement (insert) — Drafts the agreement; agreement (update) — Totals the discounts it came with; agreement_line (insert) — Writes what was sold, with its frozen tax, when the source says; discount_line (insert) — Writes the promotions and coupons the source applied; payment (insert) — Records what gift cards already paid, as collections; payment_event (insert) — The gift card charge; payment_allocation (insert) — Allocates it to the agreement

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 agreement_exists_for_source, customer_not_found, customer_archived, invalid_currency, payment_amount_not_positive, allocation_exceeds_target · 429 çok sık istek

finance.pay_site_agreement

Bağlantıyla öde (site) — Ziyaretçi randevu kaporasını, etkinlik biletini, paketi ya da açık bir taksiti ödeme bağlantısıyla; bağlı bir ödeme uygulaması ya da test yöntemiyle öder.

Gereken izin finance:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/finance.pay_site_agreement

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_provider_event, finance.payment_recorded, finance.installments_scheduled

Neye yazar: installment (insert) — The whole agreement as one instalment due today, when it has none; payment (insert) — Opens the transaction; payment_event (insert) — Records the provider’s answer; payment_allocation (insert) — Puts what was charged, and what a gift card paid, on the instalment; installment (update) — Closes the instalment when card and method cover it

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 pay_link_invalid, payment_method_unavailable, gift_card_hold_expired, nothing_due · 429 çok sık istek

finance.pay_site_order

Siparişi öde (site) — Ziyaretçi web siparişinde kalan tutarı bağlı bir ödeme uygulaması ya da test yöntemiyle öder.

Gereken izin finance:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/finance.pay_site_order

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_provider_event, finance.payment_recorded, finance.installments_scheduled

Neye yazar: installment (insert) — The whole order as one instalment due today, when it has none; payment (insert) — Opens the transaction; payment_event (insert) — Records the provider’s answer; payment_allocation (insert) — Puts what was charged, and what a gift card paid, on the instalment; installment (update) — Closes the instalment when card and method cover it

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 order_not_found, payment_method_unavailable, gift_card_hold_expired, payment_not_ready · 429 çok sık istek

finance.raise_installment_notices

Taksit hatırlatmalarını oluştur — Günlük finans işi; yaklaşan ve geciken her bekleyen taksit için yalnızca bir kez bildirim olayı üretir.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.raise_installment_notices

Girdi

Yayımladığı olaylar: finance.installment_due, finance.installment_overdue

Neye yazar: installment (update) — Records that the customer was told (due soon / overdue)

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 429 çok sık istek

finance.recalculate_commission

Komisyonu yeniden hesapla — Bekleyen bir komisyonu tahsil edilenle uyumlu hâle getirir. Her tahsilat ve iadede çalışır; düğme elle çalıştırır.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.recalculate_commission

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.commission_recalculated

Neye yazar: commission (update) — Writes the amount the collections support

curl -X POST https://app.getera.io/api/v1/commissions/actions/recalculate_commission \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"agreementId":"AGREEMENT_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.commission_recalculated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.commissions.recalculateCommission({
  agreementId: "AGREEMENT_ID"
})

era commissions recalculate_commission \
  --agreement-id "AGREEMENT_ID"

{
  "name": "era__finance__recalculate_commission",
  "arguments": {
    "agreementId": "AGREEMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 commission_not_found · 429 çok sık istek

finance.record_commission_payout

Komisyon ödemesini kaydet — Bir satış ortağına bir grup bekleyen komisyonu ödeyen tek bir transfer.

Gereken izin finance:approve · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.record_commission_payout

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.commission_payout_recorded, finance.commission_status_changed

Neye yazar: commission_payout (insert) — Records the transfer; commission (update) — Marks the commissions paid by it

curl -X POST https://app.getera.io/api/v1/commission_payouts/actions/record_commission_payout \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"affiliateId":"AFFILIATE_ID","commissionIds":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.commission_payout_recorded",
    "finance.commission_status_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.commissionPayouts.recordCommissionPayout({
  affiliateId: "AFFILIATE_ID",
  commissionIds: {}
})

era commission_payouts record_commission_payout --data '{"affiliateId":"AFFILIATE_ID","commissionIds":{}}'

{
  "name": "era__finance__record_commission_payout",
  "arguments": {
    "affiliateId": "AFFILIATE_ID",
    "commissionIds": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:approve izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 no_commissions_selected, affiliate_not_found, commission_not_payable · 429 çok sık istek

finance.record_gift_card_payment

Hediye kartı tahsilatını kaydet — Otomatik: bir satışın hediye kartıyla ödenen kısmı, sözleşmesine karşılık tahsilat olarak.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.record_gift_card_payment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_recorded

Neye yazar: payment (insert) — The gift card collection; payment_event (insert) — Its charge; payment_allocation (insert) — Allocated to the agreement

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 no_agreement_for_source, allocation_currency_mismatch, payment_amount_not_positive, allocation_exceeds_target · 429 çok sık istek

finance.record_payment

Tahsilat kaydet — Para geldi: hareketi, olayı ve neyi kapattığını yazar.

Gereken izin finance:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.record_payment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_recorded

Neye yazar: payment (insert) — Records the movement; payment_event (insert) — Records the charge event; payment_allocation (insert) — Says what it paid off; installment (update) — Closes the instalment when it is covered

curl -X POST https://app.getera.io/api/v1/installments/INSTALLMENT_ID/actions/record_payment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"amount":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.payment_recorded"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.installments.recordPayment("INSTALLMENT_ID", {
  amount: 1
})

era installments record_payment INSTALLMENT_ID \
  --amount 1

{
  "name": "era__finance__record_payment",
  "arguments": {
    "installmentId": "INSTALLMENT_ID",
    "amount": 1
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 installment_not_found, installment_cancelled, payment_amount_not_positive, duplicate_payment_idempotency_key, overpayment · 429 çok sık istek

finance.record_provider_webhook

Ödeme bildirimini kaydet — Ödeme sağlayıcısından gelen doğrulanmış bir bildirimi yalnızca bir kez kabul eder ve ilgili ödemeye uygular.

Gereken izin finance:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

• Asıl adres: POST /api/v1/actions/finance.record_provider_webhook

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_provider_event, finance.payment_recorded

Neye yazar: finance_provider_event (insert) — Admits the external event once; payment (update) — Moves the amounts and stores what the provider now allows; payment_event (insert) — Records the provider’s answer; payment_allocation (insert) — Puts charged money on the instalment; installment (update) — Closes the instalment once covered

curl -X POST https://app.getera.io/api/v1/payments/PAYMENT_ID/actions/record_provider_webhook \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"provider":"Provider","externalId":"Provider event","type":"Event type","amount":1,"currency":"Currency","occurredAt":"2026-11-02T09:00:00Z"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.payment_provider_event",
    "finance.payment_recorded"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.payments.recordProviderWebhook("PAYMENT_ID", {
  provider: "Provider",
  externalId: "Provider event",
  type: "Event type",
  amount: 1,
  currency: "Currency",
  occurredAt: "2026-11-02T09:00:00Z"
})

era payments record_provider_webhook PAYMENT_ID \
  --provider "Provider" \
  --external-id "Provider event" \
  --type "Event type" \
  --amount 1 \
  --currency "Currency" \
  --occurred-at "2026-11-02T09:00:00Z"

{
  "name": "era__finance__record_provider_webhook",
  "arguments": {
    "paymentId": "PAYMENT_ID",
    "provider": "Provider",
    "externalId": "Provider event",
    "type": "Event type",
    "amount": 1,
    "currency": "Currency",
    "occurredAt": "2026-11-02T09:00:00Z"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 unknown_payment_provider, webhook_payment_not_found, webhook_provider_mismatch · 429 çok sık istek

finance.record_source_discounts

Mağaza indirimlerini kaydet — Otomatik: bir siparişteki kampanya ve kuponları sözleşmesine indirim satırı olarak yansıtır.

Gereken izin finance:write · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/finance.record_source_discounts

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Neye yazar: discount_line (delete) — Drops what the shop wrote before; discount_line (insert) — Writes the current set; agreement (update) — Totals the discounts

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 no_agreement_for_source · 429 çok sık istek

finance.refund_payment

Tahsilatı iade et — Parayı geri gönderir. İade ayrı bir kayıt değil, tahsilat üzerinde bir olaydır.

Gereken izin finance:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.refund_payment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.payment_refunded

Neye yazar: payment_event (insert) — Records the refund event; payment (update) — Raises the refunded amount; payment_allocation (insert) — Writes the negative allocation; installment (update) — Reopens an instalment it no longer covers

curl -X POST https://app.getera.io/api/v1/payments/PAYMENT_ID/actions/refund_payment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"amount":1,"reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.payment_refunded"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.payments.refundPayment("PAYMENT_ID", {
  amount: 1,
  reason: "Reason"
})

era payments refund_payment PAYMENT_ID \
  --amount 1 \
  --reason "Reason"

{
  "name": "era__finance__refund_payment",
  "arguments": {
    "paymentId": "PAYMENT_ID",
    "amount": 1,
    "reason": "Reason"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 payment_not_found, refund_not_available, payment_app_not_connected, payment_credentials_invalid, refund_exceeds_charged · 429 çok sık istek

finance.reject_expense

Gideri reddet — Bir gideri nedeniyle birlikte reddeder.

Gereken izin finance:approve · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/finance.reject_expense

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.expense_rejected

Neye yazar: expense (update) — Records the rejection

curl -X POST https://app.getera.io/api/v1/expenses/EXPENSE_ID/actions/reject_expense \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.expense_rejected"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.expenses.rejectExpense("EXPENSE_ID", {
  reason: "Reason"
})

era expenses reject_expense EXPENSE_ID \
  --reason "Reason"

{
  "name": "era__finance__reject_expense",
  "arguments": {
    "id": "EXPENSE_ID",
    "reason": "Reason"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:approve izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 expense_not_found, expense_already_decided, expense_rejection_reason_required · 429 çok sık istek

finance.reject_refund

İadeyi reddet — Talebi, nedeni tahsilatın geçmişine yazılarak reddeder.

Gereken izin finance:approve · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/finance.reject_refund

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.refund_rejected

Neye yazar: payment_event (insert) — Records the refund step; payment (update) — Moves the pending and refunded amounts

curl -X POST https://app.getera.io/api/v1/payment_events/PAYMENT_EVENT_ID/actions/reject_refund \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"reason":"Reason"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.refund_rejected"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.paymentEvents.rejectRefund("PAYMENT_EVENT_ID", {
  reason: "Reason"
})

era payment_events reject_refund PAYMENT_EVENT_ID \
  --reason "Reason"

{
  "name": "era__finance__reject_refund",
  "arguments": {
    "requestId": "PAYMENT_EVENT_ID",
    "reason": "Reason"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:approve izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 refund_request_not_found, refund_request_resolved · 429 çok sık istek

finance.remove_discount

İndirimi kaldır — İndirimi kaldırır ve tutarı sözleşmeye geri ekler.

Gereken izin finance:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/finance.remove_discount

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: finance.discount_removed

Neye yazar: discount_line (delete) — Removes the discount; agreement (update) — Restores the total

curl -X POST https://app.getera.io/api/v1/discount_lines/DISCOUNT_LINE_ID/actions/remove_discount \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "finance.discount_removed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.discountLines.removeDiscount("DISCOUNT_LINE_ID")

era discount_lines remove_discount DISCOUNT_LINE_ID

{
  "name": "era__finance__remove_discount",
  "arguments": {
    "id": "DISCOUNT_LINE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde finance:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 discount_not_found, agreement_not_found, agreement_closed · 429 çok sık istek

finance.request_refund

İade talep et — Paranın geri gönderilmesini ister. Onay yetkisi olan biri evet diyene kadar hiçbir şey kıpırdamaz.