agency-time

POST /v1/agency/time/checkout-bills/{billId}/send

E-mail a checkout bill raised from tracked time.

Բոլոր agency-time վերջնակետերը

Բոլոր մշակողների փաստաթղթերը

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա agency.time.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

curl -X POST https://api.zinndigital.com/v1/agency/time/checkout-bills/{billId}/send \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

Mails the pay link to the client, then marks the bill sent — in that order, so a bill is never shown as sent that did not leave. Only a bill time tracking raised; requires agency.time.manage and the billing.entitlement.manage staff permission (docs/670 §3).

Պարամետրեր

ԱնունՏեսակՊահանջվում էԻնչ է դա
billId (path)stringԱյո

Հարցման մարմին

ԱնունՏեսակՊահանջվում էԻնչ է դա
org_idstringՈչ

Պատասխան

ԱնունՏեսակՊահանջվում էԻնչ է դա
idstringԱյո
referencestringԱյո
statusstring<draft, sent, paid, void>Այո
currencystringԱյո
subtotal_minorintegerԱյո
tax_minorintegerԱյո
total_minorintegerԱյո
recipient_emailstringՈչ
recipient_countrystringՈչ
sent_atstringՈչ
paid_atstringՈչ
voided_atstringՈչ
pay_urlstringԱյոThe public page the recipient pays this bill on.

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 404 · 422 · 503