MyWork24 Knowledge Base
Article

Consignment reports & PDFs

Edit

Consignment stock has one on-screen report and two downloadable PDF documents. All of them are read-only and gated by consignment permissions.

Rent & occupancy report (on screen)

Procurement & Logistics -> Consignment Stock -> Rent & occupancy report (needs the Consignment Report permission, or admin).

One row per agreement, with totals at the foot:

  • On hand - units of the customer's stock currently held.
  • Locations - how many distinct warehouse locations it occupies.
  • Rent accrued - storage rent charged to date (or No-cost for a non-billable agreement).
  • Uninvoiced - charges not yet on an issued bill.
  • Billed / Paid / Outstanding - the billing picture from issued bills.
  • Next bill - when rent will next accrue.

It answers the everyday questions "who has stock with us, how much, and what's still owed?" at a glance.

PDF documents

From an open agreement (view mode) there are two Download PDF buttons. Both carry the standard company letterhead and footer.

Stock summary PDF - a concise document with:

  • the owner, storage bay and storage terms, and
  • the current stock on hand by product, with a total.

Use it as a quick "what are you holding for us" statement.

Full report PDF - everything in the summary, plus:

  • Stock by location - for every location, its building / floor / area / bin and the items (product and quantity) sitting there,
  • Receptions - every Local Receipt linked to the agreement (number, date, status, items received), and
  • Return shipments - every Local Shipment (number, date, status, items).

Use it as the detailed audit / hand-over document for a consignment.

For integrations and agents

The same data is available over the REST API (all under /rest/v2/consignment-agreements, gated by the consignment permissions):

  • GET /report - the rent / occupancy + billing rows.
  • GET /{id}/report.pdf?type=summary or ?type=full - the two PDFs above.
  • GET /{id}/on-hand, /{id}/charges, /{id}/bills, /{id}/receipts, /{id}/shipments - the underlying detail.

See the API's own OpenAPI document for the full, current list.

Related articles