Mark a payable as paid

POST
/payables/:payable_id/mark_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 pay permission for payables.
  • The amount_to_pay field is automatically calculated based on the amount_due less the percentage described in the payment_terms.discount value.

Related guide: Mark a payable as paid

See also:

Payables lifecycle

Payables status transitions

Path parameters

payable_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
commentstringOptional

An arbitrary comment that describes how and when this payable was paid.

Response

Successful Response

idstringformat: "uuid"

A unique ID assigned to this payable.

created_atdatetime

UTC date and time when this payable was created. Timestamps follow the ISO 8601 format.

updated_atdatetime

UTC date and time when this payable was last updated. Timestamps follow the ISO 8601 format.

credit_noteslist of objects

The list of linked credit notes of the payable.

entity_idstringformat: "uuid"

The ID of the entity to which the payable was issued.

payable_originenum
Allowed values: uploademaileinvoicing

Specifies how this payable was created in Monite: upload - created via an API call, email - sent via email to the entity’s mailbox.

source_of_payable_dataenum
Allowed values: ocruser_specifiedeinvoicing

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.

statusenum

The status of the payable.

amount_dueintegerOptional

How much is left to be paid on the invoice (in minor units).

amount_paidintegerOptional

How much was paid on the invoice (in minor units).

amount_to_payintegerOptional

How much is left to be paid on the invoice (in minor units) with discounts from payment terms.

approval_policy_idstringOptionalformat: "uuid"

Id of existing approval policy that applies to this payable, if any. A policy is applied if the payable matches the policy trigger conditions.

counterpartobjectOptional

Object representing de-normalized counterpart data. Filled at the moment of invoice submitting for approval or payment.

counterpart_address_idstringOptionalformat: "uuid"

The ID of counterpart address object stored in counterparts service

counterpart_bank_account_idstringOptionalformat: "uuid"

The ID of counterpart bank account object stored in counterparts service

counterpart_idstringOptionalformat: "uuid"

The ID of the counterpart object that represents the vendor or supplier.

counterpart_raw_dataobjectOptional

Object representing counterpart data which was extracted by OCR. Used for informational purposes.

counterpart_vat_id_idstringOptionalformat: "uuid"

The ID of counterpart VAT ID object stored in counterparts service

created_by_role_idstringOptionalformat: "uuid"

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.

currencyenumOptional

The currency code of the currency used in the payable.

currency_exchangeobjectOptional
descriptionstringOptional

An arbitrary description of this payable.

discountintegerOptional

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.

document_idstringOptional

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.

due_datestringOptionalformat: "date"

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.

fileobjectOptional

The original file from which this payable was created.

file_idstringOptionalformat: "uuid"

File id to retrieve file info from file saver.

issued_atstringOptionalformat: "date"

The date when the payable was issued, in the YYYY-MM-DD format.

marked_as_paid_by_entity_user_idstringOptionalformat: "uuid"

The ID of the entity user who marked this document as paid.

marked_as_paid_with_commentstringOptional

An arbitrary comment that describes how and when this payable was paid.

ocr_request_idstringOptionalformat: "uuid"

Id of OCR request to match asynchronous result of processing payable.

ocr_statusenumOptional
Allowed values: processingerrorsuccesscanceled

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.

other_extracted_dataobjectOptional

Data extracted from the uploaded payable by OCR.

paid_atdatetimeOptional

The date by which the payable was paid

partner_metadatamap from strings to anyOptional

Metadata for partner needs

payment_termsobjectOptional

The number of days to pay with potential discount for options shorter than due_date

project_idstringOptionalformat: "uuid"

Project ID of a payable.

purchase_order_idstringOptionalformat: "uuid"

The identifier of the purchase order to which this payable belongs.

senderstringOptionalformat: "email"

The email address from which the invoice was sent to the entity.

subtotalintegerOptional

The subtotal amount to be paid, in minor units. For example, $12.50 is represented as 1250.

suggested_payment_termobjectOptional

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.

tagslist of objectsOptional

A list of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable.

taxintegerOptional

Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%.

tax_amountintegerOptional

Tax amount in minor units. For example, $12.50 is represented as 1250.

total_amountintegerOptional

The total amount to be paid, in minor units. For example, $12.50 is represented as 1250.

total_amount_with_credit_notesintegerOptional

The total price of the payable in minor units, excluding all issued credit notes.

was_created_by_user_idstringOptionalformat: "uuid"

Errors

Mark a payable as partially paid