NCR Counterpoint to iPaaS.com Order Release Mapping Documentation

When an order is released for shipment in NCR Counterpoint, Counterpoint creates a release ticket recording what actually went out. This mapping collection transfers that release ticket into iPaaS.com as a shipment, linked back to the order it was released from, so that a system reading iPaaS.com can see what shipped against an order without reading Counterpoint directly. It carries the release ticket's own number, its type and status, the billing email address that ties it to a customer, and its tax, shipping, subtotal, and total figures.

This family does not itself carry deletions. Where a separate Delete collection exists for this entity it handles removals from Counterpoint to iPaaS.com; otherwise a removal in Counterpoint is not propagated. See NCR Counterpoint Known Limitations.

Source: SpaceportSystemId · Destination: SystemId

This is a required field on a newly created shipment — iPaaS.com rejects it without one, and the value must be greater than zero. Records which connected system the shipment originated in, so that the transaction can be attributed back to its source. The value is supplied automatically by iPaaS.com for the subscription running the transfer — subscribers or their MiSP do not configure it and should not replace it with a fixed value, as a hardcoded or zero value causes the transfer to be rejected. On a shipment that already exists in iPaaS.com the field cannot be changed and is ignored, so this mapping has no effect on the update half of this collection's sync.

Source: TKT_NO · Destination: TransactionNumber

This is a required field — iPaaS.com rejects the shipment without it. The release ticket number as assigned in NCR Counterpoint. Counterpoint stores this as text of up to 15 characters and always populates it, so a value always arrives. This is the number subscribers or their MiSP use to identify the shipment in both systems. Note that it is the release ticket's own number, not the number of the order it was released from — the two are different, and the link back to the order is carried by the ParentId mapping below.

Source: await DocumentSpacePortIdFromDocIdAsync(ORIG_ORD_DOC_ID) · Destination: ParentId

This is an optional field that references the iPaaS.com transaction id. Links the shipment back to the order it was released from, which is what allows a system reading iPaaS.com to tell which order a shipment belongs to. iPaaS.com identifies the order by its own internal id, so the Counterpoint document reference cannot be sent directly: the formula takes the originating order's Counterpoint document reference from the release ticket and looks up the matching transaction already transferred into iPaaS.com.

When no matching transaction is found — because the order has not been transferred, or the ticket carries no originating order — the formula produces no value and the shipment transfers unlinked. It does not fail the transfer, and it does not transfer the order on its own. Subscribers or their MiSP who want shipments linked to their orders MUST have the orders transferring into iPaaS.com before enabling this collection; a shipment that transfers unlinked stays unlinked until it is transferred again.

Source: Shipment · Destination: Type

This is a required field — iPaaS.com rejects the transaction without it. Allowed values: Order, Shipment, Invoice, Hold, Quote, Ticket, Return, Validated Return, and Job. The value is fixed at Shipment because every record this collection produces is a Counterpoint release ticket, which is by definition a shipment against an order. Subscribers or their MiSP replacing this mapping must supply one of the allowed values; any other value causes the transfer to fail.

Source: Complete · Destination: Status

This is a required field — iPaaS.com rejects the transaction without it. Allowed values: Pending, Complete, Cancelled, Shipped, Backorder, Refunded, Partially Refunded, Partially Shipped, Awaiting Pickup, Awaiting Payment, On Hold, Processing, Returned, and Draft. The value is fixed at Complete because NCR Counterpoint creates the release ticket at the point the goods are released, so the shipment it represents has already happened by the time it reaches iPaaS.com. Subscribers or their MiSP replacing this mapping must supply one of the allowed values; any other value causes the transfer to fail.

Source: BILL_EMAIL_ADRS_1 · Destination: EmailAddress

This is a conditionally required field, and in this collection it is the field that satisfies the condition. iPaaS.com requires every transaction to be tied to a customer, and accepts any one of a customer id, a company id, or an email address to make that tie; a transaction supplying none of the three is rejected. This collection maps neither a customer id nor a company id, so the email address is the only thing tying the shipment to a customer — a release ticket that reaches this mapping with no billing email address is rejected.

The billing email address recorded on the release ticket in NCR Counterpoint. Counterpoint stores this as text of up to 50 characters and permits it to be empty. Subscribers or their MiSP whose Counterpoint orders can be taken without a billing email address should confirm this before enabling the collection, and either ensure the address is captured in Counterpoint or map a customer id in its place.

Source: TAX_AMT · Destination: TaxAmount

This is a recommended field. iPaaS.com accepts the shipment without it, but the tax total is what allows the shipment's figures to be reconciled against the order, so it should be mapped for any meaningful order sync. The total tax on the release ticket, as calculated by NCR Counterpoint and held to two decimal places. This is the ticket's single tax total; the breakdown by taxing authority is carried separately by Add/Update NCR Counterpoint Order Release Tax TO iPaaS.com.

Source: MISC_AMT_1 · Destination: ShippingAmount

This is a recommended field. iPaaS.com accepts the shipment without it, but the shipping charge is generally needed to reconcile the shipment total, so it should be mapped for any meaningful order sync. NCR Counterpoint does not hold a dedicated shipping charge on a ticket — it provides a set of numbered miscellaneous charge amounts that each installation assigns its own meaning to. This mapping reads the first of those and sends it as the shipping amount.

That is a configuration assumption, not a Counterpoint rule. Subscribers or their MiSP whose Counterpoint installation records freight in a different miscellaneous charge, or uses the first one for something other than shipping, MUST repoint this mapping before enabling the collection — otherwise iPaaS.com receives an unrelated charge as the shipping amount, and it arrives looking like a valid figure.

Source: SUB_TOT · Destination: Subtotal

This is a recommended field. iPaaS.com accepts the shipment without it, but the subtotal is what allows the shipment's figures to be reconciled against its lines, so it should be mapped for any meaningful order sync. The value of the goods on the release ticket before tax and charges, as calculated by NCR Counterpoint. This reflects only what was released on this ticket, not the value of the whole order — an order released in several shipments produces a subtotal per shipment.

Source: TOT · Destination: Total

This is a recommended field. iPaaS.com accepts the shipment without it, but the total is the headline figure most systems reading iPaaS.com rely on, so it should be mapped for any meaningful order sync. The full value of the release ticket as calculated by NCR Counterpoint, covering the goods released, tax, and charges. Like Subtotal, this is the value of this shipment rather than of the whole order.

Parent: Add/Update NCR Counterpoint Order Release TO iPaaS.com.

Source: Product · Destination: Type

This is a required field — iPaaS.com rejects the line without it. Allowed values: Product and Giftcard. The value is fixed at Product because this collection transfers the goods released against an order.

This value also decides how iPaaS.com treats the Sku mapping below: because the type is Product, iPaaS.com requires the SKU to resolve to a product or variant that already exists. Subscribers or their MiSP replacing this mapping must supply one of the two allowed values; any other value causes the transfer to fail.

Source: await LineSpacePortIdFromDocIdAsync(Parent.ORIG_ORD_DOC_ID, LINK_LIN_GUID) · Destination: ParentId

This is an optional field that references an iPaaS.com transaction line id. Links this shipment line back to the specific order line it was released from, which is finer-grained than the shipment-to-order link carried on the release ticket itself: it tells a system reading iPaaS.com which of an order's lines this shipment satisfied.

The lookup runs in several steps, and produces no value if any of them cannot be completed. It reads the originating order reference from the parent release ticket and the internal reference that Counterpoint records on the release line to identify the order line it came from. Both must be present. It then finds that order line in NCR Counterpoint, including on orders that have already been posted to history, and reads its line sequence number. It resolves the originating order to the matching transaction already transferred into iPaaS.com, and finally selects the line on that transaction whose sequence number matches.

That last step is what makes the link depend on configuration: the iPaaS.com line's sequence number must be the same as the Counterpoint order line's sequence number. For orders written into Counterpoint from iPaaS.com, Add NCR Counterpoint Order Line FROM iPaaS.com carries the iPaaS.com sequence number onto the Counterpoint line, which satisfies the requirement. Subscribers or their MiSP who have changed that mapping, or whose orders reach Counterpoint by some other route, should expect shipment lines to transfer without the link.

When any step fails to resolve, the mapping produces no value and the line transfers unlinked. It does not fail the transfer, and it does not transfer the order or its lines on its own.

Source: SEQ_NO · Destination: SequenceNumber

This is an optional field. The line's position on the release ticket in NCR Counterpoint, which is what keeps the shipment's lines in the same order in iPaaS.com as they appear in Counterpoint. Counterpoint stores this as a whole number and always populates it. Note that this is the line's sequence on the release ticket, not on the original order — the two need not agree, and the link back to the order line is carried by ParentId above rather than by this number.

Source: Pending · Destination: Status

This is a required field — iPaaS.com rejects the line without it. Allowed values: Pending, Complete, Cancelled, Shipped, Backorder, Refunded, Partially Refunded, Partially Shipped, Awaiting Pickup, Awaiting Payment, On Hold, Processing, Returned, and Draft — the same set the shipment itself accepts. The value is fixed at Pending for every line this collection produces.

The shipment that carries these lines is transferred with a status of Complete, so the line status does not restate the shipment's own status. Subscribers or their MiSP whose downstream systems read line status and expect it to reflect what has shipped should replace this mapping with the value their process requires, drawn from the list above; any value outside that list causes the transfer to fail.

Source: (ITEM_NO + (DIM_1_UPR == "*" ? "" : "|" + DIM_1_UPR) + (DIM_2_UPR == "*" ? "" : "|" + DIM_2_UPR) + (DIM_3_UPR == "*" ? "" : "|" + DIM_3_UPR)).TrimEnd() · Destination: Sku

This is a required field in this collection. iPaaS.com does not require a SKU on every line, but it requires the SKU to resolve to a product or variant that already exists whenever the line's type is Product — and the Type mapping above fixes the type at Product, so a line reaching iPaaS.com without a resolvable SKU is rejected.

Identifies which product was released. NCR Counterpoint identifies an item by its item number, and identifies a variant of that item by up to three grid dimensions recorded alongside it, using an asterisk in each dimension the item does not use. The formula rebuilds the same SKU the product collections publish: it starts with the item number and appends each dimension that is actually in use, separated by a vertical bar, skipping any dimension set to an asterisk. A plain item with no dimensions therefore produces just its item number, and a variant produces the item number followed by its dimensions. Trailing spaces are removed from the finished value.

Because the SKU must already exist in iPaaS.com, the products MUST be transferring before this collection is enabled — Add/Update NCR Counterpoint Product TO iPaaS.com for plain items, and Add NCR Counterpoint Product Variant TO iPaaS.com for items sold by grid dimension. A release line for a product that has not been transferred is rejected rather than transferred without its SKU.

Source: QTY_SOLD · Destination: Qty

This is a recommended field. iPaaS.com accepts the line without it, but the quantity is what makes the shipment line meaningful, so it should be mapped for any meaningful order sync. The quantity released on this line, which for a release ticket is the quantity actually going out rather than the quantity originally ordered. Counterpoint always populates it, holds it to four decimal places, and confines it to values between -99,999,999 and 99,999,999.

Source: PRC · Destination: UnitPrice

This is a recommended field. iPaaS.com accepts the line without it, but the unit price is generally needed to reconcile the shipment's figures, so it should be mapped for any meaningful order sync. The price of a single unit of the released item, as held on the release line in NCR Counterpoint. Counterpoint permits this to be empty and confines it to values between -99,999,999 and 99,999,999.

Source: EXT_PRC · Destination: ExtendedPrice

This is a recommended field. iPaaS.com accepts the line without it, but the extended price is what the shipment's subtotal is built from, so it should be mapped for any meaningful order sync. The total value of this line as calculated by NCR Counterpoint, held to two decimal places and always populated. It reflects the quantity released on this ticket, so an order released in several shipments carries a different extended price on each.

Parent: Add/Update NCR Counterpoint Order Release TO iPaaS.com.

Source: PAY_COD · Destination: Method

This is a required field — iPaaS.com rejects the payment without it, and the value must match the name of a payment method already configured in iPaaS.com. The pay code recorded against the payment in NCR Counterpoint. Counterpoint stores this as text of up to 10 characters and permits it to be empty, so a payment line recorded without a pay code is rejected.

Because iPaaS.com matches on the payment method's name, and Add/Update NCR Counterpoint Payment Method TO iPaaS.com publishes each Counterpoint pay code as the method's name, that collection MUST have transferred the subscriber's payment methods before this one is enabled. A payment whose pay code has no matching method in iPaaS.com is rejected, and because the payment is part of the shipment, the shipment does not transfer either. Subscribers or their MiSP should confirm every pay code in use on their release tickets has reached iPaaS.com before enabling this collection.

Source: DESCR · Destination: Description

This is an optional field. The free-text description recorded against the payment line in NCR Counterpoint, carried across unchanged for reference. Counterpoint stores this as text of up to 30 characters and permits it to be empty, in which case the payment transfers without a description.

Source: AMT · Destination: Amount

This is a recommended field. iPaaS.com accepts the payment without it, but a payment with no amount cannot be reconciled against the shipment total, so it should be mapped for any meaningful order sync. The amount taken on this payment line, as recorded in NCR Counterpoint. Counterpoint always populates it and holds it to two decimal places. Where a ticket is settled by more than one method, these amounts together make up what was paid.

Source: Authorized · Destination: Status

This is an optional field. Records the state of the payment in iPaaS.com. The value is fixed at Authorized for every payment this collection produces, because NCR Counterpoint does not carry a payment state on the release ticket's payment lines that this mapping could read. iPaaS.com does not restrict this field to a fixed set of values, so subscribers or their MiSP whose downstream systems expect a different vocabulary — or who can determine the real state of the payment from elsewhere in their Counterpoint installation — can replace this mapping with the value their process requires.

Parent: Add/Update NCR Counterpoint Order Release TO iPaaS.com.

Source: AUTH_COD · Destination: Authority

This is a recommended field. iPaaS.com accepts the tax record without it, but a tax amount that does not say who it is owed to cannot be reconciled or reported on, so it should be mapped for any meaningful order sync. The code identifying the taxing authority in NCR Counterpoint. Counterpoint stores this as text of up to 10 characters and always populates it on a tax record, so a value always arrives.

The value carried across is the Counterpoint authority code itself rather than a descriptive name, so it reads in iPaaS.com exactly as it reads in the subscriber's Counterpoint installation. Subscribers or their MiSP whose downstream systems expect a particular set of authority names should confirm that their Counterpoint codes match before enabling the collection.

Source: TAX_AMT · Destination: Amount

This is a recommended field. iPaaS.com accepts the tax record without it, but an authority with no amount against it carries no information, so it should be mapped for any meaningful order sync. The tax owed to this authority on this release ticket, as calculated by NCR Counterpoint and held to two decimal places. Counterpoint permits it to be empty. This is the tax for one authority on one shipment — where the ticket is taxed by several authorities, these amounts together make up the ticket's tax total, and where an order is released in several shipments each shipment carries its own tax records.

Parent: Add/Update NCR Counterpoint Order Release TO iPaaS.com.

Source: Parent.SHIP_VIA_COD · Destination: ShippingMethod

This is a required field — iPaaS.com rejects the tracking record without it, and the value must match the name of a shipping method already configured in iPaaS.com. The ship-via code recorded on the parent release ticket in NCR Counterpoint. Counterpoint stores this as text of up to 10 characters and permits it to be empty, so a release ticket shipped without a ship-via code produces tracking records that are rejected.

Because iPaaS.com matches on the shipping method's name, and Add/Update NCR Counterpoint Shipping Method TO iPaaS.com publishes each Counterpoint ship-via code as the method's name, that collection MUST have transferred the subscriber's shipping methods before this one is enabled. A tracking record whose ship-via code has no matching method in iPaaS.com is rejected, and because the tracking record is part of the shipment, the shipment does not transfer either. Subscribers or their MiSP should confirm every ship-via code in use on their release tickets has reached iPaaS.com before enabling this collection.

Source: Parent.SHIP_VIA_COD · Destination: ShippingMethodDescription

This is an optional field. Intended to carry a readable description of how the shipment was sent, alongside the method name held by ShippingMethod above.

As shipped, this mapping reads the same ship-via code as ShippingMethod, so both fields arrive in iPaaS.com carrying the identical Counterpoint code, and the description adds nothing the method name does not already say. NCR Counterpoint does hold a description against each ship-via code, and Add/Update NCR Counterpoint Shipping Method TO iPaaS.com publishes it as the shipping method's description in iPaaS.com. Subscribers or their MiSP who need a readable description on the tracking record — for a shipping confirmation sent to a customer, for instance — should replace this mapping with one that supplies that text, and should validate the result in a staging environment before relying on it in production.

Source: PKG_TRK_NO · Destination: TrackingNumber

This is a recommended field. iPaaS.com accepts the tracking record without it, but a tracking record with no number is the one thing the record exists to carry, so it should be mapped for any meaningful order sync. The carrier's tracking number for the package, as recorded against the release ticket in NCR Counterpoint. The value is carried across exactly as Counterpoint holds it, in whatever form the carrier issued it — iPaaS.com does not validate it against a carrier or check that it is well formed, so a mistyped number transfers successfully and only fails when someone tries to use it.

Errors raised while transferring these records surface at Dashboard / Integration Monitoring / Error Logs. The specific messages, their causes and their resolutions are documented in NCR Counterpoint Error Messages. A record stopped by an error is not retried automatically; it must be resolved manually.

These and other runtime behaviors are documented in NCR Counterpoint Known Limitations.