Delivery Note technical endpoint reference

List the live controller actions, permission gates and principal side effects for support and integration review. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.

What you’ll accomplish

List the live controller actions, permission gates and principal side effects for support and integration review. This guide follows the supplied Delivery Note module’s live hooks, controller actions, model rules, views and stored side effects.

Follow these steps

1. Use `/admin/delivery_note` for the view-guarded register.
2. Use `/invoice/{invoiceId}` to resolve existing note or create flow.
3. Use `/create/{invoiceId}` with Create capability.
4. Use `/edit/{noteId}` with Edit capability; signed is blocked.
5. Use `/view/{noteId}`, `/pdf/{noteId}` and `/invoice_meta/{invoiceId}` with View capability.
6. Use `/void/{noteId}` with Delete capability; signed is blocked.
7. Use public view/sign with the secure token.
8. Use `/delivery_note/invoice_pdf/{invoiceId}?h={invoiceHash}` for authorised client PDF access.

Fields and options to review

• Admin register/invoice/create/edit/view/pdf/invoice_meta/void
• Public view/public sign
• Client invoice PDF
• Hyphenated compatibility aliases

Rules the system enforces

• Create writes note, snapshot, token/reference, created event and optional dispatch email.
• Edit writes delivery fields and updated event.
• Public view logs viewed; sign stores sealed evidence, logs signed and attempts confirmation email.
• Client PDF logs pdf_viewed_from_invoice.
• No endpoint implements hard delete, resend, export, webhook or token management.

How to confirm it worked

• Technical teams can trace each supported request to its guard, record effect and user-visible result.

Safety checks and troubleshooting

• Endpoint references are for authorised support/development; do not expose admin or token URLs publicly.

Continue with related guidance