agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}
One invoice, with its lines, payments and payment link.
Tabbatar da Asali
Aiko da maɓallin API a matsayin bearer token. Wannan ma'anar ba ta bayyana takamaiman izini ba a cikin ƙayyadaddun bayanai, don haka ba wa maɓallin ku mafi ƙarancin abin da yake buƙata kuma ku bincika amsar maimakon yin zato.
Inda ID ɗin kungiyar ku ke zuwa
Wannan mahadar ta na daukar org_id a matsayin sigar tambaya. Bar shi kuma kiran zai shafi daukacin rukunin haya naka; aika shi don takaita kiran zuwa kungiya daya tak.
Ana samun lambar kungiyar ku a kan shafin maɓallan API a cikin madanninku, kusa da maɓallin kansa. Shi ne lambar da ta dace a kowane kiran da kuka yi.
Gwada
May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API
Sigogi
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
invoiceId (path) | Uuid | Eh | — |
org_id (query) | Uuid | A'a | 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… |
Martani
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
id | Uuid | Eh | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
number | string | A'a | 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> | Eh | — |
is_overdue | boolean | A'a | ⭐ 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 | A'a | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_name | string | A'a | — |
currency | string | Eh | — |
issue_date | string | Eh | — |
due_date | string | A'a | — |
reference | string | A'a | — |
notes | string | A'a | — |
footer | string | A'a | — |
subtotal_minor | integer | A'a | — |
discount_minor | integer | A'a | — |
tax_minor | integer | A'a | — |
total_minor | integer | Eh | — |
amount_paid_minor | integer | A'a | — |
amount_due_minor | integer | A'a | — |
tax_breakdown | AgencyInvoiceTaxGroup[] | A'a | — |
source | string | A'a | Where the invoice came from — `time_tracking` when it was generated from tracked hours, empty when an agency typed it. |
sent_at | string | A'a | — |
last_sent_to | string | A'a | — |
paid_at | string | A'a | — |
void_reason | string | A'a | — |
created_at | string | A'a | — |
lines | AgencyInvoiceLine[] | A'a | — |
payments | AgencyInvoicePayment[] | A'a | — |
portal_url | string | A'a | 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,… |
Kuskuren da wannan matsaya za ta iya maido wa
401 · 403 · 404 · 429