Mark a payable as paid
Mark a payable as paid.
Payables can be paid using the payment channels offered by Monite or through external payment channels. In the latter case, the invoice is not automatically marked as paid in the system and needs to be converted to the paid status manually.
Optionally, it is possible to pass the comment field in the request body, to describe how and when the invoice was
paid.
Notes:
- To use this endpoint with an entity user token, this entity user must have a role that includes the
paypermission for payables. - The
amount_to_payfield is automatically calculated based on theamount_dueless the percentage described in thepayment_terms.discountvalue.
Related guide: Mark a payable as paid
See also:
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
An arbitrary comment that describes how and when this payable was paid.
Response
Successful Response
Represents an Accounts Payable document received from a vendor or supplier.
A unique ID assigned to this payable.
The list of linked credit notes of the payable.
The ID of the entity to which the payable was issued.
Specifies how this payable was created in Monite: upload - created via an API call, email - sent via email to the entity's mailbox.
upload, email, einvoicing Specifies how the property values of this payable were provided: ocr - Monite OCR service extracted the values from the provided PDF or image file, user_specified - values were added or updated via an API call.
ocr, user_specified, einvoicing How much is left to be paid on the invoice (in minor units).
1000
How much was paid on the invoice (in minor units).
1000
How much is left to be paid on the invoice (in minor units) with discounts from payment terms.
1000
Id of existing approval policy that applies to this payable, if any. A policy is applied if the payable matches the policy trigger conditions.
Object representing de-normalized counterpart data. Filled at the moment of invoice submitting for approval or payment.
The ID of counterpart address object stored in counterparts service
The ID of counterpart bank account object stored in counterparts service
The ID of the counterpart object that represents the vendor or supplier.
Object representing counterpart data which was extracted by OCR. Used for informational purposes.
The ID of counterpart VAT ID object stored in counterparts service
The ID of the role that the entity user who created this payable had at that time. If the payable was created using a partner access token, the value is null.
The currency code of the currency used in the payable.
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 "EUR"
An arbitrary description of this payable.
The value of the additional discount that will be applied to the total amount. in minor units. For example, $12.50 is represented as 1250.
500
A unique invoice number assigned by the invoice issuer for payment tracking purposes. This is different from id which is an internal ID created automatically by Monite.
"DE2287"
The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date.
The URL to download the original e-invoice file.
"https://bucketname.s3.amazonaws.com/12345/67890.xml"
Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead.
The original file from which this payable was created.
File id to retrieve file info from file saver.
The date when the payable was issued, in the YYYY-MM-DD format.
The ID of the entity user who marked this document as paid.
"71e8875a-43b3-434f-b12a-54c84c176ef3"
An arbitrary comment that describes how and when this payable was paid.
"Was paid partly in the end of the month."
Id of OCR request to match asynchronous result of processing payable.
The status of the data recognition process using OCR. The 'processing' status means that the data recognition is in progress and the user needs to wait for the data enrichment. The 'error' status indicates that some error occurred on the OCR side and the user can fill in the data manually. The 'success' status means the data recognition has been successfully completed, after which the user can check the data if desired and enrich or correct it.
processing, error, success Data extracted from the uploaded payable by OCR.
- Option 1
- Option 2
The date by which the payable was paid
Metadata for partner needs
The number of days to pay with potential discount for options shorter than due_date
Project ID of a payable.
The identifier of the purchase order to which this payable belongs.
The email address from which the invoice was sent to the entity.
"hello@example.com"
The subtotal amount to be paid, in minor units. For example, $12.50 is represented as 1250.
1250
The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0.
A list of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable.
Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%.
2000
Tax amount in minor units. For example, $12.50 is represented as 1250.
250
The total amount to be paid, in minor units. For example, $12.50 is represented as 1250.
1500
The total price of the payable in minor units, excluding all issued credit notes.