v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Adjustment Types

View adjustment type

This endpoint returns a single adjustment type

get/adjustment_types/{id}

Path parameters

idinteger required

Query parameters

subdomainstring required

Used to scope the request to the specified institution

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": 113,
    "name": "Cash",
    "active": true,
    "action": "credit",
    "updated_at": "2020-06-05T20:16:57.007Z"
  },
  "count": 2
}