🧾 Your first receivable

πŸ“˜

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 Customer Partnership

We'll start by creating a customer 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": true,
      "is_vendor": false
    },
    "relationships": {
      "partnership_members": {
        "data": [
          {
            "attributes": {
              "default_general": "actionable",
              "default_item": "actionable",
              "email": "[email protected]",
              "first_name": "Joe",
              "last_name": "Jones"
            },
            "type": "PartnershipMember"
          }
        ]
      },
      "partner": {
        "data": {
          "attributes": {
            "company_type": "business",
            "name": "Jones Co"
          },
          "type": "Company"
        }
      },
      "requester": {
        "data": {
          "id": "451795f6-f54f-4861-ba55-6c22b097a6e4",
          "type": "Membership"
        }
      }
    },
    "type": "Partnership"
  }
}
{
  "data":{
    "type":"Partnership",
    "id":"91a006ce-e143-4af0-905b-8e01892a60bd",
    "attributes":{
      "created":"2021-03-19T17:24:13.371555Z",
      "customer_ref":null,
      "external_ref":null,
      "is_customer":true,
      "is_ledger_only":false,
      "is_vendor":false,
      "name":"Jones Co",
      "partner_status":"added",
      "vendor_ref":null
    },
    "relationships":{
      "partner":{
        "data":{
          "type":"Company",
          "id":"5540fba5-13da-49fb-8993-203e1da7efcd"
        }
      },
      "partnership_members":{
        "data":[
          {
            "type":"PartnershipMember",
            "id":"b119db7c-ccc3-4803-abcc-c7008d38f7da"
          },
          {
            "type":"PartnershipMember",
            "id":"d326bd7b-f285-4311-8601-aceebcc114a2"
          }
        ]
      }
    }
  },
  "included":[
    {
      "type":"Company",
      "id":"5540fba5-13da-49fb-8993-203e1da7efcd",
      "attributes":{
        "company_type":"business",
        "name":"Jones Co"
      }
    },
    {
      "type":"PartnershipMember",
      "id":"b119db7c-ccc3-4803-abcc-c7008d38f7da",
      "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.eyJtZW1iZXJzaGlwX2lkIjoiNDUxNzk1ZjYtZjU0Zi00ODYxLWJhNTUtNmMyMmIwOTdhNmU0IiwiZW1haWwiOiJrZXZpbkBkdW5kZXJtaWZmbGluLmNvbSIsImV4cCI6MTYyMTM1ODY1M30.CK5Y6xCBcRrhMQqMFfYk0Z_d6HWzPy-vPaL6ZNFsjw4",
        "debug_partnership_id":"91a006ce-e143-4af0-905b-8e01892a60bd"
      },
      "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
        }
      }
    },
    {
      "type":"PartnershipMember",
      "id":"d326bd7b-f285-4311-8601-aceebcc114a2",
      "attributes":{
        "avatar":null,
        "default_general":"actionable",
        "default_item":"actionable",
        "email":"[email protected]",
        "first_name":"Joe",
        "is_archived":false,
        "last_name":"Jones",
        "notification_general":"none",
        "phone_number":null,
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNDJhZTMzYzQtOWYwYi00YThhLThlNGEtYzQ3YjhjZDMxZDA3IiwiZW1haWwiOiJqb2VAam9uZXNjby5jb20iLCJleHAiOjE2MjEzNTg2NTN9.h4p5pXEM6YgApMh_9QAOetofPKZRtArz9weD67wYiPM",
        "debug_partnership_id":"23795587-2eb8-4eef-86eb-3f044a7717b7"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"5540fba5-13da-49fb-8993-203e1da7efcd"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"42ae33c4-9f0b-4a8a-8e4a-c47b8cd31d07"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    }
  ]
}

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

Create a Receivable Item

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

Yes, really -- we'll handle everything else related to onboarding your customer.

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

{
  "data":{
    "attributes":{
      "amount":19.95,
      "date_due":"2020-08-29",
      "date_issued":"2020-07-30",
      "kind":"receivable",
      "payment_delivery_methods_accepted":[
        "ach"
      ],
      "payment_terms":"net30",
      "reference":"3 Hole Punch Paper",
      "extended":{
        "tax_style":"exclusive"
      }
    },
    "relationships":{
      "funding_account":{
        "data":{
          "id":"01c4039a-644a-4f60-9085-23890208336e",
          "type":"FundingAccount"
        }
      },
      "item_members":{
        "data":[
          {
            "attributes":{
              "access_item":"actionable"
            },
            "relationships":{
              "partnership_member":{
                "data":{
                  "id":"d326bd7b-f285-4311-8601-aceebcc114a2",
                  "type":"PartnershipMember"
                }
              }
            },
            "type":"ItemMember"
          }
        ]
      },
      "line_items":{
        "data":[
          {
            "attributes":{
              "amount":19.95,
              "description":"5x Reams of 3 Hole Punch",
              "quantity":1,
              "style":"item",
              "unit_price":19.95
            },
            "type":"LineItem"
          }
        ]
      },
      "partnership":{
        "data":{
          "id":"91a006ce-e143-4af0-905b-8e01892a60bd",
          "type":"Partnership"
        }
      },
      "requester":{
        "data":{
          "id":"451795f6-f54f-4861-ba55-6c22b097a6e4",
          "type":"Membership"
        }
      }
    },
    "type":"Item"
  }
}
{
  "data":{
    "type":"Item",
    "id":"58f49ed8-5189-4cd8-aa73-6cf760fe928b",
    "attributes":{
      "amount":"19.95",
      "amount_due":"19.95",
      "amount_paid":"0.00",
      "check_number":null,
      "date_approved":null,
      "date_due":"2020-08-29",
      "date_expected":null,
      "date_externally_paid":null,
      "date_issued":"2020-07-30",
      "date_scheduled":null,
      "date_sent":"2021-03-19",
      "date_status_change":"2021-03-19T17:26:55.370379Z",
      "days_until_due":-202,
      "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":"receivable",
      "ledger_ref":null,
      "ledger_status":"no_ledger",
      "payment_delivery_method":null,
      "payment_delivery_methods_accepted":[
        "ach"
      ],
      "payment_delivery_option":null,
      "payment_terms":"net30",
      "reference":"3 Hole Punch Paper",
      "status":"pending",
      "status_timeline":[
        {
          "date":"2021-03-19T17:26:55.370379Z",
          "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":"2089f885-7c50-4b56-8c74-582abdbb3181"
          },
          {
            "type":"ItemMember",
            "id":"756917de-45d6-4543-b245-5115639810bc"
          }
        ]
      },
      "partner":{
        "data":{
          "type":"Company",
          "id":"5540fba5-13da-49fb-8993-203e1da7efcd"
        }
      },
      "partner_funding_account":{
        "data":null
      },
      "partnership":{
        "data":{
          "type":"Partnership",
          "id":"91a006ce-e143-4af0-905b-8e01892a60bd"
        }
      },
      "tag_links":{
        "data":[
          
        ]
      }
    }
  },
  "included":[
    {
      "type":"Company",
      "id":"5540fba5-13da-49fb-8993-203e1da7efcd",
      "attributes":{
        "name":"Jones Co"
      }
    },
    {
      "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":"2089f885-7c50-4b56-8c74-582abdbb3181",
      "attributes":{
        "access_item":"self_managed"
      },
      "relationships":{
        "partnership_member":{
          "data":{
            "type":"PartnershipMember",
            "id":"b119db7c-ccc3-4803-abcc-c7008d38f7da"
          }
        }
      }
    },
    {
      "type":"ItemMember",
      "id":"756917de-45d6-4543-b245-5115639810bc",
      "attributes":{
        "access_item":"actionable"
      },
      "relationships":{
        "partnership_member":{
          "data":{
            "type":"PartnershipMember",
            "id":"d326bd7b-f285-4311-8601-aceebcc114a2"
          }
        }
      }
    },
    {
      "type":"Partnership",
      "id":"91a006ce-e143-4af0-905b-8e01892a60bd",
      "attributes":{
        "customer_ref":null,
        "name":"Jones Co",
        "vendor_ref":null
      }
    },
    {
      "type":"PartnershipMember",
      "id":"b119db7c-ccc3-4803-abcc-c7008d38f7da",
      "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.eyJtZW1iZXJzaGlwX2lkIjoiNDUxNzk1ZjYtZjU0Zi00ODYxLWJhNTUtNmMyMmIwOTdhNmU0IiwiZW1haWwiOiJrZXZpbkBkdW5kZXJtaWZmbGluLmNvbSIsImV4cCI6MTYyMTM1ODgxNX0.74_5wcIxrUwXNVc1QSK-X5TjUblzz7Nd3HrRNmtld1E",
        "debug_partnership_id":"91a006ce-e143-4af0-905b-8e01892a60bd"
      },
      "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
        }
      }
    },
    {
      "type":"PartnershipMember",
      "id":"d326bd7b-f285-4311-8601-aceebcc114a2",
      "attributes":{
        "avatar":null,
        "default_general":"actionable",
        "default_item":"actionable",
        "email":"[email protected]",
        "first_name":"Joe",
        "is_archived":false,
        "last_name":"Jones",
        "notification_general":"none",
        "phone_number":null,
        "debug_jwt_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZW1iZXJzaGlwX2lkIjoiNDJhZTMzYzQtOWYwYi00YThhLThlNGEtYzQ3YjhjZDMxZDA3IiwiZW1haWwiOiJqb2VAam9uZXNjby5jb20iLCJleHAiOjE2MjEzNTg4MTV9.70sewMJjCl8AlrgkPzAcTeyJUR1ey86Ilxs1zlRpaKI",
        "debug_partnership_id":"23795587-2eb8-4eef-86eb-3f044a7717b7"
      },
      "relationships":{
        "company":{
          "data":{
            "type":"Company",
            "id":"5540fba5-13da-49fb-8993-203e1da7efcd"
          }
        },
        "membership":{
          "data":{
            "type":"Membership",
            "id":"42ae33c4-9f0b-4a8a-8e4a-c47b8cd31d07"
          }
        },
        "notification_bounce":{
          "data":null
        }
      }
    }
  ]
}

πŸ“˜

More Options

We provide many more options that are documented in our API reference.


What’s Next
Did this page help you?