canonical: https://jentic.com/apis/swaggerhub.alayacare/alayacare-accounting-api

# AlayaCare Accounting API

**AlayaCare IDs:** The following terms are used to reference IDs that identify resources in AlayaCare: - id - visit_id - premium_id - visit_premium_id - employee_id - cost_centre_id - client_id **External IDs** The following terms are used to reference IDs that identify resources systems external to AlayaCare: - employee_external_id - client_external_id External IDs are required to be unique. No o. The API exposes 65 endpoints secured with basic authentication.

## For AI agents

Programmatically create bill codes, get all bill codes. Covers 65 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for finance and accounting only.

## Capabilities

- Create Bill Codes
- Get all Bill Codes
- Update a Billcode
- Enable a Billcode
- Monitor AlayaCare Accounting API operational status and events

## Use cases

### Finance and Accounting Operations

Use the AlayaCare Accounting API to perform finance operations programmatically. The API provides 65 endpoints covering core functionality including create bill codes, get all bill codes, get a billcode.

Example prompt: Call POST /billcodes to create bill codes

### Automated Accounts Management

Automate accounts operations by combining multiple AlayaCare Accounting API endpoints. Agents can get all bill codes and then get a billcode in a single workflow.

Example prompt: Call GET /billcodes to get all bill codes, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call AlayaCare Accounting 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 'create bill codes', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /billcodes | Create Bill Codes |
| GET | /billcodes | Get all Bill Codes |
| GET | /billcodes/{billcode_id} | Get a Billcode |
| PUT | /billcodes/{billcode_id} | Update a Billcode |
| POST | /billcodes/{billcode_id}/rates | Create Bill Code Rates |
| GET | /billcodes/{billcode_id}/rates | Get all Bill Code Rates |
| PUT | /billcodes/{billcode_id}/enable | Enable a Billcode |
| PUT | /billcodes/{billcode_id}/disable | Disable a Billcode |

## Key resources

- **Accounts** — Operations related to Accounts
- **Activity Codes** — Operations related to Activity Codes
- **Bill Code Rate RRules** — Operations related to Bill Code Rate RRules
- **Bill Code Rates** — Operations related to Bill Code Rates
- **Bill Codes** — Operations related to Bill Codes

## Why Jentic

- **Setup:** Wiring the AlayaCare Accounting API by hand means setting up its HTTP basic auth over https and calling bill code, rate, and enable or disable operations yourself against the AlayaCare host. Through Jentic you install once, import the AlayaCare Accounting API from the API Directory, store the basic credential once, and your agent calls it.
- **Permission scoping:** The AlayaCare Accounting API puts the bill code id in the URL path (/billcodes/{billcode_id}/...), so a rule can pin your agent to one bill code: it can read that code and its rates and nothing else. You choose the operations it may call, so state-changing ones like update, enable, or disable are not included unless you add them.
- **Credential handling:** Your AlayaCare Accounting 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 'create a bill code' or 'list bill code rates', and Jentic returns the matching AlayaCare Accounting API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Plaid** — Alternative finance API
- **Xero** — Alternative finance API

## FAQ

### What authentication does the AlayaCare Accounting API use?

The AlayaCare Accounting 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 create bill codes with the AlayaCare Accounting API?

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

### What are the rate limits for the AlayaCare Accounting 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 create bill codes through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create bill codes'. Jentic returns the matching AlayaCare Accounting API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the AlayaCare Accounting API have?

The AlayaCare Accounting API exposes 65 endpoints covering accounts, activity codes, bill code rate rrules operations.

### Can I limit what my agent is allowed to do with the AlayaCare Accounting API?

Yes. Because you run Jentic One yourself, your own rules decide which AlayaCare Accounting API operations and credentials the agent may use. Since the bill code id sits in the URL path (/billcodes/{billcode_id}/...), you can pin the agent to a single bill code so it reads only that code and its rates and nothing else. You also choose which operations it may call, so state-changing ones like updating, enabling, or disabling a bill code stay off unless you add them.