Skip to main content

Get Invoice Upload Status API

Introduction​

Returns whether an uploaded document is associated with the given invoice number for the tenant, via InvoiceService.getInvoiceUploadStatus(invoiceNumber, tenantId). The UI polls this after multipart upload to confirm processing completion.

Source: InvoiceHomePageAPI.getPoduploadstatus (@Path("getInvoiceUploadStatus")).

See also: Invoice Home — all endpoints.


Security note​

No checkIfAuthKeyIsValid. userId, officeBranch, and authKey are not used for authentication in the handler.


HTTP Endpoint​

PropertyValue
URL/rest/invoicehome/getInvoiceUploadStatus/{invoiceNumber}/{userId}/{officeBranch}/{authKey}
MethodGET
Producestext/plain (JSON string entity)

Path Parameters​

ParameterTypeRequiredDescription
invoiceNumberStringYesInvoice number checked for upload status.
userIdStringYesPresent in URL; unused in handler (activity logging is commented out).
officeBranchStringYesURL convention; unused.
authKeyStringYesURL convention; not validated.

Behaviour​

boolean uploaded = invoiceService.getInvoiceUploadStatus(invoiceNumber, tenantId).


Response​

Code: 200 OK

Body (JSON string):

{"data":true}

or

{"data":false}

Headers: Access-Control-Allow-Origin: *


Example Request​

GET /rest/invoicehome/getInvoiceUploadStatus/INV-2026-001/alice/default/9274923 HTTP/1.1
Host: {base}