Create a receivable
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"
Body
- Option 1
- Option 2
- Option 3
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 The 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.
1Address 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.
50Address where goods were shipped / where services were provided.
Counterpart VAT ID id
The amount of tax deducted in minor units
0 <= x <= 9007199254740991A note with additional information about a tax deduction
List of deductions applied to the receivable (maximum 10 deductions allowed)
10The discount for a receivable.
The document number of the receivable, which will appear in the PDF document. Can be set manually only in the non-compliant mode. Otherwise (or if omitted), it will be generated automatically based on the entity's document number customization settings when the document is issued.
1 - 100"INV-0001"
"2024-027"
"CUST/2024/00027"
Settings for rendering documents in PDF format, including settings for line items and specific document types.
A base schemas for an entity
Entity bank account ID
Entity VAT ID id
The date (in ISO 8601 format) until which the quote is valid.
Optional text displayed below the line items table in the PDF.
A note with additional information for a receivable
Metadata for partner needs
A project related to current receivable
Link for custom quote accept page
1 - 65536Whether acceptance a quote requires a signature.
A list of IDs of user-defined tags (labels) assigned to this receivable.
Trade name of the entity
255Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not.
The reason for the VAT exemption, if applicable.
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 <= 10000Response
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.
Address information.
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.
The unique ID of a previous document related to the receivable if applicable.
The unique document ID of a previous document related to the receivable if applicable.
Field with a comment on why the client declined this Quote
The commercial terms of the receivable (e.g. The products must be delivered in X days).
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.
The amount of tax deducted in minor units
0 <= x <= 9007199254740991A note with additional information about a tax deduction
List of deductions applied to the receivable (maximum 10 deductions allowed)
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.
Optional field representing date until which invoice should be paid
E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if is_einvoice is true.
The entity user who created this document.
The date (in ISO 8601 format) until which the quote is valid.
Represents a file (such as a PDF invoice) that was uploaded to Monite.
The receivable's PDF URL in the counterpart's default language.
Optional text displayed below the line items table in the PDF.
Optional field for the issue of the entry.
A note with additional information for a receivable.
The receivable's PDF URL in the entity's default language.
Metadata for partner needs
A project related to current receivable
Link for custom quote accept page
1 - 65536Whether acceptance a quote requires a signature.
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 deduction amount of all deductions, 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
255Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not.
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