Skip to main content

Remove Uploaded Document API

Introduction​

Clears the uploaded document association for a generated invoice by invoice number: InvoiceService.removeUploadedDocumentFromGeneratedInvoice(invoiceNo, tenantId). On success, logs activity for the invoicing module.

Source: InvoiceHomePageAPI.removeUploadedDocumentFromGeneratedInvoice (@Path("removeUploadedDocument")).

See also: Invoice Home — all endpoints.


HTTP Endpoint​

PropertyValue
URL/rest/invoicehome/removeUploadedDocument
MethodPOST
ConsumesRaw JSON body
Producestext/plain (JSON string entity)

Request Body (JSON)​

FieldTypeRequiredDescription
userIdStringYesActing user for activity log.
invoiceNumberStringYesInvoice whose upload should be removed.
userNameStringYesAuth username.
authKeyStringYesAuth key.

Authentication​

ConditionHTTP status
Invalid credentials401 Unauthorized (Access-Control-Allow-Origin: *)
Success200 OK

Response​

Code: 200 OK

Body (JSON string):

{"deleted":true}

or

{"deleted":false}

(deleted reflects service success.)

Headers: Access-Control-Allow-Origin: *


Example Request​

POST /rest/invoicehome/removeUploadedDocument HTTP/1.1
Host: {base}
Content-Type: application/json

{
"userId": "42",
"invoiceNumber": "INV-2026-001",
"userName": "alice",
"authKey": "secretKey"
}