api-docs v5.116.0

API Docs

Table of contents

Service_Performed

Service Performed - Delete

Back to top

Delete a specific service performed

DELETE /service-performed/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/service-performed/<service-performed-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
group string

for grouping services performed. can be billing item id
service string
provider string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Service Performed - Find

Back to top

Get list of services performed

GET /service-performed

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/service-performed" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
servicesPerformed object[]

array of servicePerformed
servicesPerformed.id string
servicesPerformed.createdAt number
servicesPerformed.createdBy string
servicesPerformed.facility string

facility id
servicesPerformed.group string

for grouping services performed. can be billing item id
servicesPerformed.service string
servicesPerformed.provider string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Service Performed - Get

Back to top

Get a specific service performed

GET /service-performed/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/service-performed/<service-performed-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
group string

for grouping services performed. can be billing item id
service string
provider string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Service Performed - Patch

Back to top

Update service performed

PATCH /service-performed/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
group string optional
provider string optional
createdAt number optional

Examples

Example usage:

curl "https://yourdomain.com/service-performed/<service-performed-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "group": "some-group-id"
  }'

Parameters examples

json - Request-Example

{
  "group": "some-group-id"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
group string

for grouping services performed. can be billing item id
service string
provider string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Service Performed - Post

Back to top

Create service performed

POST /service-performed

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
group string optional
service string
provider string optional
createdAt number optional

Examples

Example usage:

curl "https://yourdomain.com/service-performed" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "service": "service-id"
  }'

Parameters examples

json - Request-Example

{
  "service": "service-id"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
group string

for grouping services performed. can be billing item id
service string
provider string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""