agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}
One invoice, with its lines, payments and payment link.
அங்கீகாரம்
ஒரு பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். இந்த எண்ட்பாயிண்ட் அதன் விவரக்குறிப்பில் குறிப்பிட்ட அனுமதியைக் குறிப்பிடவில்லை, எனவே அனுமானங்களைச் செய்வதற்குப் பதிலாக, உங்கள் விசைக்குத் தேவையான குறைந்தபட்ச அனுமதியை வழங்கவும் மற்றும் பதிலைச் சரிபார்க்கவும்.
உங்கள் அமைப்பு ஐடி எங்கு செல்ல வேண்டும்
இந்த எண்ட் பாயிண்ட் org_id என்பதை வினவல் அளபுருவாக (query parameter) எடுத்துக்கொள்கிறது. இதை விட்டுவிட்டால், அழைப்பு உங்கள் முழு டெனன்சி துணை மரத்தையும் (tenancy subtree) உள்ளடக்கும்; ஒரு நிறுவனத்திற்கு மட்டுமே அழைப்பைக் சுருக்க இதை அனுப்பவும்.
உங்கள் நிறுவன ஐடி உங்கள் டாஷ்போர்டில் உள்ள API விசைகள் திரையில், விசைக்கு அருகிலேயே உள்ளது. நீங்கள் செய்யும் ஒவ்வொரு அழைப்பிலும் இதுவே ஒரே ஐடி ஆகும்.
முயன்று பார்
கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…"உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்
அளவுருக்கள்
| பெயர் | வகை | தேவைப்படுகிறது | அது என்ன |
|---|---|---|---|
invoiceId (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… |
பதில்
| பெயர் | வகை | தேவைப்படுகிறது | அது என்ன |
|---|---|---|---|
id | Uuid | ஆம் | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
number | string | இல்லை | 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> | ஆம் | — |
is_overdue | boolean | இல்லை | ⭐ 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 | இல்லை | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_name | string | இல்லை | — |
currency | string | ஆம் | — |
issue_date | string | ஆம் | — |
due_date | string | இல்லை | — |
reference | string | இல்லை | — |
notes | string | இல்லை | — |
footer | string | இல்லை | — |
subtotal_minor | integer | இல்லை | — |
discount_minor | integer | இல்லை | — |
tax_minor | integer | இல்லை | — |
total_minor | integer | ஆம் | — |
amount_paid_minor | integer | இல்லை | — |
amount_due_minor | integer | இல்லை | — |
tax_breakdown | AgencyInvoiceTaxGroup[] | இல்லை | — |
source | string | இல்லை | Where the invoice came from — `time_tracking` when it was generated from tracked hours, empty when an agency typed it. |
sent_at | string | இல்லை | — |
last_sent_to | string | இல்லை | — |
paid_at | string | இல்லை | — |
void_reason | string | இல்லை | — |
created_at | string | இல்லை | — |
lines | AgencyInvoiceLine[] | இல்லை | — |
payments | AgencyInvoicePayment[] | இல்லை | — |
portal_url | string | இல்லை | 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,… |
இந்த எண்ட்ஸ்பாயிண்ட் திரும்ப அனுப்பக்கூடிய பிழைகள்
401 · 403 · 404 · 429