Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Embat DebtScheduleConfigs API

⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable.Debt Schedule Config represents the amortization schedule configured for a debt product: payment frequency, interest rate, outstanding and granted balances, and the full calendar of scheduled payments broken down into principal, interest and tax components.A debt schedule config is linked to the `Bank` relationship the debt is held with (`bankId`) and to two `Products`: the `debtProductId` being amortized and the product used to pay each installment (`settlementAccountId`, returned as `settlementProductId`).**Typical flow:** debt schedule configurations are read-only from this API — they are set up in Embat and exposed here for consumption.1. **List configurations** with `GET /debtscheduleconfigs/{companyId}`, optionally filtering by `startUpdatedAt`/`endUpdatedAt` to read only what changed since your last poll.2. **Retrieve a single configuration** with `GET /debtscheduleconfigs/{companyId}/{id}` to get its full payment calendar (`debtSchedulePaymentsCalendar`).

Embat DebtScheduleConfigs API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DebtScheduleConfigs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2.120.3.

Requests are made against the base URL https://api.embat.io.

2 operations 2 paths 10 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.120.3
Base URL
https://api.embat.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Embat DebtScheduleConfigs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

DebtScheduleConfigs 2

⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable. Debt Schedule Config represents the amortization schedule configured for a deb…

GET
/debtscheduleconfigs/{companyId}
List debt schedule configs
list_debt_schedule_configs_debtscheduleconfigs__companyId__get 5 params → 200401404422
GET
/debtscheduleconfigs/{companyId}/{id}
Retrieve debt schedule config
retrieve_debt_schedule_config_debtscheduleconfigs__companyId___id__get 2 params → 200401404422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are DebtScheduleConfigSchema (9 properties), GetDebtScheduleConfigResponseSchema (8 properties), DebtSchedulePaymentSchema (6 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

DebtScheduleConfigSchema
object
9 properties 8 required
ListDebtScheduleConfigsResponseSchema
object
2 properties 1 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
CurrencyEnum
string
DebtSchedulePaymentSchema
object
6 properties 6 required
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
AmortisingFrequencyEnum
string
GetDebtScheduleConfigResponseSchema
object
8 properties 8 required
InterestTypeEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-debtscheduleconfigs-api-openapi.yml Raw ↑

Other APIs Embat publishes across the network.

Embat AccountingAccounts API
Embat AccountingEntries API
Embat Attributes API
Embat Authentication API
Embat Balances API
Embat Banks API
Embat Categories API
Embat Companies API
Embat Contacts API
Embat Files API
Embat Forecasts API
Embat ForeignExchangeRates API