POST
/api/Invoices/{id}/mark-paid
const url = 'https://example.com/api/Invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mark-paid';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/Invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mark-paid \ --header 'Authorization: Bearer <token>'Records the invoice as Paid. Use after a payment is received outside the system.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string format: uuid
The invoice’s unique identifier.
Responses
Section titled “ Responses ”Invoice marked as paid.
Media type application/json
object
id
string format: uuid
merchantId
string format: uuid
invoiceNumber
string
memberId
string format: uuid
clientName
string
clientDetail
string
clientEmail
string
status
string
issueDate
string format: date-time
dueDate
string format: date-time
sentAt
string format: date-time
paidAt
string format: date-time
subtotal
number format: double
tax
number format: double
total
number format: double
currency
string
notes
string
lineItems
Array<object>
object
id
string format: uuid
description
string
quantity
number format: double
unitPrice
number format: double
total
number format: double
sortOrder
integer format: int32
createdAt
string format: date-time
updatedAt
string format: date-time
Example
{ "status": "Draft"}No invoice with the given ID exists.
Media type application/json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}