Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
supplements

Get Supplement by ID

Use this endpoint to get a particular supplement for the current location.

get/supplements/{supplementId}

Path parameters

supplementIdstring uuid required

The supplement's unique identifier

Response

OK

idstring uuid

The supplement unique identifier.

_linkstring uri

The URI of the supplement.

namestring

Supplement description.

createdDatestring date-time

The date/time when this supplement was created.

editedDatestring date-time

The date/time when this supplement was last updated.

closedDatestring date-time

The date/time when this supplement was closed.

appliedDatestring date-time

The date/time when this supplement was applied.

Example response

{
  "id": "b195ca49-aeff-4e19-8ddd-193e01f5e649",
  "_link": "https://api.acculynx.com/api/v2/supplements/b195ca49-aeff-4e19-8ddd-193e01f5e649",
  "status": {
    "id": "528806c3-c914-498a-80c7-59a98eb9bd44",
    "_link": "https://api.acculynx.com/api/v2/company-settings/supplements/statuses/528806c3-c914-498a-80c7-59a98eb9bd44"
  },
  "name": "Supplement #1",
  "state": {
    "supplementState": "InProgress"
  },
  "job": {
    "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
    "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
  },
  "assignedSupplementer": {
    "supplementerAssigned": {
      "id": "228db892-3b49-4455-b839-ffd8576d8731",
      "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
    },
    "assignedDate": "2024-01-20T21:18:25Z",
    "assignedBy": {
      "id": "228db892-3b49-4455-b839-ffd8576d8731",
      "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
    }
  },
  "itemsToSupplement": {
    "totalOriginalClaimAmount": 1200.6,
    "totalRequestedAmount": 1600.05,
    "totalApprovedAmount": 1700.4,
    "totalAppliedAmount": 1400.48,
    "items": [
      {
        "id": "a646a794-4265-4b2b-bf01-1aa4afe127de",
        "_link": "https://api.acculynx.com/api/v2/supplements/b195ca49-aeff-4e19-8ddd-193e01f5e649/items/a646a794-4265-4b2b-bf01-1aa4afe127de",
        "name": "supplement item",
        "originalClaimAmount": 650.6,
        "requestedAmount": 1100.05,
        "approvedAmount": 1100.4,
        "appliedAmount": 900.48
      }
    ]
  },
  "notations": [
    {
      "id": "a646a794-4265-4b2b-bf01-1aa4afe127de",
      "_link": "https://api.acculynx.com/api/v2/supplements/b195ca49-aeff-4e19-8ddd-193e01f5e649/notations/a646a794-4265-4b2b-bf01-1aa4afe127de",
      "status": {
        "id": "528806c3-c914-498a-80c7-59a98eb9bd44",
        "_link": "https://api.acculynx.com/api/v2/company-settings/supplements/statuses/528806c3-c914-498a-80c7-59a98eb9bd44"
      },
      "spokeWith": "salesGuy",
      "notes": "notation note",
      "phone": "(123) 456-7891",
      "extension": "111",
      "fax": "(132) 456-7890",
      "email": "salesGuy@acculynx.com",
      "createdBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      },
      "createdDate": "2024-01-20T21:18:25Z",
      "emailRecipients": [
        {
          "id": 2,
          "companyUser": {
            "id": "228db892-3b49-4455-b839-ffd8576d8731",
            "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
          }
        }
      ]
    }
  ],
  "createdDate": "2024-01-20T21:18:25Z",
  "createdBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "editedDate": "2024-01-20T21:18:25Z",
  "editedBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "closedDate": "2024-01-20T21:18:25Z",
  "closedBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "appliedDate": "2024-01-20T21:18:25Z",
  "appliedBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  }
}