Billable Portfolios

A billable portfolio is a portfolio that is associated with a specific fee schedule. A billable portfolio can be a household, client, legal entity, or group. Use the Billable Portfolios API to add new portfolios, edit their fee schedules, archive portfolios, and restore archived portfolios.


Base route	/v1/billable_portfolios
Endpoints	POST /v1/billable_portfolios PATCH /v1/billable_portfolios/:id/relationships/fee_schedules DELETE /v1/billable_portfolios/:id/relationships/fee_schedules
Produces	JSON
Pagination	No
Application permissions required	"Run and manage bills, include fee adjustment and payment tracking" or "Full access to Billing and billing data"
OAuth scopes	`BILLING_WRITE`

Resource overview

Arguments are described by the below resource object attributes and will appear in successful POST responses.

Attribute	Description	Example
`id`	The billable portfolio's ID. List of integers.	`[1234, 5678]`

Parameters

Parameter	Description	Example
`entity_id`	The ID of the entity that is a billable portfolio. You can only use either `entity_id` or `group_id` per request, not both.	`1234`
`group_id`	The ID of the group that is a billable portfolio. You can only use either `entity_id` or `group_id` per request, not both.	`4567`
`schedule_id`	The ID of the associated fee schedule.	`9101

Relationships

Relationship	Description
`fee_schedules`	The billable portfolio's fee schedule.

Add a billable portfolio

Set up a group or entity for billing with a specified fee schedule.

POST /v1/billable_portfolios

Example:

POST https://examplefirm.addepar.com/api/v1/billable_portfolios

{
  “data”: {
    “type”: “create_billable_portfolio”,
    “attributes”: {
      “group_id”: 1,
      “schedule_id”: 2
    }
  }
}

HTTP/1.1 200

{
    “id”: 1234
}

Example:

POST https://examplefirm.addepar.com/api/v1/billable_portfolios

{
  “data”: {
    “type”: “create_billable_portfolio”,
    “attributes”: {
      “entity_id”: 1,
      “schedule_id”: 2
    }
  }
}

HTTP/1.1 200

{
    “id”: 1234
}

Response codes:

200 OK: Success
400 Bad Request: Failed during validation
403 Forbidden: Insufficient application permissions or appropriate scope not granted
404 Not Found: Argument does not exist

Update a fee schedule or restore a billable portfolio

Update a billable portfolio's fee schedule to a different one. You can also restore an archived billable portfolio by adding a fee schedule to it.

PATCH /v1/billable_portfolios/:id/relationships/fee_schedules

Example:

PATCH https://examplefirm.addepar.com/api/v1/billable_portfolios/2/relationships/fee_schedules

{
  “data”: {
  	"id": 3,
    “type”: “fee_schedules”
  }
}

HTTP/1.1 200

Response codes:

200 OK: Success
400 Bad Request: Failed during validation
403 Forbidden: Insufficient application permissions or appropriate scope not granted
404 Not Found: Billable portfolio or fee schedule does not exist.

Archive a billable portfolio

Archive a billable portfolio when you no longer want to bill on it. None of its previous bills will change.

DELETE /v1/billable_portfolios/:id/relationships/fee_schedules

Example:

DELETE https://examplefirm.addepar.com/api/v1/billable_portfolios/2/relationships/fee_schedules

HTTP/1.1 200

Response codes:

200 OK: Success
403 Forbidden: Insufficient application permissions or appropriate scope not granted
404 Not Found: Billable portfolio does not exist.
409 Conflict: Billable portfolio is already archived.