Payables

Mark a payable as partially paid

Mark a payable as partially paid.

If the payable is partially paid, its status is moved to partially_paid. The value of the amount_paid field must be the sum of all payments made, not only the last one.

Notes:

  • This endpoint can be used for payables in the waiting_to_be_paid status.
  • The amount_paid must be greater than 0 and less than the total payable amount specified by the amount field.
  • You can use this endpoint multiple times for the same payable to reflect multiple partial payments, always setting the sum of all payments made.
  • 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 partially paid

See also:

Payables lifecycle

Payables status transitions

Mark a payable as paid

post/payables/{payable_id}/mark_as_partially_paid

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/payables/{payable_id}/mark_as_partially_paid
  • Auth: HTTP bearer

Path parameters

payable_idstring required

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Request body

amount_paidinteger required

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

Response

Successful Response

idstring uuid required

A unique ID assigned to this payable.

created_atstring date-time required

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

updated_atstring date-time required

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

amount_dueinteger

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

amount_paidinteger

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

amount_to_payinteger

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

approval_policy_idstring 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.

counterpart_address_idstring uuid

The ID of counterpart address object stored in counterparts service

counterpart_bank_account_idstring uuid

The ID of counterpart bank account object stored in counterparts service

counterpart_idstring uuid

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

counterpart_vat_id_idstring uuid

The ID of counterpart VAT ID object stored in counterparts service

created_by_role_idstring 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.

currency'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'
descriptionstring

An arbitrary description of this payable.

discountinteger

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_idstring

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_datestring 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.

einvoice_file_urlstring

The URL to download the original e-invoice file.

enforce_approval_policy_idstring uuid

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.

entity_idstring uuid required

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

file_idstring uuid

File id to retrieve file info from file saver.

issued_atstring date

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

marked_as_paid_by_entity_user_idstring uuid

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

marked_as_paid_with_commentstring

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

ocr_request_idstring uuid

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

ocr_status'processing' | 'error' | 'success'
paid_atstring date-time

The date by which the payable was paid

partner_metadataobject

Metadata for partner needs

payable_origin'upload' | 'email' | 'einvoicing' required
project_idstring uuid

Project ID of a payable.

purchase_order_idstring uuid

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

senderstring email

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

source_of_payable_data'ocr' | 'user_specified' | 'einvoicing' required
status'draft' | 'new' | 'approve_in_progress' | 'waiting_to_be_paid' | 'partially_paid' | 'paid' | 'canceled' | 'rejected' required
subtotalinteger

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

taxinteger

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

tax_amountinteger

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

total_amountinteger

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

total_amount_with_credit_notesinteger

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

was_created_by_user_idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.