Skip to main content

Get Invoice Save Status API

Introduction​

Polls whether an InvoiceOriginal row exists for a temporary invoice number (getInvoiceOriginalSaveStauts — spelling matches the Java method name). If found, returns data: true plus the real invoiceNumber and optional bookingId from the first row. Used by the UI to detect async save completion when creating invoices.

Source: InvoiceHomePageAPI.getInvoiceSaveStatus (@Path("invoicehome")).

See also: Invoice Home — all endpoints.


Security note​

No auth validation. Path includes userId, officeBranch, authKey for URL symmetry only.


HTTP Endpoint​

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

Path Parameters​

ParameterTypeRequiredDescription
tempInvoiceNumberStringYesTemporary / in-progress invoice identifier to look up.
userIdStringYesUnused in handler.
officeBranchStringYesUnused in handler.
authKeyStringYesUnused in handler.

Behaviour​

List<InvoiceOriginal> invoiceoriginal = invoiceService.getInvoiceOriginalSaveStauts(tempInvoiceNumber, tenantId).

  • If size() > 0: data: true, invoiceNumber from first row, optional bookingId if non-null.
  • Else: data: false only.

Response​

Code: 200 OK

When saved (at least one row):

{
"data": true,
"invoiceNumber": "INV-2026-100",
"bookingId": "BK-1"
}

bookingId is omitted when null on the entity.

When not found:

{
"data": false
}

Headers: Access-Control-Allow-Origin: *


Example Request​

GET /rest/invoicehome/getInvoiceSaveStatus/TEMP-INV-xyz/alice/default/9274923 HTTP/1.1
Host: {base}