W3builders
AOP API

AOP API/Documents & Invoices

Change Document Status

POST/finance/documents/{id}/status
JWT bearer

Transition a document's status.

Endpoint

POSThttps://api.w3builders.com/v1/finance/documents/{id}/status

Request body

  • status (required, one of the status enum values)
  • note (optional)

Response parameters

FieldType
successvalue
statusvalue
Change Document Status
curl -X POST https://api.w3builders.com/v1/finance/documents/123/status \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "sent",
"note": "Emailed to client"
}'
{
"shape": "{ success, status }"
}
Was this page helpful?