๐Ÿ’ธ Your first payable

๐Ÿ“˜

Are you familiar with our key concepts?

It introduces a number of key modeling concepts and this guide will be quite a bit easier to understand if you read it.

Create a Vendor Partnership

We'll start by creating a vendor so you have someone to pay.

// POST /partnerships/ HTTP/1.1
// Accept: application/vnd.api+json
// Content-Type: application/vnd.api+json

{
  "data": {
    "attributes": {
      "is_customer": false,
      "is_vendor": true
    },
    "relationships": {
      "partnership_members": {
        "data": [
          {
            "attributes": {
              "default_general": "actionable",
              "default_item": "actionable",
              "email": "[email protected]",
              "first_name": "Zaldy",
              "last_name": "Worker"
            },
            "type": "PartnershipMember"
          }
        ]
      },
      "partner": {
        "data": {
          "attributes": {
            "company_type": "business",
            "name": "InstaWork"
          },
          "type": "Company"
        }
      },
      "requester": {
        "data": {
          "id": "451795f6-f54f-4861-ba55-6c22b097a6e4",
          "type": "Membership"
        }
      }
    },
    "type": "Partnership"
  }
}
{
  "data":{
    "type":"Partnership",
    "id":"a99945e9-815a-4ba7-9e57-cc88972d0222",
    "attributes":{
      "created":"2021-03-19T16:32:05.426946Z",
      "customer_ref":null,
      "external_ref":null,
      "is_customer":false,
      "is_ledger_only":false,
      "is_vendor":true,
      "name":"InstaWork",
      "partner_status":"added",
      "vendor_ref":null
    },
    "relationships":{
      "partner":{
        "data":{
          "type":"Company",
          "id":"5c81ac75-1599-4991-987a-8418d92698f2"
        }
      },
      "partnership_members":{
        "data":[
          {
            "type":"PartnershipMember",
            "id":"49c49dfc-60c0-42cf-8bd4-8ec6e4f4ea04"
          },
          {
            "type":"PartnershipMember",
            "id":"082ddd91-5882-48d5-8253-c3e550ae178f"
          }
        ]
      }
    }
  },
  "included":[
    {
      "type":"Company",
      "id":"5c81ac75-1599-4991-987a-8418d92698f2",
      "attributes":{
        "company_type":"business",
        "name":"InstaWork"
      }
    },
    {
      "type":"PartnershipMember",
      "id":"082ddd91-5882-48d5-8253-c3e550ae178f",
      "attributes":{
        "avatar":null,
        "default_general":"actionable",
        "default_item":"actionable",
        "email":"[email protected]",
        "first_name":"Zaldy",
        "is_archived":false,
        "last_name":"Worker",
        "notification_general":"none",
        "phone_number":null,
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNWExYTY4OWYtYzRmNy00Y2JjLWI0ZTQtZmY5NGE4YjhkNjc1IiwiZW1haWwiOiJ6YWxkeUBpbnN0YXdvcmsuY29tIiwiZXhwIjoxNjIxMzU1NTI1fQ.79KSi5TLd_tLtCmR93XN00ZbLfDY4VeCjCI8ksBp52M",
        "debug_partnership_id":"bf179465-3125-4c83-bcd9-7b33ee8a59e3"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"5c81ac75-1599-4991-987a-8418d92698f2"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"5a1a689f-c4f7-4cbc-b4e4-ff94a8b8d675"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    },
    {
      "type":"PartnershipMember",
      "id":"49c49dfc-60c0-42cf-8bd4-8ec6e4f4ea04",
      "attributes":{
        "avatar":null,
        "default_general":"self_managed",
        "default_item":"self_managed",
        "email":"[email protected]",
        "first_name":"Kevin",
        "is_archived":false,
        "last_name":"Malone",
        "notification_general":"self_managed",
        "phone_number":{
          "number":"+11917280016",
          "country":"US"
        },
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNDUxNzk1ZjYtZjU0Zi00ODYxLWJhNTUtNmMyMmIwOTdhNmU0IiwiZW1haWwiOiJrZXZpbkBkdW5kZXJtaWZmbGluLmNvbSIsImV4cCI6MTYyMTM1NTUyNX0.u8k_Zx9jvsq_T4htN-LVLU-VBtspVTd7f2X-WG6d8Zw",
        "debug_partnership_id":"a99945e9-815a-4ba7-9e57-cc88972d0222"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"e4163ce1-dc78-47a0-ae6c-68aab52411e8"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"451795f6-f54f-4861-ba55-6c22b097a6e4"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    }
  ]
}

See the Create a Partnership operation definition for details about the request and response attributes.

Create a Payable Item

To pay your vendor, you'll make one API request and we'll handle all the rest of their onboarding.

Routable will collect your vendor's banking and tax information automatically as part of receiving their first payment. This is a great way to incentivize your vendors to submit their year-end tax information๐Ÿฅ•.

Yes, really -- we'll handle everything related to collecting banking and tax information.

// POST /items/ HTTP/1.1
// Accept: application/vnd.api+json
// Content-Type: application/vnd.api+json

{
  "data":{
    "attributes":{
      "amount":5000,
      "kind":"payable",
      "payment_delivery_methods_accepted":[
        "ach",
        "check"
      ],
      "reference":"Invoice #4245"
    },
    "relationships":{
      "funding_account":{
        "data":{
          "id":"01c4039a-644a-4f60-9085-23890208336e",
          "type":"FundingAccount"
        }
      },
      "line_items":{
        "data":[
          {
            "attributes":{
              "amount":5000,
              "description":"Office Space",
              "quantity":1,
              "style":"item",
              "unit_price":5000
            },
            "type":"LineItem"
          }
        ]
      },
      "partnership":{
        "data":{
          "id":"a99945e9-815a-4ba7-9e57-cc88972d0222",
          "type":"Partnership"
        }
      },
      "item_members":{
        "data":[
          {
            "attributes":{
              "access_item":"actionable"
            },
            "relationships":{
              "partnership_member":{
                "data":{
                  "id":"082ddd91-5882-48d5-8253-c3e550ae178f",
                  "type":"PartnershipMember"
                }
              }
            },
            "type":"ItemMember"
          }
        ]
      },
      "requester":{
        "data":{
          "id":"451795f6-f54f-4861-ba55-6c22b097a6e4",
          "type":"Membership"
        }
      }
    },
    "type":"Item"
  }
}
{
  "data":{
    "type":"Item",
    "id":"89cb1019-c4b6-487d-afd5-30879b83cb58",
    "attributes":{
      "amount":"5000.00",
      "amount_due":"5000.00",
      "amount_paid":"0.00",
      "check_number":null,
      "date_approved":null,
      "date_due":"2021-03-19",
      "date_expected":null,
      "date_externally_paid":null,
      "date_issued":"2021-03-19",
      "date_scheduled":null,
      "date_sent":"2021-03-19",
      "date_status_change":"2021-03-19T16:37:16.439513Z",
      "days_until_due":0,
      "external_ref":null,
      "externally_paid_method":null,
      "externally_paid_reference":null,
      "funding_provider_memo":null,
      "has_attachments":false,
      "invoice_number":null,
      "is_creator":true,
      "kind":"payable",
      "ledger_ref":null,
      "ledger_status":"no_ledger",
      "payment_delivery_method":null,
      "payment_delivery_methods_accepted":[
        "ach",
        "check"
      ],
      "payment_delivery_option":null,
      "payment_terms":null,
      "reference":"Invoice #4245",
      "status":"pending",
      "status_timeline":[
        {
          "date":"2021-03-19T16:37:16.439513Z",
          "status":"pending"
        }
      ]
    },
    "relationships":{
      "approvals":{
        "data":[
          
        ]
      },
      "attachments":{
        "meta":{
          "count":0
        },
        "data":[
          
        ]
      },
      "funding_account":{
        "data":{
          "type":"FundingAccount",
          "id":"01c4039a-644a-4f60-9085-23890208336e"
        }
      },
      "item_members":{
        "meta":{
          "count":2
        },
        "data":[
          {
            "type":"ItemMember",
            "id":"8e4fe732-51cc-4737-9eda-ba7603a94d26"
          },
          {
            "type":"ItemMember",
            "id":"f2fa0b1f-114a-4b12-a3ba-4865cd642ea7"
          }
        ]
      },
      "partner":{
        "data":{
          "type":"Company",
          "id":"5c81ac75-1599-4991-987a-8418d92698f2"
        }
      },
      "partner_funding_account":{
        "data":null
      },
      "partnership":{
        "data":{
          "type":"Partnership",
          "id":"a99945e9-815a-4ba7-9e57-cc88972d0222"
        }
      },
      "tag_links":{
        "data":[
          
        ]
      }
    }
  },
  "included":[
    {
      "type":"Company",
      "id":"5c81ac75-1599-4991-987a-8418d92698f2",
      "attributes":{
        "name":"InstaWork"
      }
    },
    {
      "type":"FundingAccount",
      "id":"01c4039a-644a-4f60-9085-23890208336e",
      "attributes":{
        
      },
      "relationships":{
        "address":{
          "data":null
        },
        "bank":{
          "data":{
            "type":"FundingInfoBank",
            "id":"539f5941-643d-4db1-a235-31d3c9a512f1"
          }
        },
        "company":{
          "data":{
            "type":"Company",
            "id":"e4163ce1-dc78-47a0-ae6c-68aab52411e8"
          }
        }
      }
    },
    {
      "type":"FundingInfoBank",
      "id":"539f5941-643d-4db1-a235-31d3c9a512f1",
      "attributes":{
        "account_number":"49604",
        "institution_name":"Wells Fargo Bank Na  (Minnesota)",
        "routing_number":"091000019"
      }
    },
    {
      "type":"ItemMember",
      "id":"8e4fe732-51cc-4737-9eda-ba7603a94d26",
      "attributes":{
        "access_item":"self_managed"
      },
      "relationships":{
        "partnership_member":{
          "data":{
            "type":"PartnershipMember",
            "id":"49c49dfc-60c0-42cf-8bd4-8ec6e4f4ea04"
          }
        }
      }
    },
    {
      "type":"ItemMember",
      "id":"f2fa0b1f-114a-4b12-a3ba-4865cd642ea7",
      "attributes":{
        "access_item":"actionable"
      },
      "relationships":{
        "partnership_member":{
          "data":{
            "type":"PartnershipMember",
            "id":"082ddd91-5882-48d5-8253-c3e550ae178f"
          }
        }
      }
    },
    {
      "type":"Partnership",
      "id":"a99945e9-815a-4ba7-9e57-cc88972d0222",
      "attributes":{
        "customer_ref":null,
        "name":"InstaWork",
        "vendor_ref":null
      }
    },
    {
      "type":"PartnershipMember",
      "id":"082ddd91-5882-48d5-8253-c3e550ae178f",
      "attributes":{
        "avatar":null,
        "default_general":"actionable",
        "default_item":"actionable",
        "email":"[email protected]",
        "first_name":"Zaldy",
        "is_archived":false,
        "last_name":"Worker",
        "notification_general":"none",
        "phone_number":null,
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNWExYTY4OWYtYzRmNy00Y2JjLWI0ZTQtZmY5NGE4YjhkNjc1IiwiZW1haWwiOiJ6YWxkeUBpbnN0YXdvcmsuY29tIiwiZXhwIjoxNjIxMzU1ODM2fQ.1Ct8EW_aUOSHHCiNW8994ypEUBkBbPpEwCOKirysgZ8",
        "debug_partnership_id":"bf179465-3125-4c83-bcd9-7b33ee8a59e3"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"5c81ac75-1599-4991-987a-8418d92698f2"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"5a1a689f-c4f7-4cbc-b4e4-ff94a8b8d675"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    },
    {
      "type":"PartnershipMember",
      "id":"49c49dfc-60c0-42cf-8bd4-8ec6e4f4ea04",
      "attributes":{
        "avatar":null,
        "default_general":"self_managed",
        "default_item":"self_managed",
        "email":"[email protected]",
        "first_name":"Kevin",
        "is_archived":false,
        "last_name":"Malone",
        "notification_general":"self_managed",
        "phone_number":{
          "number":"+11917280016",
          "country":"US"
        },
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNDUxNzk1ZjYtZjU0Zi00ODYxLWJhNTUtNmMyMmIwOTdhNmU0IiwiZW1haWwiOiJrZXZpbkBkdW5kZXJtaWZmbGluLmNvbSIsImV4cCI6MTYyMTM1NTgzNn0.nSDtB2M2c6eu0f54KKc0euZAHpcnUSab_HhXW0DimqE",
        "debug_partnership_id":"a99945e9-815a-4ba7-9e57-cc88972d0222"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"e4163ce1-dc78-47a0-ae6c-68aab52411e8"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"451795f6-f54f-4861-ba55-6c22b097a6e4"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    }
  ]
}

Bada bing, bada boom -- Your vendor will receive an email with information about the payment and be sent to our onboarding flow.

Who knew that onboarding vendors and making payments could be so easy?


Did this page help you?