Enterpryze settings
Every setting on the Enterpryze Configurations (orders, shipments, invoices, credits, purchase orders, product updates and inventory), with values, defaults and when to change each one.
The Enterpryze connector has seven Configurations: Enterpryze Order, Enterpryze Shipment, Enterpryze Invoice, Enterpryze Credit, Enterpryze Purchase Order, Enterpryze Product Update and Enterpryze Inventory. Some settings control documents read from Enterpryze, others control documents created in Enterpryze, and several are shared between Configurations. Each table says which Configurations a setting is on.
Reading documents from Enterpryze
These control which documents are picked up and what comes with them.
| Setting | What it does | Values / default | When to change it | On |
|---|---|---|---|---|
Setup date setupDate | Only documents created on or after this date are imported. | Date. Set automatically when first configured. | Rarely: it stops history being pulled in at go-live. | Order, Shipment, Invoice |
Last import date lastImportDate | The most recently imported document; the next run fetches only what changed since. | Managed by the system. | Don't edit it by hand. | Order, Shipment, Invoice, Inventory |
Last imported ID lastImportedId | The ID of the most recently imported credit; the next run fetches only credits created after it. | Managed by the system. | Don't edit it by hand. | Credit |
Import delay importDelay | Waits before importing a document after it arrives, so other Enterpryze apps (a 3PL, fulfilment app or pricing engine) can update it first. | Duration, for example 00:05:00 for five minutes. | When other apps change orders just after they're created. | Order, Shipment, Invoice |
Statuses to import importStatuses | Only documents in one of these statuses are processed. | List. Empty: all statuses. | To pick up documents only once they reach a given status. | Order, Shipment |
Card codes to include includeCardCodes | When not empty, only documents from Business Partners with these card codes are imported. | List. | To import one set of partners. | Order, Shipment, Invoice, Credit |
Card codes to exclude excludeCardCodes | Documents from these card codes are skipped. | List. | To leave out internal or test partners. | Order, Shipment, Invoice, Credit |
Include Business Partner includeBusinessPartner | Loads the full Business Partner (customer) record with the document. | On or off. | When you need more customer detail than basic identification. | Order, Shipment, Invoice, Credit |
Identifiers from Business Partner notes parseIdentifiersFromBusinessPartnerNotes | Extracts Party identifiers from the Business Partner's notes field using regular expressions (fields below). | Dictionary of identifier type to pattern settings. | When identifiers such as a GLN are kept in the notes. | Order, Shipment, Invoice, Credit |
Disable the expected payable tag disableExpectedPayableTag | Stops the expected payable tag being added. That tag normally checks the calculated total matches the expected amount. | On or off. | Only to skip the total check. | Order, Shipment, Invoice, Credit |
Each parseIdentifiersFromBusinessPartnerNotes entry has these fields:
| Field | What it is |
|---|---|
pattern | A regular expression matched against the notes field. |
groupNumber | The numbered capture group to extract. |
groupName | The named capture group to extract. |
replacement | An optional replacement string. |
ignoreCase | Whether matching ignores case. |
Creating documents in Enterpryze
| Setting | What it does | Values / default | When to change it | On |
|---|---|---|---|---|
Document type docType | The Enterpryze document type used when creating the document, which decides how it's classified. | Enterpryze document type. | To match how Enterpryze should classify orders or POs. | Order, Purchase Order |
Shipping item codes shippingLineItemCodes | Line item codes that represent shipping charges; these lines are treated as shipping, not products. | List of item codes. | When shipping is held as an item. | Order, Purchase Order |
Custom field mapping customFieldMapping | Maps Enterpryze custom field names to values from the source document. | Dictionary of field name to dynamic field definition. | To fill Enterpryze custom fields. | Order, Shipment, Invoice, Purchase Order |
Due date in days defaultDueDateDays | Days after the order or invoice date used as the default due date. | Number. | To give documents an expected payment or delivery date. | Order, Invoice, Purchase Order |
Name in ship-to address includeNameInShipToFullAddress | Includes the contact name in the full ship-to address. | On or off. Off: no recipient name. | When the address block should show who it's for. | Order, Shipment, Invoice, Purchase Order |
Fixed-format ship-to address useFixedFormatForShipToFullAddress | Formats the ship-to address with a fixed template rather than the dynamic format. | On or off. | For consistent address formatting. | Order, Shipment, Invoice, Purchase Order |
Send email sendEmail | Enterpryze sends an email notification when the document is created. | On or off. | When people should be alerted to new orders or invoices. | Order, Invoice |
Sales person salesPersonIdMap | Sets the Enterpryze sales person. Keys are sales person names as they appear on the order (matched ignoring case and surrounding spaces); values are 24-character Enterpryze sales person ids. | Map with default. Nothing matched and no default: the field is left off and Enterpryze applies its own default. | Set default alone for one sales person on every order. | Order |
New Business Partners
These apply only when a Business Partner is created from a document. An existing customer is never changed. Non-numeric values are ignored where the setting expects a number.
| Setting | What it does | Values / default | When to change it | On |
|---|---|---|---|---|
Business Partner group businessPartnerGroupCodeMap | The group assigned to new customers (or suppliers, on purchase orders), by tag. | Tag map with default, for example 5 for the Online group. Numeric. | Set default alone for one group for everyone. | Order, Invoice, Purchase Order |
Default price list businessPartnerDefaultPriceListMap | The default price list on the new customer's Finance & Taxes tab, by tag. | Tag map with default. Numeric. | To price new customers correctly. | Order, Invoice |
Default account code businessPartnerDefaultAccountCodeMap | The default general ledger account on the new customer's Finance & Taxes tab, by tag. | Tag map with default, for example "4000". | To post new customers' sales to the right account. | Order, Invoice |
Payment terms businessPartnerPaymentTermsIdMap | The payment terms id on the new customer, by tag. Enterpryze holds terms on the Business Partner, not its documents, so this is the only way to set them from Supply Lens. | Tag map with default, for example "4". Numeric. | To give new customers terms. | Order, Invoice |
Create Business Partner addresses createBusinessPartnerAddresses | Adds the bill-to and ship-to addresses to the customer as structured addresses (types B and S), and sets the document's bill-to and ship-to codes to those address names. | On or off. Default off. | When addresses should be held properly on the customer. | Order, Invoice |
The price list, account code and address settings are deliberately absent from Purchase Order: they're customer-side, and a purchase order's ship-to is your own warehouse.
How createBusinessPartnerAddresses names and handles addresses:
- The name is
Name (CompanyName)when both are set and different, otherwise whichever is set. Names are capped at 50 characters; over that, the company name is dropped rather than truncated. A party with neither name is skipped and logged. - Bill-to and ship-to are named after their own party, so a delivery to someone else is named after the recipient. Where the ship-to has no address of its own, the customer's address is used for both.
- Addresses are only ever added, never updated, so a correction made in Enterpryze isn't overwritten. A customer who changes address at source won't have it updated in Enterpryze.
- Default bill-to and ship-to aren't sent: Enterpryze nominates them itself when the customer has none. A default already chosen in Enterpryze is left alone.
- If Enterpryze rejects the addresses, the failure is logged and the document is still sent, without bill-to or ship-to codes.
Enterpryze Shipment
As well as the shared settings above, deliveries have these:
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Link to original document linkToOriginalDocument | Links the Enterpryze delivery back to the sales order it came from. | On or off. | To keep the delivery connected to its order. |
Original document type originalDocumentType | The type of document to link to. | Typically a sales order. | With linkToOriginalDocument. |
Original document reference type originalDocumentReferenceType | The reference type used to find the original document. | Reference type. | With linkToOriginalDocument. |
Enterpryze Invoice: reserve invoices and payments
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
All invoices as reserve createInvoicesAsReserve | Creates every invoice as a reserve (draft) invoice, whatever its financial status. | On or off. | To add a check before invoices are finalised. |
Paid invoices as reserve createPaidInvoicesAsReserve | Creates invoices for paid orders as reserve invoices. | On or off. | So paid invoices aren't finalised straight away. |
Fallback warehouse fallbackWarehouseCode | The warehouse code sent on every line of an invoice that isn't a reserve invoice. Enterpryze requires one, and the invoice carries no location. | Warehouse code. Blank: a non-reserve invoice fails translation. Reserve invoices are always sent without one. | Always set it unless every invoice is reserve. |
Payment by financial status generatePaymentByFinancialStatusMap | Whether a payment is generated in Enterpryze for invoices in each financial status. | Map of status to true or false, with a default. An invoice worth nothing never gets a payment. | When prepaid orders should be marked paid. |
Payment on resend sendPaymentOnResend | Generates a payment even when an invoice is resent rather than created for the first time. | On or off. | When resent invoices should still get payments. |
Payment equals created total setPaymentAmountToCreatedInvoiceTotal | Sets the payment to the invoice total as created in Enterpryze, not the source amount. | On or off. | When Enterpryze adjusts or rounds totals. |
Transfer account by tag transferAccountTagMap | Maps order tags to the transfer account used for payments. | Tag map. | When different kinds of order pay into different accounts. |
Enterpryze Product Update
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Product update mode productUpdateMode | Whether product updates create products, update them, or both. | None, Create, Update or CreateAndUpdate. Default CreateAndUpdate. | To stop Supply Lens creating, or changing, items in the item master. |
Default sell price list defaultSellPricePriceListNumberMap | Maps tags to the price list number used as the default selling price. First match wins. | Tag map with a default. | To choose the price list products are priced from. |
Enterpryze Inventory
| Setting | What it does | Values / default | When to change it |
|---|---|---|---|
Last import date lastImportDate | When inventory was last imported; updated after each run. | Managed by the system. | Don't edit it by hand. |
Warehouses to include includedWarehouseCodes | When not empty, only stock from these warehouse codes is imported. | List. | To sync stock from some warehouses only. |
Warehouses to exclude excludedWarehouseCodes | Stock from these warehouse codes is skipped. | List. | To leave out quarantine or returns warehouses, for example. |