canonical: https://jentic.com/apis/swaggerhub.alayacare/billable-item-management-api

# Alayacare Billable Item Management API

This end point can be used to create, edit and retrieve billable items before they can be processed in invoices. The API exposes 22 endpoints secured with basic authentication.

## For AI agents

Programmatically add a new billable item., retrieve list of billable items to display in billable management screen. Covers 22 operations with basic authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Add a new billable item.
- Retrieve list of Billable Items to display in Billable Management screen
- Modify an existing billable item
- Deletes a single billable item
- Update multiple billable items status
- Create new items for when changing payors in a COB invoice
- Regenerate billable items

## Use cases

### Payments Operations

Use the Billable Item Management API to perform payments operations programmatically. The API provides 22 endpoints covering core functionality including add a new billable item., retrieve list of billable items to display in billable management screen, modify an existing billable item.

Example prompt: Call POST /billable_item to add a new billable item.

### Automated Bill_Code Management

Automate bill_code operations by combining multiple Billable Item Management API endpoints. Agents can retrieve list of billable items to display in billable management screen and then modify an existing billable item in a single workflow.

Example prompt: Call GET /billable_item to retrieve list of billable items to display in billable management screen, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Billable Item Management API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'add a new billable item.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /billable_item | Add a new billable item. |
| GET | /billable_item | Retrieve list of Billable Items to display in Billable Management screen |
| PATCH | /billable_item/{billable_item_id} | Modify an existing billable item |
| DELETE | /billable_item/{billable_item_id} | Deletes a single billable item |
| PATCH | /billable_item/set | Update multiple billable items status |
| POST | /billable_item/change-payor | Create new items for when changing payors in a COB invoice |
| PATCH | /billable_item/regenerate | Regenerate billable items |
| GET | /billable_item/count | Count the number of items matching the given filters |

## Key resources

- **Bill_Code** — Operations for bill_code
- **Bill_Code_Modifier** — Operations for bill_code_modifier
- **Bill_Rate** — Operations for bill_rate
- **Billable_Item** — Operations for billable_item
- **Billable_Item_Error** — Operations for billable_item_error

## Why Jentic

- **Setup:** Wiring the Billable Item Management API by hand means setting up its HTTP basic auth over https, resolving the right tenant host from the templated URL, and calling billable item create, patch, and delete operations yourself. Through Jentic you install once, import the Billable Item Management API from the API Directory, store the basic credential once, and your agent calls it.
- **Permission scoping:** The Billable Item Management API puts the billable item id in the URL path (/billable_item/{billable_item_id}), so a rule can pin your agent to one billable item: it can read that item and nothing else. You choose the operations it may call, so ones that change or remove data like patch, delete, or change payor are not included unless you add them.
- **Credential handling:** Your Billable Item Management API basic credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'add a new billable item' or 'count billable items', and Jentic returns the matching Billable Item Management API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Billable Item Management API use?

The Billable Item Management API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I add a new billable item. with the Billable Item Management API?

Yes. Use the POST /billable_item endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Billable Item Management API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I add a new billable item. through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'add a new billable item.'. Jentic returns the matching Billable Item Management API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Billable Item Management API have?

The Billable Item Management API exposes 22 endpoints covering bill_code, bill_code_modifier, bill_rate operations.

### Can I limit what my agent is allowed to do with the Billable Item Management API?

Yes. Because you run Jentic One yourself, your own rules decide which billable item operations and credentials the agent may use. Since the billable item id sits in the URL path (/billable_item/{billable_item_id}), you can pin the agent to a single item so it reads that item and nothing else. You choose the operations it may call, so data-changing ones like PATCH, DELETE, and the change-payor call are excluded unless you add them.
