Type Alias: DeleteInvoiceScanDtoPayload

@arolariu/website

---

@arolariu/website / types/invoices/Invoice / DeleteInvoiceScanDtoPayload

Type Alias: DeleteInvoiceScanDtoPayload

DeleteInvoiceScanDtoPayload = object

Defined in: types/invoices/Invoice.ts:564

DTO payload for removing a scan from an invoice.

Remarks

Constraints: An invoice must have at least one scan. Attempting to delete the last remaining scan will result in a validation error.

Storage Cleanup: The actual blob in Azure Storage is marked for deletion and cleaned up by a background job after a retention period.

Example

const deletePayload: DeleteInvoiceScanDtoPayload = {
  id: "scan-uuid-to-delete"
};

await fetch(`/api/invoices/${invoiceId}/scans/${deletePayload.id}`, {
  method: "DELETE"
});

See

InvoiceScan for the scan entity structure

Properties

id

readonly id: string

Defined in: types/invoices/Invoice.ts:566

The unique identifier of the invoice scan to be deleted.