agency-invoicing
POST /v1/agency-invoicing/invoices/{invoiceId}/send
Email the invoice to your client, with the PDF attached.
ການພິສູດຕົວຕົນ
ສົ່ງລະຫັດ API ເປັນ bearer token. ລະຫັດຕ້ອງມີສິດ agency.invoicing.manage; ລະຫັດທີ່ບໍ່ມີສິດດັ່ງກ່າວຈະຖືກປະຕິເສດດ້ວຍລະຫັດ 403, ບໍ່ແມ່ນ 404.
ບ່ອນທີ່ລະບົບຈັດການອົງກອນຂອງທ່ານໄປ
ຈຸດສິ້ນສຸດນີ້ຮັບເອົາ org_id ເປັນພາຣາມິເຕີຄຳຖາມ. ຖ້າປະໄວ້ບໍ່ໃສ່ ການຮຽກຮ້ອງຈະກວມເອົາຊັບຕຣີການເຊົ່າທັງໝົດຂອງທ່ານ; ໃຫ້ສົ່ງມັນເພື່ອຈຳກັດການຮຽກຮ້ອງໃຫ້ແຄບລົງເຫຼືອພຽງອົງການດຽວ.
ລະຫັດອົງກອນຂອງທ່ານແມ່ນຢູ່ໜ້າກະແຈ API ໃນແຜງຄວບຄຸມຂອງທ່ານ, ຖັດຈາກກະແຈ itself. ມັນແມ່ນລະຫັດດຽວກັນໃນທຸກໆການໂທທີ່ທ່ານເຮັດ.
ລອງໃຊ້ເບິ່ງ
ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.
curl -X POST https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId}/send \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ເຂົ້າສູ່ລະບົບແລ້ວບໍ? ໂຄງສົນທະນາ API ໃນໜ້າັດສະຫຼອງຂອງທ່ານຈະຕື່ມຂໍ້ມູນລະຫັດອົງກອນຕົວຈິງ ແລະ ລະຫັດລັບສ່ວນຕົວຂອງທ່ານໂດຍອັດຕະໂນມັດ, ແລະ ປະຕິບັດການຮ້ອງຂໍຜ່ານ API ຕົວຈິງ ເພື່ອໃຫ້ທ່ານສາມາດເຫັນຜົນຕອບຮັບທີ່ແທ້ຈິງໄດ້. ເປີດຈຸດສິ້ນສຸດນີ້ໃນຄອນໂສລ API
ລາຍລະອຽດ
Issues it first if it is still a draft. Leaves on YOUR mail account when you have connected one, otherwise on ours with your address as Reply-To and a line saying who issued it. The PDF is attached as bytes rather than linked — a link would expire, and it would put our storage hostname in front of your client. Requires `agency.invoicing.manage`.
ພາຣາມິເຕີ
| ຊື່ | ປະເພດ | ຕ້ອງການ | ສິ່ງທີ່ມັນເປັນ |
|---|---|---|---|
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… |
ເນື້ອຫາຂອງຄຳຮ້ອງ
| ຊື່ | ປະເພດ | ຕ້ອງການ | ສິ່ງທີ່ມັນເປັນ |
|---|---|---|---|
to | string | ບໍ່ | Where to send it. Defaults to the client's stored email. |
locale | string | ບໍ່ | Which language to render in. Defaults to the client's locale — an agency in Berlin invoicing a French client sends a French invoice. |
note | string | ບໍ່ | A covering line to put above the amount. |
ຖືກໂຈະ
| ຊື່ | ປະເພດ | ຕ້ອງການ | ສິ່ງທີ່ມັນເປັນ |
|---|---|---|---|
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,… |
sent_to | string | ບໍ່ | — |
ຂໍ້ຜິດພາດທີ່ຈຸດເຊື່ອມຕໍ່ນີ້ສາມາດສົ່ງຄືນໄດ້
401 · 403 · 404 · 409 · 422 · 429 · 503