agency-invoicing
GET /v1/agency-invoicing/portal/{token}
The invoice, for the person paying it. Unauthenticated.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/portal/{token}ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔ **No authentication.** The payer is the agency's client and has no account here; the token in the URL is the whole authorisation and reaches exactly one invoice. A revoked, void or draft link answers `404`, the same as a wrong token — telling them apart would confirm to a stranger that a token is real.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
token (path) | string | はい | The capability token from the payment link on the invoice. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
number | string | はい | — |
status | string | はい | — |
currency | string | はい | — |
issue_date | string | いいえ | — |
due_date | string | いいえ | — |
seller | object | いいえ | The issuing agency, frozen at issue. |
buyer | object | いいえ | — |
lines | object[] | いいえ | — |
tax_groups | object[] | いいえ | — |
subtotal | string | いいえ | — |
tax_total | string | いいえ | — |
total | string | はい | — |
amount_due | string | いいえ | — |
amount_due_minor | integer | はい | — |
labels | object | いいえ | Every label on the page, already in the client's language. ⛔ Served from the platform's translation catalogue rather than a gettext call: this engine has no `.po` files, so `get… |
direction | string<ltr, rtl> | いいえ | — |
notes | string | いいえ | — |
offline | object | いいえ | How to pay when the agency has connected no gateway — their own written payment instructions and contact address, frozen onto the document. ⭐ A payment page that offered nothing… |
このエンドポイントが返すエラー
404 · 429