Skip to main content
PATCH
/
receivables
/
{receivable_id}
Update a receivable
curl --request PATCH \
  --url https://api.sandbox.monite.com/v1/receivables/{receivable_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "quote": {
    "attachments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "include_in_email": false
      }
    ],
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "counterpart_billing_address": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "postal_code": "10115",
      "line2": "<string>",
      "state": "<string>"
    },
    "counterpart_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "counterpart_shipping_address": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "postal_code": "10115",
      "line2": "<string>",
      "state": "<string>"
    },
    "counterpart_vat_id_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "AED",
    "deduction_amount": 4503599627370495,
    "deduction_memo": "<string>",
    "deductions": [
      {
        "amount": 4503599627370495,
        "name": "<string>",
        "memo": "<string>"
      }
    ],
    "discount": {
      "amount": 4503599627370495,
      "type": "amount"
    },
    "document_id": "<string>",
    "document_rendering": {
      "credit_note": {
        "display_entity_bank_account": true
      },
      "display_entity_bank_account": true,
      "display_line_items": true,
      "invoice": {
        "display_entity_bank_account": true
      },
      "line_items": {
        "discount": {
          "display": true,
          "label": "<string>"
        },
        "measure_unit": {
          "display": true,
          "label": "<string>"
        },
        "name": {
          "display": true,
          "label": "<string>"
        },
        "price": {
          "display": true,
          "label": "<string>",
          "precision": 3
        },
        "price_after_vat": {
          "display": true,
          "label": "<string>",
          "precision": 3
        },
        "quantity": {
          "display": true,
          "label": "<string>"
        },
        "total_price": {
          "display": true,
          "label": "<string>",
          "precision": 3
        },
        "total_price_after_vat": {
          "display": true,
          "label": "<string>",
          "precision": 3
        },
        "vat_amount": {
          "display": false
        },
        "vat_rate": {
          "display": true,
          "label": "<string>",
          "precision": 3
        }
      },
      "quote": {
        "display_entity_bank_account": true,
        "display_signature": false
      }
    },
    "due_date": "2023-12-25",
    "entity": {
      "email": "jsmith@example.com",
      "logo": "<string>",
      "phone": "<string>",
      "registration_authority": "<string>",
      "registration_number": "<string>",
      "website": "<string>"
    },
    "entity_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_vat_id_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expiry_date": "2023-12-25",
    "footer": "<string>",
    "line_items": [
      {
        "discount": {
          "amount": 4503599627370495,
          "type": "amount"
        },
        "price": 4503599627370495,
        "quantity": 1073741823.5,
        "tax_rate_name": "<string>",
        "tax_status": "taxable",
        "vat_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "memo": "<string>",
    "partner_metadata": {},
    "payment_terms": {
      "term_final": {
        "end_date": "2023-12-25",
        "number_of_days": 5000
      },
      "term_1": {
        "discount": 5000,
        "end_date": "2023-12-25",
        "number_of_days": 5000
      },
      "term_2": {
        "discount": 5000,
        "end_date": "2023-12-25",
        "number_of_days": 5000
      }
    },
    "payment_terms_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quote_accept_page_url": "<string>",
    "signature_required": true,
    "tag_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "trade_name": "<string>",
    "vat_exempt": true,
    "vat_exemption_rationale": "<string>",
    "withholding_tax_rate": 5000
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "counterpart_address": {
    "city": "Berlin",
    "country": "DE",
    "line1": "Flughafenstrasse 52",
    "postal_code": "10115",
    "line2": "<string>",
    "state": "<string>"
  },
  "counterpart_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "counterpart_type": "individual",
  "currency": "AED",
  "entity": {
    "name": "<string>",
    "type": "organization",
    "email": "jsmith@example.com",
    "logo": "<string>",
    "phone": "<string>",
    "registration_authority": "<string>",
    "registration_number": "<string>",
    "tax_id": "<string>",
    "vat_id": "<string>",
    "website": "<string>"
  },
  "entity_address": {
    "city": "<string>",
    "line1": "<string>",
    "postal_code": "<string>",
    "country": "DE",
    "line2": "<string>",
    "state": "<string>"
  },
  "file_language": "ab",
  "line_items": [
    {
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "price": {
          "currency": "AED",
          "value": 4503599627370495
        },
        "price_after_vat": {
          "currency": "AED",
          "value": 4503599627370495
        },
        "vat_rate": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "country": "DE",
          "value": 5000,
          "components": [
            {
              "name": "<string>",
              "value": 5000
            }
          ],
          "created_by": "monite",
          "status": "active",
          "valid_from": "2023-12-25",
          "valid_until": "2023-12-25"
        },
        "accounting_tax_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_reference": "<string>",
        "is_inline": false,
        "ledger_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "measure_unit": {
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>"
        },
        "measure_unit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "smallest_amount": 1073741823.5,
        "type": "product"
      },
      "quantity": 1073741823.5,
      "total_after_vat": 123,
      "total_before_vat": 123,
      "discount": {
        "amount": 4503599627370495,
        "type": "amount"
      },
      "tax_status": "taxable"
    }
  ],
  "original_file_language": "ab",
  "status": "draft",
  "total_vat_amount": 123,
  "type": "quote",
  "attachments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mimetype": "<string>",
      "name": "<string>",
      "size": 123,
      "url": "<string>",
      "include_in_email": false
    }
  ],
  "based_on": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "based_on_document_id": "<string>",
  "comment": "<string>",
  "commercial_condition_description": "<string>",
  "counterpart_billing_address": {
    "city": "Berlin",
    "country": "DE",
    "line1": "Flughafenstrasse 52",
    "postal_code": "10115",
    "line2": "<string>",
    "state": "<string>"
  },
  "counterpart_business_type": "<string>",
  "counterpart_contact": {
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "postal_code": "10115",
      "line2": "<string>",
      "state": "<string>"
    },
    "first_name": "Marge",
    "last_name": "Smith",
    "email": "marge@example.org",
    "phone": "55512378654",
    "title": "Dr."
  },
  "counterpart_external_reference": "<string>",
  "counterpart_name": "<string>",
  "counterpart_shipping_address": {
    "city": "Berlin",
    "country": "DE",
    "line1": "Flughafenstrasse 52",
    "postal_code": "10115",
    "line2": "<string>",
    "state": "<string>"
  },
  "counterpart_tax_id": "<string>",
  "counterpart_vat_id": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "counterpart_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "value": "123456789",
    "country": "AF",
    "type": "eu_vat"
  },
  "deduction_amount": 4503599627370495,
  "deduction_memo": "<string>",
  "deductions": [
    {
      "amount": 4503599627370495,
      "name": "<string>",
      "memo": "<string>"
    }
  ],
  "discount": {
    "amount": 4503599627370495,
    "type": "amount",
    "value": 4503599627370495
  },
  "discounted_subtotal": 123,
  "document_id": "<string>",
  "document_rendering": {
    "credit_note": {
      "display_entity_bank_account": true
    },
    "display_entity_bank_account": true,
    "display_line_items": true,
    "invoice": {
      "display_entity_bank_account": true
    },
    "line_items": {
      "discount": {
        "display": true,
        "label": "<string>"
      },
      "measure_unit": {
        "display": true,
        "label": "<string>"
      },
      "name": {
        "display": true,
        "label": "<string>"
      },
      "price": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "price_after_vat": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "quantity": {
        "display": true,
        "label": "<string>"
      },
      "total_price": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "total_price_after_vat": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "vat_amount": {
        "display": false
      },
      "vat_rate": {
        "display": true,
        "label": "<string>",
        "precision": 3
      }
    },
    "quote": {
      "display_entity_bank_account": true,
      "display_signature": false
    }
  },
  "due_date": "2023-12-25",
  "einvoice_file_url": "<string>",
  "entity_bank_account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_holder_name": "<string>",
    "account_number": "<string>",
    "bank_name": "<string>",
    "bic": "<string>",
    "country": "AF",
    "currency": "AED",
    "display_name": "<string>",
    "iban": "<string>",
    "is_default": false,
    "routing_number": "<string>",
    "sort_code": "<string>",
    "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity_vat_id": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "country": "AF",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "value": "123456789",
    "type": "eu_vat"
  },
  "expiry_date": "2023-12-25",
  "file": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "file_type": "payables",
    "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
    "mimetype": "application/pdf",
    "name": "invoice.pdf",
    "region": "eu-central-1",
    "size": 24381,
    "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
    "pages": [],
    "previews": []
  },
  "file_url": "<string>",
  "footer": "<string>",
  "issue_date": "2023-11-07T05:31:56Z",
  "memo": "<string>",
  "original_file_url": "<string>",
  "partner_metadata": {},
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quote_accept_page_url": "<string>",
  "signature_required": true,
  "subtotal": 123,
  "subtotal_after_vat": 123,
  "tags": [],
  "total_amount": 0,
  "total_deduction_amount": 123,
  "total_vat_amounts": [
    {
      "amount": 4503599627370495,
      "taxable_amount": 1,
      "value": 5000,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "components": [
        {
          "amount": 4503599627370495,
          "name": "<string>",
          "value": 5000
        }
      ],
      "name": "<string>"
    }
  ],
  "total_withholding_tax": 123,
  "trade_name": "<string>",
  "vat_exempt": true,
  "vat_exemption_rationale": "<string>",
  "vat_inclusive_discount_mode": "exclusive",
  "vat_mode": "exclusive",
  "withholding_tax_rate": 5000
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

receivable_id
string<uuid>
required

Body

application/json
quote
object
required

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required

Time at which the receivable was created. Timestamps follow the ISO 8601 standard.

updated_at
string<date-time>
required

Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.

counterpart_address
object
required

Address information.

counterpart_id
string<uuid>
required

Unique ID of the counterpart.

counterpart_type
enum<string>
required

The type of the counterpart.

Available options:
individual,
organization
currency
enum<string>
required

The currency used in the receivable.

Available options:
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
entity
object
required

A Response schema for an entity of organization type

entity_address
object
required

A schema represents address info of the entity

file_language
enum<string>
required

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.

Available options:
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
line_items
object[]
required
original_file_language
enum<string>
required

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.

Available options:
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
status
enum<string>
required

The status of the Quote inside the receivable workflow.

Available options:
draft,
issued,
accepted,
expired,
declined
total_vat_amount
integer
required

The total VAT of all line items, in minor units.

Required range: x <= 9007199254740991
type
enum<string>
required

The type of the document uploaded.

Available options:
quote
attachments
object[]

List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated.

based_on
string<uuid>

The unique ID of a previous document related to the receivable if applicable.

based_on_document_id
string

The unique document ID of a previous document related to the receivable if applicable.

comment
string

Field with a comment on why the client declined this Quote

commercial_condition_description
string

The commercial terms of the receivable (e.g. The products must be delivered in X days).

counterpart_billing_address
object

Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company.

counterpart_business_type
string

Different types of companies for different countries, ex. GmbH, SAS, SNC, etc.

Maximum string length: 50
counterpart_contact
object

Additional information about counterpart contacts.

counterpart_external_reference
string

The external reference of the counterpart.

counterpart_name
string

A legal name of a counterpart it is an organization or first and last name if it is an individual

counterpart_shipping_address
object

Address where goods were shipped / where services were provided.

counterpart_tax_id
string

The VAT/TAX ID of the counterpart.

counterpart_vat_id
object
deduction_amount
integer
deprecated

The amount of tax deducted in minor units

Required range: 0 <= x <= 9007199254740991
deduction_memo
string
deprecated

A note with additional information about a tax deduction

deductions
object[]

List of deductions applied to the receivable (maximum 10 deductions allowed)

Maximum array length: 10
discount
object

The discount for a receivable.

discounted_subtotal
integer

Total price of the receivable with discounts before taxes minor units.

Required range: x <= 9007199254740991
document_id
string

The sequential code systematically assigned to invoices.

document_rendering
object

Settings for rendering documents in PDF format, including settings for line items and specific document types.

due_date
string<date>

Optional field representing date until which invoice should be paid

einvoice_file_url
string

E-invoice XML file that was sent to the counterpart via an e-invoicing network. Available only if is_einvoice is true.

entity_bank_account
object
entity_user_id
string<uuid>

The entity user who created this document.

entity_vat_id
object
expiry_date
string<date>

The date (in ISO 8601 format) until which the quote is valid.

file
object

Represents a file (such as a PDF invoice) that was uploaded to Monite.

file_url
string

The receivable's PDF URL in the counterpart's default language.

Optional text displayed below the line items table in the PDF.

issue_date
string<date-time>

Optional field for the issue of the entry.

memo
string

A note with additional information for a receivable.

original_file_url
string

The receivable's PDF URL in the entity's default language.

partner_metadata
object

Metadata for partner needs

project_id
string<uuid>

A project related to current receivable

quote_accept_page_url
string<uri>

Link for custom quote accept page

Required string length: 1 - 65536
signature_required
boolean

Whether acceptance a quote requires a signature.

subtotal
integer

The subtotal (excluding VAT), in minor units.

Required range: x <= 9007199254740991
subtotal_after_vat
integer

The subtotal including VAT but without invoice discount, in minor units.

Required range: x <= 9007199254740991
tags
object[]

The list of tags for this receivable.

total_amount
integer
default:0

Total price of the receivable in minor units. Calculated as a subtotal + total_vat_amount.

Required range: x <= 9007199254740991
total_deduction_amount
integer

The total deduction amount of all deductions, in minor units.

Required range: x <= 9007199254740991
total_vat_amounts
object[]

List of total vat amount for each VAT, presented in receivable

total_withholding_tax
integer

Total price of the receivable with tax withheld in minor units

trade_name
string

Trade name of the entity

Maximum string length: 255
vat_exempt
boolean

Indicates whether the goods, materials, or services listed in the receivable are exempt from VAT or not.

vat_exemption_rationale
string

The reason for the VAT exemption, if applicable.

vat_inclusive_discount_mode
enum<string>
default:exclusive

Indicates whether the discount is applied to the VAT-inclusive or VAT-exclusive amount.

Available options:
exclusive,
inclusive
vat_mode
enum<string>
default:exclusive

Defines whether the prices of products in receivable will already include VAT or not.

Available options:
exclusive,
inclusive
withholding_tax_rate
integer

The amount of tax withheld in percent minor units

Required range: 0 <= x <= 10000