Replace ledger account

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/ledger-account' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "extensions": {},
    "isActive": true,
    "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string"
  }'

Responses

Ledger Account created successfully

Bodyapplication/json

codestringrequired

Practice or system-specific ledger account code.

createdAtstring(date-time)required

Timestamp when the ledger account was created.

Example: "2025-01-01T00:00:00.000Z"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the ledger account is active and can be used for postings.

ledgerAccountIdstringrequired

Canonical identifier for the ledger account.

Example: "123e4567-e89b-12d3-a456-426614174000"

namestringrequired

Human-readable name of the ledger account.

updatedAtstring(date-time)required

Timestamp when the ledger account was last updated.

Example: "2025-01-01T00:00:00.000Z"

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List ledger accounts

Request

Returns a paginated list of Ledger Accounts for the specified site. Supports filtering and sorting.

Security

bearer

Path

siteIdnumberrequired

Site identifier

Query

pagenumber>= 0

Page number (0-indexed)

Default 0

pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10

sortBystring

Field to sort by

Enum"createdAt""updatedAt""code""name"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

codestring

Practice or system-specific ledger account code.

isActiveboolean

Whether the ledger account is active and can be used for postings.

namestring

Human-readable name of the ledger account.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/ledger-account?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&code=string&isActive=true&name=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Ledger Accounts

Get ledger account

Request

Returns a single Ledger Account by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

ledgerAccountIdstringrequired

Ledger Account unique identifier (UUID)

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/ledger-account/{ledgerAccountId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ledger Account found

Bodyapplication/json

codestringrequired

Practice or system-specific ledger account code.

createdAtstring(date-time)required

Timestamp when the ledger account was created.

Example: "2025-01-01T00:00:00.000Z"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the ledger account is active and can be used for postings.

ledgerAccountIdstringrequired

Canonical identifier for the ledger account.

Example: "123e4567-e89b-12d3-a456-426614174000"

namestringrequired

Human-readable name of the ledger account.

updatedAtstring(date-time)required

Timestamp when the ledger account was last updated.

Example: "2025-01-01T00:00:00.000Z"

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update ledger account

Request

Partially updates an existing Ledger Account. Only provided fields will be updated.

Security

bearer

Path

siteIdnumberrequired

Site identifier

ledgerAccountIdstringrequired

Ledger Account unique identifier (UUID)

Bodyapplication/jsonrequired

codestring

Practice or system-specific ledger account code.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the ledger account is active and can be used for postings.

namestring

Human-readable name of the ledger account.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/ledger-account/{ledgerAccountId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "extensions": {},
    "isActive": true,
    "name": "string"
  }'

Responses

Ledger Account updated successfully

Bodyapplication/json

codestringrequired

Practice or system-specific ledger account code.

createdAtstring(date-time)required

Timestamp when the ledger account was created.

Example: "2025-01-01T00:00:00.000Z"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the ledger account is active and can be used for postings.

ledgerAccountIdstringrequired

Canonical identifier for the ledger account.

Example: "123e4567-e89b-12d3-a456-426614174000"

namestringrequired

Human-readable name of the ledger account.

updatedAtstring(date-time)required

Timestamp when the ledger account was last updated.

Example: "2025-01-01T00:00:00.000Z"

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}