Skip to main content

iPaaS.com to Jobber Request Mapping Documentation

How iPaaS.com orders that include service work are sent to Jobber as work requests, with a child collection for the line items.

Summary

Jobber work requests can be created from iPaaS.com orders through iPaaS.com outbound events (transaction/created and transaction/updated) or a Manual Sync. Each order that includes service work becomes a work request for the client linked to the order's customer, at the client's matching property, with the order's lines as its line items and a note that carries the order number, total, amount paid and status, so a prepaid order is not billed twice. The parent collection Add/Update Jobber Request FROM iPaaS.com writes the work request, and its child collection Add/Update Jobber Request Line FROM iPaaS.com writes the line items.

ID Format

Manual Sync ID Format

Enter the iPaaS.com id of the order (transaction) on the iPaaS.com Manual Sync page: the numeric id shown on the transaction's page in iPaaS.com, for example 177244. The order must still pass the parent collection's filter, or it is skipped.

External ID Format

After a successful transfer, iPaaS.com saves the work request's Jobber API id as the order's external ID, a Base64 text id that begins with Z2lkOi8vSm9iYmVyL1JlcXVlc3Qv (the encoded form of gid://Jobber/Request/ followed by the work request's number). Later transfers of the same order find the work request through that link and update its title instead of creating a second request.

Deleted Record Support

Deleting an order in iPaaS.com does not delete the work request in Jobber. A delete request is refused with JOBR-VALD-1004, and delete mappings are not included in the default templates. Archive the work request in Jobber by hand when it is no longer needed.

Custom Field Support

iPaaS.com order custom fields are not written to Jobber work requests. This direction does not support custom fields.

Mapping Collection Status

  • Status: Disabled until you replace the placeholder in the parent collection's mapping filter (see Mappings). The child collection is Enabled and runs only with its parent.

  • Trigger Events: the iPaaS.com events transaction/created and transaction/updated, and Manual Sync. Whether a work request is created or updated depends on whether the order is already linked to a Jobber work request, not on which event arrived.

Duplicate or Conflicting Mappings

  • Add/Update Jobber Invoice TO iPaaS.com: sends Jobber invoices to iPaaS.com as transactions of type Invoice, which this collection's filter does not send back. If you edit either filter, keep the two from covering the same transactions.

If you add a second collection of this type, give the two filters no order in common: every collection whose filter matches an order runs, and each would create its own work request.

There is no Collision Handling Method to set on this collection. An order that is not linked to a work request yet always creates a new work request; the integration does not look for an existing request in Jobber. The order's customer is matched to a Jobber client through Add/Update Jobber Client FROM iPaaS.com, whose own Collision Handling Method applies.

Supported Child Collections

  • Parent Collection: Add/Update Jobber Request FROM iPaaS.com creates the work request and updates its title.

  • Child Collection: Add/Update Jobber Request Line FROM iPaaS.com sends the order's lines as the work request's line items when the request is created. It has no trigger of its own and no Manual Sync entry; to send an order's lines, send the order.

System Caveats

Jobber Caveats

  • A client is required: Jobber needs a client on every work request, and a name on every line item. A line that ends up with no name is left off the work request without an error.

  • Linked client deleted in Jobber: if the client linked to the order's customer was deleted in Jobber, the transfer stops with JOBR-VALD-1003. Remove the customer's Jobber external ID in iPaaS.com, then resend the customer and the order.

  • Note refused: if Jobber creates the work request but refuses its note, the work request stays linked to the order and the transfer reports JOBR-VALD-1010. Add the note to the work request in Jobber by hand if your team needs it.

  • Rate limiting: Jobber limits how much an app can request from its API in a short time. When the limit is reached, the transfer is rescheduled automatically to run once the limit resets; no action is required.

iPaaS.com Caveats

  • The order needs a customer: the work request is created for the order's iPaaS.com customer, so an order with no customer, or whose customer cannot reach Jobber, is not sent (see Prerequisite Handling).

  • Filtered orders log nothing: orders the filter skips are not sent and log no error.

Integration-Specific Caveats

  • Updates change the title only: with transaction/updated on, a later change to the order updates only the work request's title. Line changes, address changes and the note are not sent again, and cancelling the order does not archive the request. The note is added only when the work request is created. Edit or archive the request in Jobber by hand.

  • Lines are sent once: lines are sent, in the order's line order, only when the work request is created. Lines added to or changed on the order afterwards do not reach Jobber.

  • Property selection: the work request is placed at the client's Jobber property whose first street line matches ServiceStreet1, ignoring case and surrounding spaces. Only the client's first 20 properties are compared. When no property matches, or ServiceStreet1 is empty, the work request goes to the client's first property, and a client with no property gets a work request with no property. The property is chosen only when the work request is created; a later change to the order's address does not move it.

  • Product linking: a line item is linked to a Jobber product or service only when the line's SKU belongs to an iPaaS.com product that is already linked to a Jobber item. Order lines are never saved as new products or services in Jobber.

Setup Requirements

iPaaS.com Configuration

  • Replace the filter placeholder: in the parent collection's mapping filter, replace the text REPLACE with your service SKU prefix with the SKU prefix your service items share, for example SVC- (see Mappings).

  • Outbound Data Flows: in the subscription configuration's Outbound Data Flows section, turn on the iPaaS.com event transaction/created, and also transaction/updated if a changed order should update the work request's title. No automatic transfers occur until these events are turned on.

  • Client collection: keep Add/Update Jobber Client FROM iPaaS.com turned on, so the order's customer can be sent to Jobber first.

  • Product or Service collection (recommended): send your service products to Jobber through Add/Update Jobber Product or Service FROM iPaaS.com before the orders that use them, so line items link to Jobber items.

The Outbound Data Flows section with transaction/created and transaction/updated turned on

Jobber Configuration

No Jobber-side setup is required beyond the connection described in the Jobber Installation Instructions and Jobber Connections and Settings articles.

Integration Flow

  1. An order is created or changed in iPaaS.com, or is sent by Manual Sync. The parent collection's filter decides whether it is sent; skipped orders log no error.

  2. When the order has a customer that is not linked to a Jobber client yet, the integration sends the customer to Jobber first through Add/Update Jobber Client FROM iPaaS.com, in the same transfer. A customer that is already linked is not sent again. That collection's filter and its Collision Handling Method apply.

  3. The mappings run. The integration finds the Jobber client from ClientId, or, when that is empty, from the client linked to IpaasCustomerId. When neither gives a client, for example because the customer's own transfer was skipped or failed, no work request is created and the transfer stops with JOBR-VALD-1011.

  4. For a new work request, the integration reads the client's properties in Jobber (the first 20) and picks the property whose first street line matches ServiceStreet1, else the client's first property.

  5. A new order creates the work request with its title, property and line items from Add/Update Jobber Request Line FROM iPaaS.com. iPaaS.com links the order to the work request; the line items are kept on the work request.

  6. For a new work request, the note from the Note mapping is added to the request.

  7. An order that is already linked to a work request updates only the request's title. When the Title mapping is empty, nothing is changed.

A Jobber work request created from an iPaaS.com order

The line items on the Jobber work request

Prerequisite Handling

When the order's customer is not linked to a Jobber client yet, the integration sends the customer to Jobber automatically before the work request. You do not need to send the customer first.

If the customer cannot be sent, for example because the client collection's filter skips it or its own transfer fails, the work request is not created and the transfer stops with JOBR-VALD-1011. iPaaS.com retries the order, and it keeps failing until the customer reaches Jobber. Check that Add/Update Jobber Client FROM iPaaS.com is on and that its filter accepts the customer (a first and last name, or a company), fix the error on the customer's own transfer, then resend the order.

Mappings

Add/Update Jobber Request FROM iPaaS.com

iPaaS.com data type: Transaction

Mapping Filter

// Sends orders that include service work: a line whose SKU starts with your service SKU prefix.
// (Required.) Replace the text in quotes with that prefix; until then no order is sent.
return Type == "Order" && Lines != null && Lines.Any(l => l.Sku != null && l.Sku.StartsWith("REPLACE with your service SKU prefix"));

Filter Description: only transactions whose Type is Order and that have at least one line whose Sku starts with your service SKU prefix are sent. Orders of any other type, orders without lines, and orders with no line carrying the prefix are skipped with no error. Invoices that the integration sends TO iPaaS.com arrive with the type Invoice, so they are never sent back to Jobber as work requests.

Placeholder value — replace during implementation: the filter compares each line's SKU with the text REPLACE with your service SKU prefix. Replace that text with the SKU prefix your service items share, keeping the quotation marks: for example, if your service SKUs look like SVC-LAWN-01, replace it with SVC-. The comparison is case-sensitive and checks the start of the SKU only. Until the placeholder is replaced, no order is sent and the collection is effectively disabled.

Description: creates a Jobber work request from an iPaaS.com order for the client linked to the order's customer, and updates the work request's title when the order changes.

Mapping Type

Source Field (iPaaS.com)

Destination Field (Jobber)

Description

Dynamic Formula

Multi-line formula ClientId, shown in full after this table

ClientId

Required. The Jobber client the work request is for: the client linked to the order's iPaaS.com customer. When this mapping returns no client, the integration uses IpaasCustomerId instead; when neither gives a client, the transfer stops with JOBR-VALD-1011.

Field

CustomerId

IpaasCustomerId

Recommended. The iPaaS.com customer on the order, used to find its linked Jobber client when ClientId is empty.

Dynamic Formula

Multi-line formula Title, shown in full after this table

Title

Recommended. The work request's title: Order followed by the order number, It is the only part of the work request an order change updates. When empty, a new work request is titled Order from iPaaS.com and an existing one keeps its title.

Dynamic Formula

Multi-line formula ServiceStreet1, shown in full after this table

ServiceStreet1

Recommended. The street where the work is done: the first line of the order's primary shipping address, or of its first address when none is marked primary shipping. Picks the client's matching Jobber property (see Property selection).

Dynamic Formula

Multi-line formula Note, shown in full after this table

Note

Recommended. A note added to the new work request with the order number, total, the sum of the order's payments and the order status, for example, for an order with a total of 85 and no payments, the note reads iPaaS.com order, the order number, then : total 85.0, paid 0, status Pending. Added on create only. Without this mapping the work request has no note.

The multi-line formulas, verbatim:

ClientId

// The Jobber client linked to the order's customer.
return await GetExternalIdAsync(CustomerId, "Customer", SpaceportSystemId);

Title

// "Order " and the order number.
return "Order " + TransactionNumber;

ServiceStreet1

// The street of the shipping address, else of the first address.
string street = null;
if (Addresses != null) { foreach (var a in Addresses) { if (a.IsPrimaryShipping == true) { return a.Address1; } if (street == null) { street = a.Address1; } } }
return street;

Note

// The order's total, amount paid and status, so a prepaid order is not billed twice.
decimal paid = 0;
if (Payments != null) { foreach (var p in Payments) { paid += Convert.ToDecimal(p.Amount); } }
return "iPaaS.com order " + TransactionNumber + ": total " + Total + ", paid " + paid + ", status " + Status + ".";

Add/Update Jobber Request Line FROM iPaaS.com

iPaaS.com data type: Transaction Line

Description: sends the order's lines as the line items of the new work request. This collection has no mapping filter: every line of an order that passes the parent collection's filter is sent.

Mapping Type

Source Field (iPaaS.com)

Destination Field (Jobber)

Description

Dynamic Formula

Multi-line formula Name, shown in full after this table

Name

Required. The line item's name: the order line's description, or its SKU when the line has no description. A line that ends up with no name is left off the work request without an error.

Field

Description

Description

Optional. The order line's description, shown as the line item's description. A line without one is sent with an empty description.

Dynamic Formula

Multi-line formula ProductId, shown in full after this table

ProductId

Recommended. Links the line item to the Jobber product or service for the line's SKU. When the product is not in iPaaS.com or not linked to a Jobber item, the line item is sent without an item, using the name, quantity and price from the order.

Field

Qty

Quantity

Recommended. The order line's quantity. A line without a quantity is sent with a quantity of 1.

Field

UnitPrice

UnitPrice

Recommended. The order line's unit price. A line without a unit price is sent with a unit price of 0.

Name

// The line's description, else its SKU.
return string.IsNullOrEmpty(Description) ? Sku : Description;

ProductId

// The Jobber item linked to the line's product, when there is one.
var productId = await ProductIdFromSku(Sku);
return string.IsNullOrEmpty(productId) ? null : await GetExternalIdAsync(productId, "Product", SpaceportSystemId);

Error Handling

Errors appear in Dashboard / Integration Monitoring / Error Logs. The full list is in the Jobber Error Messages article.

  • JOBR-VALD-1011: "The order's customer is not in Jobber yet, so the work request can't be created. The integration sends the customer first; if this persists, check that the Customer FROM iPaaS.com filter accepts the customer, and the customer's own transfer for an error." The customer's own transfer was skipped by the client collection's filter or failed. Resolution: check that Add/Update Jobber Client FROM iPaaS.com is on and that its filter accepts the customer (a first and last name, or a company), fix the customer's own transfer error, then resend the order. iPaaS.com retries the order automatically.

  • JOBR-VALD-1003: "Jobber client {id} no longer exists. Remove the customer's Jobber link in iPaaS.com and send the order again." The client linked to the order's customer was deleted in Jobber. Resolution: remove the customer's Jobber external ID in iPaaS.com, then resend the customer and the order.

  • JOBR-VALD-1010: "The work request was created in Jobber, but its note was not added: {reason}" The work request exists and is linked to the order. Resolution: add the note in Jobber by hand if your team needs it.

  • JOBR-VALD-1002: "The order has no Jobber work request id to update." An update arrived for an order with no linked work request. Resolution: resend the order so it is created, or link it to its Jobber work request.

  • JOBR-VALD-1004: "Deleting invoices or work requests in Jobber is not supported by this integration." A delete was requested. Resolution: archive the work request in Jobber by hand.

  • JOBR-EXTN-1003: "Jobber request limit reached while {action}: retry after {n}s." (or "Jobber query cost limit reached while {action}: retry after {n}s.") Jobber's rate limit was reached. Resolution: no action; iPaaS.com retries automatically after the limit resets.

Testing & Validation

Test Scenarios

  1. Create an order in iPaaS.com with a customer already in Jobber and a line whose SKU starts with your service SKU prefix. Verify a work request is created for that client with the order's title, line items and note.

  2. Create an order whose customer is not in Jobber yet. Verify the customer is created as a Jobber client first and the work request is created for it.

  3. Change the order number of a sent order with transaction/updated on. Verify the same work request's title changes and nothing else does.

  4. Send an order with no line carrying the prefix, and a transaction of type Invoice. Verify neither is sent and no error is logged.

  5. Send an order whose customer the client collection's filter skips (no first and last name, and no company). Verify the transfer stops with JOBR-VALD-1011.

  6. Send an order by Manual Sync using its iPaaS.com transaction id. Verify the work request is created.

  7. For a client with two properties, send an order whose shipping street matches the second property. Verify the work request is placed at that property.

  8. Send an order with a line whose SKU belongs to a product already sent to Jobber. Verify that line item is linked to the Jobber product or service.

Validation Checklist

  • The filter placeholder is replaced with your service SKU prefix.

  • transaction/created (and, if wanted, transaction/updated) is turned on in Outbound Data Flows.

  • Add/Update Jobber Client FROM iPaaS.com is on and its filter accepts your customers.

  • Work requests appear in Jobber with the right client, property, title, line items and note.

  • The order shows the work request's Jobber API id as its external ID.

  • No unexpected errors in Dashboard / Integration Monitoring / Error Logs.

Additional Notes

  • Jobs and quotes: orders become work requests only, never Jobber jobs or quotes. Your team converts the request in Jobber.

  • Order custom fields: iPaaS.com order custom fields are not written to Jobber work requests.

  • Deletes and cancellations: deleting or cancelling an order in iPaaS.com does not delete or archive the work request in Jobber.

Related Documents

Related Mapping Documentation

Did this answer your question?