# Public API – Financial Management

Operations related to patients, appointments, providers and so on.

Version: 191.0.3

## Servers

Sandbox
```
https://test.hs1api.com/ascend-gateway/api
```

Prod
```
https://prod.hs1api.com/ascend-gateway/api
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### oAuthSandbox

OAuth 2.0 client credentials (Sandbox)

Type: oauth2
Token URL: https://test.hs1api.com/oauth/client_credential/accesstoken?grant_type=client_credentials
Scopes:

## Download OpenAPI description

 - [Public API – Financial Management](https://papidocs.hs1api.com/_bundle/PublicAPI/api-financial-management.yaml)

 - [GET /v1/agingbalances](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getagingbalancesv1.md)
 - [GET /v1/agingbalances/report](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getagingbalancesreportv1.md): Returns `AgingBalanceReportV1`: rolled-up bucket totals for the location (or for the requested guarantor patients), plus `patientReports` with one `AgingReceivableV1` per guarantor row. **Filter requi
 - [GET /v1/feescheduleassociations](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getfeescheduleassociationsv1.md): **Query shape:** Use the documented query parameters to scope the request. Unscoped queries can **408** (timeout) on large tenants. **Empty results:** **200** with `data: []` means no resources matche
 - [GET /v1/feescheduleranges](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getfeeschedulerangesv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/feescheduleranges](https://papidocs.hs1api.com/publicapi/api-financial-management/other/postfeeschedulerangesv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/feescheduleranges/{feeScheduleRangeId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getfeeschedulerangesbyfeeschedulerangeidv1.md): Returns the FeeScheduleRange identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/feescheduleranges/{feeScheduleRangeId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/putfeeschedulerangesbyfeeschedulerangeidv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/feescheduleranges/{feeScheduleRangeId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/deletefeeschedulerangesbyfeeschedulerangeidv1.md): Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted.
 - [GET /v1/feeschedules](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getfeeschedulesv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/feeschedules](https://papidocs.hs1api.com/publicapi/api-financial-management/other/postfeeschedulesv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/feeschedules/{feeScheduleId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getfeeschedulesbyfeescheduleidv1.md): Returns the FeeSchedule identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/feeschedules/{feeScheduleId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/putfeeschedulesbyfeescheduleidv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/feeschedules/{feeScheduleId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/deletefeeschedulesbyfeescheduleidv1.md): Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted.
 - [GET /v1/patientpaymentplans](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getpatientpaymentplansv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/patientpaymentplans/{patientPaymentPlanId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getpatientpaymentplansbypatientpaymentplanidv1.md): Returns the payment plan identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [GET /v1/patientstatements](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getpatientstatementsv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/patientstatements/{patientstatementId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/getpatientstatementsbypatientstatementidv1.md): Returns the PatientStatementV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [GET /v1/transactions/adjustments](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionsadjustmentsv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/transactions/adjustments/{transactionId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionsadjustmentsbytransactionidv1.md): Returns the adjustment transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [GET /v1/transactions/insurancepayments](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionsinsurancepaymentsv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/transactions/insurancepayments/{transactionId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionsinsurancepaymentsbytransactionidv1.md): Returns the insurance payment transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [GET /v1/transactions/patientpayments](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionspatientpaymentsv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/transactions/patientpayments/{transactionId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionspatientpaymentsbytransactionidv1.md): Returns the patient payment transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [GET /v1/transactions/procedures](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionsproceduresv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/transactions/procedures/{transactionId}](https://papidocs.hs1api.com/publicapi/api-financial-management/other/gettransactionsproceduresbytransactionidv1.md): Returns the patient procedure transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.