Vergi API

Ülkeye ve ürün tipine göre vergi oranları; her satışa uygulanır.

Modül kodu tax · 7 işlem · 4 veri modeli · 4 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ı: tax (hepsi), tax:read (yalnız okuma) ya da tax:<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

tax.archive_class

Vergi sınıfını arşivle — Bir sınıfı, fiyatlandırdığı belgeleri değiştirmeden kullanımdan kaldırır.

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

• Asıl adres: POST /api/v1/actions/tax.archive_class

Girdi

Ön koşullar

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

Yayımladığı olaylar: tax.class_archived

Neye yazar: tax_class (update) — Archives or restores it

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

{
  "ok": true,
  "result": "…",
  "events": [
    "tax.class_archived"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.taxClasses.archiveClass("TAX_CLASSE_ID", {
  archived: true
})

era tax_classes archive_class TAX_CLASSE_ID \
  --archived true

{
  "name": "era__tax__archive_class",
  "arguments": {
    "id": "TAX_CLASSE_ID",
    "archived": true
  }
}

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

tax.remove_country_exception

Ülke istisnasını kaldır — Ülke ait olduğu yapılandırmaya geri döner.

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

• Asıl adres: POST /api/v1/actions/tax.remove_country_exception

Girdi

Ön koşullar

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

Yayımladığı olaylar: tax.configuration_changed

Neye yazar: tax_configuration_country (delete) — Removes the exception

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

{
  "ok": true,
  "result": "…",
  "events": [
    "tax.configuration_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.taxConfigurationCountries.removeCountryException("TAX_CONFIGURATION_COUNTRY_ID")

era tax_configuration_countries remove_country_exception TAX_CONFIGURATION_COUNTRY_ID

{
  "name": "era__tax__remove_country_exception",
  "arguments": {
    "id": "TAX_CONFIGURATION_COUNTRY_ID"
  }
}

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

tax.remove_rate

Vergi oranını kaldır — Bir ülke oranını kaldırır. Fiyatlandırılmış belgeler kopyalarını korur.

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

• Asıl adres: POST /api/v1/actions/tax.remove_rate

Girdi

Ön koşullar

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

Yayımladığı olaylar: tax.rate_changed

Neye yazar: tax_rate (delete) — Removes the rate

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

{
  "ok": true,
  "result": "…",
  "events": [
    "tax.rate_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.taxRates.removeRate("TAX_RATE_ID")

era tax_rates remove_rate TAX_RATE_ID

{
  "name": "era__tax__remove_rate",
  "arguments": {
    "id": "TAX_RATE_ID"
  }
}

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

tax.save_class

Vergi sınıfını kaydet — Bir vergi sınıfı oluşturur veya yeniden adlandırır — bir fiyatın hangi kategoride vergilendirildiği.

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

• Asıl adres: POST /api/v1/actions/tax.save_class

Girdi

Ön koşullar

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

Yayımladığı olaylar: tax.class_saved

Neye yazar: tax_class (upsert) — Writes the class

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

{
  "ok": true,
  "result": "…",
  "events": [
    "tax.class_saved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.taxClasses.saveClass("TAX_CLASSE_ID", {
  name: "Name"
})

era tax_classes save_class TAX_CLASSE_ID \
  --name "Name"

{
  "name": "era__tax__save_class",
  "arguments": {
    "id": "TAX_CLASSE_ID",
    "name": "Name"
  }
}

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

tax.save_configuration

Vergi yapılandırmasını kaydet — Verginin alınıp alınmayacağı ve nasıl alınacağı — çalışma alanı için ya da tek bir satış kanalı için.

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

• Asıl adres: POST /api/v1/actions/tax.save_configuration

Girdi

Ön koşullar

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

Yayımladığı olaylar: tax.configuration_changed

Neye yazar: tax_configuration (upsert) — Writes the configuration

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

{
  "ok": true,
  "result": "…",
  "events": [
    "tax.configuration_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.taxConfigurations.saveConfiguration({
  chargeTaxes: true
})

era tax_configurations save_configuration \
  --charge-taxes true

{
  "name": "era__tax__save_configuration",
  "arguments": {
    "chargeTaxes": true
  }
}

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

tax.set_country_exception

Ülke istisnası belirle — Tek bir ülke için yapılandırmayı geçersiz kılar.

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

• Asıl adres: POST /api/v1/actions/tax.set_country_exception

Girdi

Ön koşullar

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

Yayımladığı olaylar: tax.configuration_changed

Neye yazar: tax_configuration_country (upsert) — Writes the exception

curl -X POST https://app.getera.io/api/v1/tax_configuration_countries/actions/set_country_exception \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"configurationId":"TAX_CONFIGURATION_ID","country":"Country","chargeTaxes":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "tax.configuration_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.taxConfigurationCountries.setCountryException({
  configurationId: "TAX_CONFIGURATION_ID",
  country: "Country",
  chargeTaxes: true
})

era tax_configuration_countries set_country_exception \
  --configuration-id "TAX_CONFIGURATION_ID" \
  --country "Country" \
  --charge-taxes true

{
  "name": "era__tax__set_country_exception",
  "arguments": {
    "configurationId": "TAX_CONFIGURATION_ID",
    "country": "Country",
    "chargeTaxes": true
  }
}

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

tax.set_rate

Vergi oranı belirle — Bir ülkenin oranı — bir sınıf için ya da sınıf verilmezse ülke varsayılanı.

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

• Asıl adres: POST /api/v1/actions/tax.set_rate

Girdi

Ön koşullar

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

Yayımladığı olaylar: tax.rate_changed

Neye yazar: tax_rate (upsert) — Writes the rate

curl -X POST https://app.getera.io/api/v1/tax_rates/actions/set_rate \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"country":"Country","rate":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "tax.rate_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.taxRates.setRate({
  country: "Country",
  rate: 1
})

era tax_rates set_rate \
  --country "Country" \
  --rate 1

{
  "name": "era__tax__set_rate",
  "arguments": {
    "country": "Country",
    "rate": 1
  }
}

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

Veri modelleri

TaxClass

Tablo tax_class · Kaynak tax_classes

• GET /api/v1/tax_classes
• GET /api/v1/tax_classes/{id}

Birincil anahtar: id

Denetimler:

• CHECK ((length(TRIM(BOTH FROM name)) > 0))

TaxConfigurationCountry

Tablo tax_configuration_country · Kaynak tax_configuration_countries

• GET /api/v1/tax_configuration_countries
• GET /api/v1/tax_configuration_countries/{id}

Birincil anahtar: id

Tekil: tax_configuration_id, country

Denetimler:

• CHECK (((calculation_strategy IS NULL) OR (calculation_strategy = ANY (ARRAY['flat_rates'::text, 'tax_app'::text]))))
• CHECK ((country ~ '^[A-Z]{2}$'::text))

TaxConfiguration

Tablo tax_configuration · Kaynak tax_configurations

• GET /api/v1/tax_configurations
• GET /api/v1/tax_configurations/{id}

Birincil anahtar: id

Denetimler:

• CHECK (((calculation_strategy <> 'tax_app'::text) OR (tax_app_id IS NOT NULL)))

TaxRate

Tablo tax_rate · Kaynak tax_rates

• GET /api/v1/tax_rates
• GET /api/v1/tax_rates/{id}

Birincil anahtar: id

Denetimler:

• CHECK ((country ~ '^[A-Z]{2}$'::text))
• CHECK (((rate >= (0)::numeric) AND (rate <= (100)::numeric)))

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.