agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}
One invoice, with its lines, payments and payment link.
Ìfàṣẹ́pọ̀
Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.
Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí
Oju-iwọle yii nlo org_id gẹgẹbi ayẹwo ibeere. Fi silẹ ni ita yoo si bo igi iyalo rẹ lapapọ; ranṣẹ si lati dín ibeere naa kù si ajọ kan.
Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
invoiceId (path) | Uuid | Bẹẹni | — |
org_id (query) | Uuid | Bẹẹkọ | 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… |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
id | Uuid | Bẹẹni | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
number | string | Bẹẹkọ | The agency's own number. ⛔ Empty until issue: a number allocated to something that may never be sent leaves a hole in a sequence. |
status | string<draft, sent, partially_paid, paid, void> | Bẹẹni | — |
is_overdue | boolean | Bẹẹkọ | ⭐ DERIVED from the due date and the status, never stored — so there is no sweep to maintain a flag and nothing to go stale. A draft is never overdue however old it is: nobody ha… |
client_id | Uuid | Bẹẹkọ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_name | string | Bẹẹkọ | — |
currency | string | Bẹẹni | — |
issue_date | string | Bẹẹni | — |
due_date | string | Bẹẹkọ | — |
reference | string | Bẹẹkọ | — |
notes | string | Bẹẹkọ | — |
footer | string | Bẹẹkọ | — |
subtotal_minor | integer | Bẹẹkọ | — |
discount_minor | integer | Bẹẹkọ | — |
tax_minor | integer | Bẹẹkọ | — |
total_minor | integer | Bẹẹni | — |
amount_paid_minor | integer | Bẹẹkọ | — |
amount_due_minor | integer | Bẹẹkọ | — |
tax_breakdown | AgencyInvoiceTaxGroup[] | Bẹẹkọ | — |
source | string | Bẹẹkọ | Where the invoice came from — `time_tracking` when it was generated from tracked hours, empty when an agency typed it. |
sent_at | string | Bẹẹkọ | — |
last_sent_to | string | Bẹẹkọ | — |
paid_at | string | Bẹẹkọ | — |
void_reason | string | Bẹẹkọ | — |
created_at | string | Bẹẹkọ | — |
lines | AgencyInvoiceLine[] | Bẹẹkọ | — |
payments | AgencyInvoicePayment[] | Bẹẹkọ | — |
portal_url | string | Bẹẹkọ | The payment link to send to the client. ⛔ Returned on a SINGLE-invoice read only, never in a list: a list is the thing that gets logged, cached and pasted into a support ticket,… |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404 · 429