agency-invoicing

PATCH `/v1/agency-invoicing/clients/{clientId}`

Change a client's details.

agency-invoicing အားလုံးသော အဆုံးသတ်များ

စစ်မှန်ကြောင်း အတည်ပြုခြင်း

API သော့တစ်ခုကို bearer token အဖြစ် ပေးပို့ပါ။ ဤ အမှတ်အသားအဆုံး (endpoint) သည် သတ်မှတ်ချက်တွင် တိကျသော ခွင့်ပြုချက်တစ်ခုကို မဖော်ပြထားပါသဖြင့်၊ သင့်သော့ကို အနည်းဆုံး လိုအပ်သည်များသာ ပေးအပ်ပြီး မူလအခြေအနေကို ယူဆမည့်အစား တုံ့ပြန်မှုကို စစ်ဆေးပါ။

သင့်အဖွဲ့အစည်း၏ id ထည့်သွင်းရမည့်နေရာ

ဤအစွန်အဖျား (endpoint) သည် org_id ကို မေးမြန်းချက် ကန့်သတ်ဘောင် (query parameter) အဖြစ် လက်ခံပါသည်။ ၎င်းကို ချန်လှပ်ထားပါက ခေါ်ဆိုမှုသည် သင်၏ ငှားရမ်းမှု လက်အောက်ခံသစ်ပင် (tenancy subtree) တစ်ခုလုံးကို လွှမ်းခြုံမည်ဖြစ်ပြီး၊ အဖွဲ့အစည်းတစ်ခုတည်းသို့ ကန့်သတ်ခေါ်ဆိုရန် ၎င်းကို ပေးပို့ပါ။

သင့်အဖွဲ့အစည်း id သည် သင်၏ ဒက်ရှ်ဘုတ်ရှိ API သော့များ မျက်နှာပြင်တွင်၊ သော့၏ ဘေး၌ ရှိပါသည်။ ၎င်းသည် သင်ပြုလုပ်သည့် ခေါ်ဆိုမှုတိုင်းတွင် တူညီသော id ဖြစ်ပါသည်။

စမ်းကြည့်ရန်

ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

ဝင်ရောက်ပြီးပြီလား။ သင့်ဒက်ရှ်ဘုတ်ရှိ API ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို API ကွန်ဆိုးလ်တွင် ဖွင့်ပါ

ကန့်သတ်ဘောင်များ

နာမည်	အမျိုးအစား	လိုအပ်သည်	ဘာလဲဆိုတာ
`clientId (path)`	`Uuid`	ဟုတ်ကဲ့	—
`org_id (query)`	`Uuid`	မဟုတ်ပါ	Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded…

တောင်းဆိုချက် ကိုယ်ထည်

နာမည်	အမျိုးအစား	လိုအပ်သည်	ဘာလဲဆိုတာ
`name`	`string`	မဟုတ်ပါ	—
`contact_name`	`string`	မဟုတ်ပါ	—
`email`	`string`	မဟုတ်ပါ	—
`phone`	`string`	မဟုတ်ပါ	—
`address`	`string`	မဟုတ်ပါ	—
`tax_number_label`	`string`	မဟုတ်ပါ	—
`tax_number`	`string`	မဟုတ်ပါ	—
`currency`	`string`	မဟုတ်ပါ	—
`country`	`string`	မဟုတ်ပါ	Two-letter ISO code, or empty or null to clear. Anything else is refused.
`locale`	`string`	မဟုတ်ပါ	—
`notes`	`string`	မဟုတ်ပါ	—
`archived`	`boolean`	မဟုတ်ပါ	—

တုံ့ပြန်ချက်

နာမည်	အမျိုးအစား	လိုအပ်သည်	ဘာလဲဆိုတာ
`id`	`Uuid`	ဟုတ်ကဲ့	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	ဟုတ်ကဲ့	—
`contact_name`	`string`	မဟုတ်ပါ	—
`email`	`string`	မဟုတ်ပါ	—
`phone`	`string`	မဟုတ်ပါ	—
`address`	`string`	မဟုတ်ပါ	—
`tax_number_label`	`string`	မဟုတ်ပါ	—
`tax_number`	`string`	မဟုတ်ပါ	—
`currency`	`string`	ဟုတ်ကဲ့	—
`country`	`string`	မဟုတ်ပါ	ISO-3166-1 alpha-2, optional. Required only to bill this client on Zinn®'s own checkout (the platform organisation, docs/670 §3), where the country decides the VAT on the bill and…
`locale`	`string`	မဟုတ်ပါ	Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice.
`notes`	`string`	မဟုတ်ပါ	—
`archived`	`boolean`	မဟုတ်ပါ	—
`created_at`	`string`	မဟုတ်ပါ	—

ဤအမှတ်ဆက်မှ ပြန်ပေးနိုင်သော အမှားများ

401 · 403 · 404 · 422 · 429

PATCH /v1/agency-invoicing/clients/{clientId}