Edit a Document
Lesson 10 of 17 7 min read
Correct a Document before it is sent, check your changes as a patch, and handle Documents that have already been sent.
Sometimes the data that arrives is not quite right: a discontinued SKU, a missing delivery note, a wrong date. Rather than asking the customer to send it again, you can correct the Document in Supply Lens. In this lesson you will learn how to edit safely, how to see exactly what you changed, and what extra step is needed when the Document has already been sent.
When editing is the right fix
Edit when this one Document is wrong and the fix is clear: one line needs a different SKU, the delivery date is wrong, the order note is missing. If the same problem keeps happening, fix the cause instead (the product setup, the source system, or the Mapping) or you will be editing forever.
Easiest while Ready
A Document is easiest to edit while it is Ready, before anything has been sent. If you expect
to edit Documents of a certain kind often, consider setting their Mapping to manual.
Edit a Document
- Open the Document you want to edit.
- Click the three dots on the right and choose the pencil Edit button.
- Change the details in the document editor.
- Optionally click SHOW PATCH in the top-right to review your changes.
- Click SAVE.
What you can change
The editor covers the parts of a Document you are most likely to need, including:
- Lines: change the SKU on a line (its price is looked up and filled in for you), change prices (amount and subtotal recalculate), and add or edit shipping lines and tax adjustments.
- Parties: add and manage the identifiers for the parties on the Document.
- The side panel, grouped into Financial, References, Fulfilment, Payment terms and Notes. Here you can edit dates (earliest, promised ship and promised delivery), salesperson, tax-inclusive pricing, primary note, financial and fulfilment status, fulfilment location and local pickup, tax point date and payment terms.
- Order notes and shipping instructions on orders.
- Tracking details on shipments: tracking number, type, carrier link and any sub-tracking.
Check your changes with Show patch
SHOW PATCH lists every change you have made in JSON form before you save. Each entry says
what was done (op), where (path) and the new value. For example, this patch changes the
time and time-zone offset on the order reference:
[
{ "op": "replace", "path": "/documentReferences/order/time", "value": "11:50:00" },
{ "op": "replace", "path": "/documentReferences/order/offset", "value": "01:00:00" }
]
You do not need to understand JSON to use it: just check that the list contains only the changes you meant to make.
Editing a Document that has already been sent
Complete Documents need one extra step
If the Document is already Complete, its target data exists. Before you can reprocess the
edited Document, set any existing target data to Cancelled. Otherwise the duplicate fail-safe
will stop the corrected version being sent.
So the sequence for a sent Document is:
Before you do this, think about the receiving system. It already has the original. Will it accept a second copy as an update, or create a duplicate? If in doubt, correct the record in the receiving system directly, or ask Support.
A substitute blend
The grocery chain ordered 24 bags of Harbour Blend, which Hilltop no longer roasts. The order
is Ready. The buyer agrees to Ridge Espresso instead. Priya opens the Document, clicks the
three dots and Edit, changes the line's SKU to RIDGE-ESP-1KG (the price fills in
automatically), adds a primary note "Substitute agreed with buyer", checks SHOW PATCH, and
saves. Then she processes the order to Unleashed.
Recap
- Edit one-off problems; fix the root cause for repeated ones.
- Open the Document, choose the three dots then Edit, make changes, check SHOW PATCH, then SAVE.
- You can edit lines, parties, dates, notes, payment terms, fulfilment details and shipment tracking.
- For a
CompleteDocument, cancel the existing target data before reprocessing, and consider what the receiving system will do with a second copy.
Quick guides for this topic
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.