2021-02-11

Creating a Partnership

When creating a partnership, there are two new required fields that provide UX affordances for users of the Routable dashboard.

FieldOptions
default_generalactionable, read_only, none
default_itemactionable, read_only, none

πŸ“˜

Coming Soon

In the future, we will use these settings to streamline API usage provide default contacts when creating payables via the API.

To maintain the behavior present on existing versions of the API when upgrading, you can pass up actionable for both of these fields.

Sending a Partnership Invite

Inviting a partnership to onboard requires specifying the contacts that should be sent the invite.

In previous versions, we sent invites to all the external company's contacts and allowed them to fill in their payment information.

This change is to enable more control over which contacts receive invites and which contacts are eligible to fill in the requested information.

To maintain the existing behavior when upgrading, you must do two things:

Creating an Item

Creating an item requires setting the access_item attribute for its Item Members.

This grants you more control during item creation and enables you to add members to an item that should only be able to view a payment as opposed to acting on it.

An example of this in the Routable application can be seen below:

To maintain the existing behavior when upgrading, you can set access_item to actionable.

Item Approvals

If you were previously using the approver_selected attribute to specify an Item approver, you will have additional upgrade requirements.

To find the appropriate CompanySettingsItemApprovalLevel, you will need to:

  • Call /companies/{{company_id}}/ to retrieve your company and its associated item approval settings

  • To find the appropriate CompanySettingsItemApprovalLevel, you will need to filter for the resource(s) that matches your item_kind and the amount is lower than or equal to your item's amount.

    For each CompanySettingsItemApprovalLevel:

    • If the level_type is any, you should supply 1 or more of the qualified_approvers
    • If the level_type is all, you should supply all of the qualified_approvers
"item_approvers": {
  "data": [
    {
      "type": "ItemApprover",
        "relationships": {
          "level": {
            "data": {
              "id": "ed6ec8e6-cf7c-4528-8f5e-671de85cc91d",
              "type": "CompanySettingsItemApprovalLevel"
            }
          },
          "membership": {
            "data": {
              "id": "5beeb2dd-871a-4bd7-a77d-ee1c825beb33",
              "type": "Membership"
            }
        }
      }
    }
  ]
}
"approver_selected": {
  "data": {
    "id": "5beeb2dd-871a-4bd7-a77d-ee1c825beb33",
    "type": "Membership"
  }
}

account_id, class_id, item_id, tax_id, tax_code and account_code

These fields are potentially present in both Items and LineItems depending on your accounting software configuration.

These fields should be converted to objects as shown below:

"account": { "id": "58" }
"class": { "id": "5000000000000151559" }
"item": { "id": "5" }
"tax": { "id": "INPUT" }
"account_code": { "id": "600" }
"tax_code": { "id": "2" }
"account_id": "58"
"class_id": "5000000000000151559"
"item_id": "5"
"tax_id": "INPUT"
"account_code": "600"
"tax_code": "2"

Did this page help you?