EDI settings
Every setting on the EDI Configurations, from the shared import and sequence number settings to orders, despatch advice, invoices, credits, picks, acknowledgements, inventory advice and reports.
The EDI Integration exchanges documents with retailers and other trading partners over EDIFACT,
Tradacoms and X12. Each document type has its own Configuration (EDI Order, EDI Shipment,
EDI Invoice and so on). A handful of settings are shared by every EDI Configuration; the
rest belong to one document type. Settings that start edifact. only affect EDIFACT messages,
and settings that start tradacoms. only affect Tradacoms messages.
Shared settings (every EDI document type)
These settings appear on every EDI Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Last import date lastImportDate | The import watermark. Each run only fetches documents modified after it, and it moves forward after each run. | Date and time. Managed by the system. | Don't edit it by hand. |
Import delay importDelay | Waits before importing a document, so other systems can finish changing it first. | A duration, for example 00:05:00 for five minutes. | Add a delay if documents are being picked up before they're complete. |
Time zone timeZoneId | The time zone used to read dates and times in EDI messages, so timestamps are converted correctly. | A time zone ID, for example Europe/London. | Set it to the partner's time zone, especially for overseas partners. |
Commit sequence number on error commitSequenceNumberOnError | Commits the AS2 sequence number even when processing fails, so the same message isn't processed again on the next run. | On or off. | Turn on to stop a problem message being retried over and over. The failed message is then skipped, so it needs dealing with separately. |
Disable the expected payable tag disableExpectedPayableTag | Stops the expected payable tag being added. That tag is normally used to check that the calculated document total matches the expected amount. | On or off. | Turn on only to skip the total check. |
Apply sequence numbers at creation applySequenceNumbersAtCreation | Applies EDI sequence numbers to outgoing documents when they're created rather than when they're sent. | On or off. Default off for most integrations; on by default for Toymaster. | Turn on when the partner needs the sequence number inside the EDI payload before it leaves Supply Lens. |
Fail on fractional quantities failOnFractionalQuantities | Makes generating an outgoing message fail, naming the line at fault, when a line quantity isn't a whole number. | On or off. Default off, which truncates the quantity. | Turn on for partners who reject messages whose quantities and values don't reconcile, for example Etos. |
Why fractional quantities happen
Quantities are converted into the unit the original order was placed in. A line invoiced for part of a pack (2.5 packs, say) becomes a fractional quantity. EDI quantity fields carry whole numbers, so by default the quantity is truncated while the unit price keeps its full precision, and the quantities and values in the message no longer reconcile.
Orders
These settings are on the EDI Order Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Fulfilment location fulfillmentLocationId | Assigns every order from this EDI Integration to one fulfilment Location, the warehouse responsible for fulfilling it. | A Location ID. | Set it when one warehouse fulfils all of this partner's orders. |
Product identifier priority edifact.productIdentifierPriority | The order in which product identifier types are tried when matching order lines to Products. The first type is tried first, then the next if there's no match. | A list, for example ["gtin", "supplier-code"]. EDIFACT only. | Set it to the identifiers the partner sends, most reliable first. |
Despatch advice (shipments)
These settings are on the EDI Shipment Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Always match original order product codes alwaysMatchOriginalOrderProductCodes | Always uses the product codes from the original order when matching shipment lines, instead of trying other identifiers. | On or off. | Turn on when the partner expects its own order codes echoed back. |
Default original ordering size defaultOriginalOrderingSize | The ordering unit size used when the original order didn't specify one. Used when working out shipment line quantities. | A number. | Set it when the partner's orders don't state a pack size. |
Product identifier priority edifact.productIdentifierPriority | The order in which product identifier types are tried when matching. | A list, for example ["gtin", "supplier-code"]. EDIFACT only. | As for orders. |
Proof of delivery
These settings are on the EDI Proof of Delivery Configuration. It reads a trading partner's confirmation of what actually arrived against a despatch, from an EDIFACT RECADV (receiving advice) message or a Tradacoms delivery confirmation.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Ignore provided items per unit ignoreProvidedItemsPerUnit | Discards the items per unit sent on the message instead of reading it. | On or off. Default off. | Turn on only for a partner known to misuse the field. One partner repeats the delivered quantity there, so 392 cases arrive claiming 392 items per case. Items per unit drives Unit of Measure resolution, so a value like that stops the line's unit being resolved. |
Product identifier priority edifact.productIdentifierPriority | The order in which product identifier types are tried when reading product codes on a receiving advice line. | A list, for example ["gtin", "supplier-code"]. | Only matters when a line carries a seller product code that has to be read as another identifier type. A buyer product code and the line item's own code are always read directly. |
Invoices
These settings are on the EDI Invoice Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Use invoice reference as delivery note reference useInvoiceReferenceAsDeliveryNoteReference | Uses the invoice reference number as the delivery note reference. | On or off. | Turn on when invoices and delivery notes are issued together and share a number. |
Always match original order product codes alwaysMatchOriginalOrderProductCodes | Always uses the product codes from the original order when matching invoice lines. | On or off. | Turn on for consistency between the order and the invoice. |
Recalculate values recalculateValues | Recalculates line values from unit prices and quantities instead of using the values in the message. | On or off. | Turn on to keep values consistent or to remove rounding errors from the source. |
Override receiver identifier overrideReceiverIdentifier | Replaces the receiver identifier in the message envelope. | An identifier. | Set it when the invoice must be addressed to a different receiver ID. |
Order reference type orderReferenceType | The document reference type that carries the order number in the invoice. | A reference type. | Set it from the partner's specification. |
Buyer order reference type buyerOrderReferenceType | The document reference type that carries the buyer's purchase order number. | A reference type. | Set it from the partner's specification. |
Invoice reference type invoiceReferenceType | The document reference type that carries the invoice number. | A reference type. | Set it from the partner's specification. |
Delivery note reference type deliveryNoteReferenceType | The document reference type that carries the delivery note number. | A reference type. | Set it from the partner's specification. |
Default original ordering size defaultOriginalOrderingSize | The ordering unit size used when the original order didn't specify one. Used when working out invoice line quantities. | A number. | Set it when the partner's orders don't state a pack size. |
Free-text purchase information freeTextPurchaseInformation | Free text added to the purchase information segment of the invoice, for extra notes or terms. | Text. | Set it when the partner wants standard wording on every invoice. |
Product identifier priority edifact.productIdentifierPriority | The order in which product identifier types are tried. | A list, for example ["gtin", "supplier-code"]. EDIFACT only. | As for orders. |
Exchange rate date edifact.exchangeRateDate | Which date is used to look up the exchange rate for currency conversion. | none (default, no exchange rate date), delivery (the delivery date) or order (the order date). EDIFACT only. | Set it when the partner needs a foreign exchange rate on the invoice. |
Send delivery note details as proof of delivery tradacoms.sendDeliveryNoteDetailsAsProofOfDelivery | Includes delivery note details as proof of delivery in the outgoing invoice. | On or off. Tradacoms only. | Turn on when the Tradacoms partner asks for it. |
Credit notes
These settings are on the EDI Credit Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Use invoice reference as delivery note reference useInvoiceReferenceAsDeliveryNoteReference | Uses the invoice reference number as the delivery note reference, as on invoices. | On or off. | Match the invoice setting so credits are handled the same way. |
Default original ordering size defaultOriginalOrderingSize | The ordering unit size used when the original order didn't specify one. Used when working out credit note line quantities. | A number. | Set it when the partner's orders don't state a pack size. |
Product identifier priority edifact.productIdentifierPriority | The order in which product identifier types are tried. | A list, for example ["gtin", "supplier-code"]. EDIFACT only. | As for orders. |
Warehouse orders
This setting is on the EDI Warehouse Order Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Override receiver identifier overrideReceiverIdentifier | Replaces the receiver identifier in the message envelope of warehouse order messages. | An identifier. | Set it when the warehouse expects a different receiver ID. |
Picks
These settings are on the EDI Pick Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Outer container unit of measure outerContainerUnitOfMeasureId | The Unit of Measure that represents the outer container, such as a pallet, when reporting pick quantities at that level. | A Unit of Measure ID. Default Pallet ISO 1. | Change it if your outer container isn't an ISO pallet. |
Inner container unit of measure innerContainerUnitOfMeasureId | The Unit of Measure that represents the inner container, such as a carton. | A Unit of Measure ID. Default Carton. | Change it if your inner container isn't a carton. |
CHEP pallet unit of measure chepPalletUnitOfMeasureId | The Unit of Measure that identifies a CHEP pallet. Containers in this unit are reported with the partner's CHEP packaging code instead of the default ISO pallet code. | A Unit of Measure ID. Unset by default. | Set it if you ship on CHEP pallets. Leave it unset if all pallets are ISO. |
Send catch weight quantity sendCatchWeightQuantity | Reports the total weight of each line in kilograms alongside the quantity. | On or off. Default off. | Turn on for partners that trade catch weight products. |
Order acknowledgements
These settings are on the EDI Order Acknowledgement Configuration.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Identifier type map identifierTypeMap | Maps product identifier types to other types when generating acknowledgements, so identifiers go back in the form the partner expects. | A map of identifier type to identifier type. | Set it when the partner wants a different identifier type back from the one Supply Lens holds. |
Product identifier priority edifact.productIdentifierPriority | The order in which product identifier types are tried. | A list, for example ["gtin", "supplier-code"]. EDIFACT only. | As for orders. |
Payment terms description paymentTermsDescription | The payment terms stated on the acknowledgement when the purchase order it answers carries none. An acknowledgement has no payment terms of its own, so they come from the order and fall back to this. | Text, for example Net 30 Days. | Set it for partners that make the terms description mandatory, such as Backcountry. |
Inventory advice
These settings are on the EDI Inventory Configuration. The inventory advice tells a trading partner what stock is available so they can order against it. An inventory Document carries Products and quantities but no Parties, so the vendor the advice is sent as is configured here.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Override receiver identifier overrideReceiverIdentifier | Replaces the receiver identifier written to the message. | An identifier. Default: the first remote party ID on the Integration. | Set it when the advice must go to a different receiver ID. |
Override sender identifier overrideSenderIdentifier | Replaces the sender identifier written to the message. | An identifier. Default: the first local party ID on the Integration. | Set it when you must send as a different ID. |
Vendor number vendorNumber | The vendor number the customer knows you by, sent as the internal vendor number on the advice. | Text. | Set it to the number the retailer gave you. |
Vendor name vendorName | The official company name sent as the vendor on the advice. | Text. | Set it to your registered company name. |
Inventory and sales reports
These settings are on the EDI Inventory Report and EDI Sales Report Configurations. These reports arrive over EDIFACT.
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Product identifier priority edifact.productIdentifierPriority | The order in which product identifier types are tried when reading inventory report or sales report lines. Set separately on each Configuration. | A list, for example ["gtin", "supplier-code"]. | Set it to the identifiers the partner sends. |
Remittance
The EDI Remittance Configuration has no settings beyond the shared ones. Remittances arrive over Tradacoms.
Functional acknowledgements
The EDI Functional Acknowledgement Configuration has no settings beyond the shared ones. An acknowledgement answers the message it was produced from, so who to reply to, which group is acknowledged and under which version are all carried on the Document as tags recorded when the message was read.
- How to switch it on: configure a document-to-document map from the received document type
to
functional-acknowledgement, for exampleordertofunctional-acknowledgement. Turning that map on for an organisation is what decides whether a partner is acknowledged. There's no separate setting. - Which document types: maps exist for
orderandorder-change. - X12 only: only X12 has an acknowledgement message to send back. Inventory and sales reports (EDIFACT) and remittances (Tradacoms) can't be acknowledged, because those syntaxes have no acknowledgement message and don't record the functional group reference it would echo.
- One per Document: one acknowledgement is produced per received Document, which is one per transaction set.
- Parse failures: a message that fails to parse produces no Documents, so it isn't acknowledged.