Mark an invoice as paid
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The ID of the entity that owns the requested resource.
"9d2b4c8f-2087-4738-ba91-7359683c49a4"
Path Parameters
Body
Response
Successful Response
- Option 1
- Option 2
- Option 3
Time at which the receivable was created. Timestamps follow the ISO 8601 standard.
Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.
Unique ID of the counterpart.
The type of the counterpart.
individual, organization The currency used in the receivable.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, SSP, SVC, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW A Response schema for an entity of organization type
- Option 1
- Option 2
A schema represents address info of the entity
The language of the customer-facing PDF file (file_url). The value matches the counterpart's language at the time when this PDF file was generated.
ab, aa, af, ak, sq, am, ar, an, hy, av, ae, ay, az, bm, ba, eu, be, bn, bi, bs, br, bg, my, ca, ch, ce, ny, zh, cu, cv, kw, co, cr, hr, cs, da, dv, nl, dz, en, eo, et, ee, fo, fj, fi, fr, fy, ff, gd, gl, lg, ka, de, el, kl, gn, gu, ht, ha, he, hz, hi, ho, hu, io, ig, id, ia, ie, iu, ik, ga, it, ja, jv, kn, kr, ks, kk, km, ki, rw, ky, kv, kg, ko, kj, ku, lo, la, lv, li, ln, lt, lu, lb, mk, mg, ms, ml, mt, gv, mi, mr, mh, mn, na, nv, nd, nr, ng, ne, no, nb, nn, ii, oc, oj, om, os, pi, ps, fa, pl, pt, pa, qu, ro, rm, rn, ru, se, sm, sg, sa, sc, sr, sn, sd, si, sk, sl, so, st, es, su, sw, ss, sv, tl, ty, tg, ta, tt, te, th, bo, ti, to, ts, tn, tr, tk, tw, ug, uk, ur, uz, ve, vi, vo, wa, cy, wo, xh, yi, yo, za, zu The language of the entity's copy of the PDF file (original_file_url). The value matches the entity's language at the time when this PDF file was generated.
ab, aa, af, ak, sq, am, ar, an, hy, av, ae, ay, az, bm, ba, eu, be, bn, bi, bs, br, bg, my, ca, ch, ce, ny, zh, cu, cv, kw, co, cr, hr, cs, da, dv, nl, dz, en, eo, et, ee, fo, fj, fi, fr, fy, ff, gd, gl, lg, ka, de, el, kl, gn, gu, ht, ha, he, hz, hi, ho, hu, io, ig, id, ia, ie, iu, ik, ga, it, ja, jv, kn, kr, ks, kk, km, ki, rw, ky, kv, kg, ko, kj, ku, lo, la, lv, li, ln, lt, lu, lb, mk, mg, ms, ml, mt, gv, mi, mr, mh, mn, na, nv, nd, nr, ng, ne, no, nb, nn, ii, oc, oj, om, os, pi, ps, fa, pl, pt, pa, qu, ro, rm, rn, ru, se, sm, sg, sa, sc, sr, sn, sd, si, sk, sl, so, st, es, su, sw, ss, sv, tl, ty, tg, ta, tt, te, th, bo, ti, to, ts, tn, tr, tk, tw, ug, uk, ur, uz, ve, vi, vo, wa, cy, wo, xh, yi, yo, za, zu The status of the Quote inside the receivable workflow.
draft, issued, accepted, expired, declined The total VAT of all line items, in minor units.
x <= 9007199254740991The type of the document uploaded.
quote List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated.
Unused. Always returns null.
Unused. Always returns null.
Field with a comment on why the client declined this Quote
Additional terms and conditions for the receivable. For example, the return or cancellation policy. If defined, this text is displayed in the "Terms and conditions" section in the PDF.
This is different from payment terms which are defined using payment_terms or payment_terms_id.
See also: memo, footer.
Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company.
Different types of companies for different countries, ex. GmbH, SAS, SNC, etc.
50Additional information about counterpart contacts.
The external reference of the counterpart.
A legal name of a counterpart it is an organization or first and last name if it is an individual
Address where goods were shipped / where services were provided.
The VAT/TAX ID of the counterpart.
Deprecated and mutually exclusive with deductions.
Specifies the amount (in minor units) of a special deduction or incentive that is applied to the total after VAT.
The default PDF label for deductions is "Incentives", but can be changed via the partner setting receivable.deduction_title.
0 <= x <= 90071992547409911500
Deprecated and mutually exclusive with deductions.
A note with additional information about the deduction. It is displayed below the deduction line in the PDF.
A list of deductions and incentives to be applied after VAT. This is different from discounts which are applied before VAT.
The deductions field is mutually exclusive with the deprecated deduction_amount and deduction_memo fields.
10The discount for a receivable.
Total price of the receivable with discounts before taxes minor units.
x <= 9007199254740991The sequential code systematically assigned to invoices.
Settings for rendering documents in PDF format, including settings for line items and specific document types.
Unused. The expiration date of a quote is specified by expiry_date instead.
Unused. Always returns null.
The entity user who created this document.
The date (in ISO 8601 format) until which the quote is valid.
The receivable's PDF URL in the counterpart's default language.
Optional text displayed below the line items table in the PDF. See also: memo, commercial_condition_description.
Optional field for the issue of the entry.
An optional note for the customer, displayed above the line items table in the PDF. See also: footer, commercial_condition_description.
The receivable's PDF URL in the entity's default language.
Metadata for partner needs
Link for custom quote accept page
1 - 65536Whether the counterpart's signature is required to accept this quote.
The subtotal (excluding VAT), in minor units.
x <= 9007199254740991The subtotal including VAT but without invoice discount, in minor units.
x <= 9007199254740991The list of tags for this receivable.
Total price of the receivable in minor units. Calculated as a subtotal + total_vat_amount.
x <= 9007199254740991The total amount of all deductions that are applied after VAT, in minor units.
x <= 9007199254740991List of total vat amount for each VAT, presented in receivable
Total price of the receivable with tax withheld in minor units
Trade name of the entity
255Unused. To indicate that a line item is non-taxable or exempt from tax, use the tax_status field of that line item.
The reason for the VAT exemption, if applicable.
Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount.
exclusive, inclusive Defines whether the prices of products in receivable will already include VAT or not.
exclusive, inclusive The amount of tax withheld in percent minor units
0 <= x <= 10000