Hisobdan chiqarishni rad etish

PUT

/v2/write-off/cancel/{id}

curl --request PUT \
  --url 'https://api-admin.billz.ai/v2/write-off/cancel/example?Billz-Response-Channel=HTTP' \
  --header 'Authorization: Bearer <token>' \
  --header 'Billz-Response-Channel: HTTP' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

• Production

Asinxron metod. Natijani HTTP orqali sinxron olish uchun Billz-Response-Channel: HTTP sarlavhasini yuboring — aks holda javob 200 {"message": "<correlation_id>"} bo’ladi. Maksimal kutish vaqti — 600 soniya, so’ngra error.code = TIMEOUT bilan 408.

Xato kodlari: 404 — obyekt topilmadi; 408 — asinxron javobni kutish taym-auti; 401, 403, 429, 500 — barcha metodlar uchun umumiy. Tana formatlari va semantikasi: Javob kodlari va xatolar.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Yo’ldan olinadi

Header Parameters

platform-id

string

default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platforma identifikatori. Integratsiyalar uchun statik qiymat ishlatiladi.

Billz-Response-Channel

string

Allowed values: HTTP

HTTP — hodisani qayta ishlash natijasini kutib, uni HTTP javobida qaytarish. Sarlavhasiz metod faqat e’lon qilingan hodisaning correlation_id sini qaytaradi.

Query Parameters

Billz-Response-Channel

string

Allowed values: HTTP

Billz-Response-Channel sarlavhasi bilan bir xil — o’z sarlavhasini yubora olmaydigan mijozlar uchun. Ikkalasi ham uzatilsa, sarlavha amal qiladi.

Responses

200

Muvaffaqiyat. Billz-Response-Channel: HTTP sarlavhasi bilan — asinxron javob konverti, usiz — {"message": "<correlation_id>"}.

Media typeapplication/json

One of:

object

Asinxron javob konverti. Billz-Response-Channel: HTTP sarlavhasi uzatilganda qaytariladi. So’rovning yakuniy HTTP kodi status_code maydonidan olinadi.

object

session_id

Mijoz sessiyasi identifikatori

string format: uuid

status_code

Hodisani qayta ishlash holati (u yakuniy HTTP javob kodi hamdir)

integer

error

object

code

Xato kodi, xato bo’lmasa bo’sh satr

string

message

Xato matni, xato bo’lmasa — bo’sh satr

string

correlation_id

So’rov identifikatori, e’lon qilingan hodisa ID si bilan mos keladi

string format: uuid

topic

Javob hodisasining turi, masalan <event_type>.success

string

data

Operatsiya natijasi, agar metod uni qaytarsa

object

object

Billz-Response-Channel sarlavhasisiz asinxron metod javobi — hodisa e’lon qilindi.

object

message

E’lon qilingan hodisaning correlation_id si

string format: uuid

object

object

message

string

status_code

integer format: int32

id

string

error

object

code

string

message

string

data

string

correlation_id

string

topic

string

session_id

string

company_id

string

Example^generated

{
  "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status_code": 1,
  "error": {
    "code": "example",
    "message": "example"
  },
  "correlation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "topic": "example",
  "data": {}
}