HomeGuidesRecipesAPI ExplorerForumSupport
Partner Portal
Partner Portal

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.
  • The amount_paid can be either increased or decreased to reflect reversed payments and chargebacks.
  • 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.

Related guide: Mark a payable as partially paid

See also:

Payables lifecycle

Payables status transitions

Mark a payable as paid

Language
Authorization
Bearer
URL
Click Try It! to start a request and see the response here!