Skip to content
/
Marks an invoice as paid

Marks an invoice as paid

Request

PUT {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/mark-as-paid

This endpoint marks an invoice as paid.

Only invoices in published (Due, Past Due) status and not paid can be marked as paid.

Care must be taken to complete all the fields with the existing information.

See Also:
To retrieve an invoice by ID, see GET /pay-int-api/invoices/{invoiceId}.
To cancel an invoice, see PUT /pay-int-api/invoices/{invoiceId}/cancel.
To retrieve calculations for an invoice, see GET /pay-int-api/invoices/{invoiceId}/calculations.
To list invoices, see GET /pay-int-api/invoices.

Security
Bearer
Path
invoiceIdstring, (uuid)required

The identifier of the invoice to mark as paid.

Example:9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
Headers
x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0
Bodyapplication/json

The request containing the payment details.

paymentMethodTypeIdinteger or null, (int32)

Specifies the payment method type identifier.

Value values:

IdName
1Card (for credit card)
2ElectronicCheck

Example: 2

Example:2
curl -i -X PUT \
  https://developer.flute.com/_mock/api-reference/pay-int-api/invoices/9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70/mark-as-paid \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-version: 1.0' \
  -d '{
    "paymentMethodTypeId": 2
  }'

Responses

OK. Invoice marked as paid successfully.

Response
No content