Skip to main content

Acumatica Mapping Functions

Reference for the Acumatica-specific functions you can use in Dynamic Formula mappings and mapping collection filters.

Overview

The Acumatica integration provides a set of ready-made functions you can call when building mappings. They handle common lookups and conversions against your Acumatica instance and your iPaaS.com data, such as finding an Acumatica customer by email, checking whether a product exists, or resolving a tax or warehouse ID, so you don't have to write that logic yourself.

Where you can use these functions

These functions are available anywhere you write a formula for the Acumatica integration:

  • Dynamic Formula mappings: where a destination field's value is produced by a formula rather than mapped directly from a source field.

  • Mapping collection filters: where a formula decides whether a record should be processed.

  • Error filters: a mapping collection's error filter, which sits alongside its collection filter. When the error filter's formula resolves to true, the transfer raises an error that is held in the Error Logs for review and is not retried automatically.

  • Translation collections: where a translation entry uses a formula as its source value.

How to use them

  • Call a function by name and pass the values it needs in parentheses, for example: await GetCustomerIdByEmail(emailAddress).

  • Each function's signature shows its name, the parameters it accepts (with their types), and the type of value it returns. Use it as the reference for exactly how to call the function.

  • Function names and formula syntax are case-sensitive, so type each name exactly as shown. Whether the values a function matches are treated as case-sensitive varies by function, and is called out in the relevant parameter's description.

  • Every function that returns a Task is asynchronous and must be called with await, as shown in each How to call it example.

  • Optional parameters are marked in the parameter table, along with the value used when you omit them.

  • Each function runs at sync time, against the data in your connected Acumatica instance and your iPaaS.com subscription.

The functions are grouped below by the area of the integration they support.

Customers

Use these when mapping customer references between iPaaS.com and Acumatica.

GetCustomerIdByEmail

What it does: Looks up an Acumatica customer by an iPaaS.com customer email and returns the Acumatica customer ID. Returns nothing if no customer matches.

Signature: Task<string> GetCustomerIdByEmail(object emailAddress)

How to call it: await GetCustomerIdByEmail(emailAddress)

Parameter

Type

Required

Default

Description

emailAddress

object

Yes

N/A

The iPaaS.com customer email address to search Acumatica for.

Returns: string. The matched Acumatica customer ID, or nothing if no customer matches.

Example: "beverly@abakery.example.com" returns "ACU-1001".

When to use it: When mapping a customer reference to Acumatica and you have the customer's email.

GetCustomerByEmail

What it does: Searches Acumatica for a customer by an iPaaS.com customer email, checking the billing, shipping, primary, and main contacts, and returns the matching Acumatica customer record.

Signature: Task<object> GetCustomerByEmail(object emailAddress)

How to call it: await GetCustomerByEmail(emailAddress)

Parameter

Type

Required

Default

Description

emailAddress

object

Yes

N/A

The iPaaS.com customer email address to search Acumatica for (a string, or an object containing one).

Returns: object. The matching Acumatica customer record, or nothing if no customer matches.

Example: "beverly@abakery.example.com" returns the matching Acumatica customer record.

When to use it: When you need the full Acumatica customer record (billing and shipping contact data) for mapping or validation.

GetAcumaticaCustomerId

What it does: Resolves the Acumatica customer ID for a transaction, using its iPaaS.com transaction tracking ID.

Signature: Task<string> GetAcumaticaCustomerId(string transactionTrackingId)

How to call it: await GetAcumaticaCustomerId(transactionTrackingId)

Parameter

Type

Required

Default

Description

transactionTrackingId

string

Yes

N/A

The iPaaS.com transaction tracking ID (format: two IDs separated by a pipe, for example "14802|1412").

Returns: string. The Acumatica customer ID for the transaction, or nothing if not found.

Example: "14802|1412" returns "ACU-2002".

When to use it: When mapping a transaction's customer to Acumatica from the iPaaS.com transaction tracking ID.

Sales Orders

Use these when mapping transaction (sales order) data from iPaaS.com.

GetIPaaSTransactionNoById

What it does: Retrieves the transaction number from iPaaS.com for the given iPaaS.com transaction ID.

Signature: Task<string> GetIPaaSTransactionNoById(string transactionId)

How to call it: await GetIPaaSTransactionNoById(transactionId)

Parameter

Type

Required

Default

Description

transactionId

string

Yes

N/A

The iPaaS.com transaction ID to look up.

Returns: string. The iPaaS.com transaction number, or nothing if not found.

Example: "123456" returns "TRX-2025-000123".

When to use it: When you need the transaction number for a transaction identified by its iPaaS.com ID.

GetIPaaSTransactionLinesByTransactionId

What it does: Retrieves a transaction's line items from iPaaS.com for the given iPaaS.com transaction ID.

Signature: Task<List<TransactionLineResponse>> GetIPaaSTransactionLinesByTransactionId(string transactionId)

How to call it: await GetIPaaSTransactionLinesByTransactionId(transactionId)

Parameter

Type

Required

Default

Description

transactionId

string

Yes

N/A

The iPaaS.com transaction ID to look up.

Returns: List<TransactionLineResponse>. The iPaaS.com transaction's line items, or nothing if not found.

Example: "123456|789123" returns the transaction's line items.

When to use it: When you need the line items for a transaction identified by its iPaaS.com ID.

Items and Inventory

Use these when mapping product, inventory, and warehouse data.

CheckProductExistBySku

What it does: Checks whether a product exists in Acumatica by SKU. Returns true when the stock item exists, otherwise false.

Signature: Task<bool> CheckProductExistBySku(object sku)

How to call it: await CheckProductExistBySku(sku)

Parameter

Type

Required

Default

Description

sku

object

Yes

N/A

The iPaaS.com product SKU to check for in Acumatica.

Returns: bool. True when a matching Acumatica stock item exists; otherwise false.

Example: "ACU-ORDER" returns true when the SKU is found.

When to use it: Before creating or mapping order lines, to confirm the product exists in Acumatica.

GetWarehouseBySku

What it does: Retrieves the default warehouse ID for a product in Acumatica, using its SKU.

Signature: Task<string> GetWarehouseBySku(object sku)

How to call it: await GetWarehouseBySku(sku)

Parameter

Type

Required

Default

Description

sku

object

Yes

N/A

The iPaaS.com product SKU.

Returns: string. The product's default Acumatica warehouse ID, or nothing if none is set.

Example: "ACU-STOCK1" returns "MAIN".

When to use it: When mapping a product's default warehouse from Acumatica by SKU.

ConvertAcumaticaAttributNameToIpaasLocationId

What it does: Converts an Acumatica warehouse name to its corresponding iPaaS.com location ID.

Signature: Task<string> ConvertAcumaticaAttributNameToIpaasLocationId(object attributeName)

How to call it: await ConvertAcumaticaAttributNameToIpaasLocationId(attributeName)

Parameter

Type

Required

Default

Description

attributeName

object

Yes

N/A

The Acumatica warehouse name (for example "MAIN").

Returns: string. The corresponding iPaaS.com location ID, or nothing if the warehouse name is not mapped.

Example: "MAIN" returns "287".

When to use it: When mapping an Acumatica warehouse to the matching iPaaS.com location.

Codes and Lookups

Use these when mapping tax codes, tax zones, and tax details.

GetTaxId

What it does: Retrieves a tax ID from Acumatica. If a specific tax ID is provided, it returns the matching one; otherwise it returns the first available tax ID.

Signature: Task<string> GetTaxId(object taxId = null)

How to call it: await GetTaxId(taxId)

Parameter

Type

Required

Default

Description

taxId

object

No

null

Optional iPaaS.com tax ID to match (a string or object). When omitted, the first Acumatica tax ID is returned.

Returns: string. The matched Acumatica tax ID (or the first available), or nothing if none exist.

Example: "TAX001" returns "TAX001" when a matching tax is found.

When to use it: When mapping a tax to Acumatica, optionally by a specific tax ID.

GetTaxZoneId

What it does: Retrieves a tax zone ID from Acumatica. If a specific tax zone ID is provided, it returns the matching one; otherwise it returns the first available tax zone ID.

Signature: Task<string> GetTaxZoneId(object taxZoneId = null)

How to call it: await GetTaxZoneId(taxZoneId)

Parameter

Type

Required

Default

Description

taxZoneId

object

No

null

Optional iPaaS.com tax zone ID to match (a string or object). When omitted, the first Acumatica tax zone ID is returned.

Returns: string. The matched Acumatica tax zone ID (or the first available), or nothing if none exist.

Example: "DEFAULT-ZONE" returns "DEFAULT-ZONE" when a matching tax zone is found.

When to use it: When mapping a tax zone to Acumatica, optionally by a specific tax zone ID.

GetTaxDetailExternalId

What it does: Retrieves the Acumatica tax detail external ID that is mapped in iPaaS.com for a transaction tax.

Signature: Task<string> GetTaxDetailExternalId(object spaceport_sourceId, object spaceport_systemId)

How to call it: await GetTaxDetailExternalId(spaceport_sourceId, spaceport_systemId)

Parameter

Type

Required

Default

Description

spaceport_sourceId

object

Yes

N/A

The iPaaS.com internal ID for the transaction tax (the source ID).

spaceport_systemId

object

Yes

N/A

The iPaaS.com system ID associated with the transaction tax detail.

Returns: string. The Acumatica tax detail external ID mapped in iPaaS.com, or nothing if none is present.

Example: source ID "14563" and system ID "16061" return "ACU-TAX-DET-001".

When to use it: When resolving the Acumatica external ID for a transaction tax detail.

Shipments

Use this when mapping shipping method data.

FindShippingMethodFromName

What it does: Searches iPaaS.com for a shipping method by name and returns the matching iPaaS.com shipping method name. Returns nothing if no match is found.

Signature: Task<string> FindShippingMethodFromName(string name)

How to call it: await FindShippingMethodFromName(name)

Parameter

Type

Required

Default

Description

name

string

Yes

N/A

The shipping method name to search for in iPaaS.com (for example "Standard Ground").

Returns: string. The matching iPaaS.com shipping method name, or nothing if no method matches.

Example: "Standard Ground" returns "Standard Ground".

When to use it: When mapping a shipping method by name.

Related Documents

Did this answer your question?