api-docs v5.116.0

API Docs

Table of contents

Service_Provider

Service Provider - Delete

Back to top

Delete a specific service provider

DELETE /service-providers/: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-providers/<service-provider-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
service string
provider string
priceCurrency string

currency code
price number
tax number
taxCode string
coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions object[]

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string
commissionsPost object[]

commissions used post invoicing
commissionsPost.id string
commissionsPost.type string
commissionsPost.subtype string
commissionsPost.providerType string
commissionsPost.provider string
commissionsPost.percentage number
commissionsPost.amount number
commissionsPost.forCoveragePaymentType string

Success response example

Success response example - Success-Response:

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

Service Provider - Find

Back to top

Get list of service providers

GET /service-providers

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-providers" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
serviceProviders object[]

array of serviceProvider
serviceProviders.id string
serviceProviders.createdAt number
serviceProviders.createdBy string
serviceProviders.facility string

facility id
serviceProviders.service string
serviceProviders.provider string
serviceProviders.priceCurrency string

currency code
serviceProviders.price number
serviceProviders.tax number
serviceProviders.taxCode string
serviceProviders.coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
serviceProviders.commissions object[]

applied as commission in billing
serviceProviders.commissions.id string
serviceProviders.commissions.type string
serviceProviders.commissions.subtype string
serviceProviders.commissions.providerType string
serviceProviders.commissions.provider string
serviceProviders.commissions.percentage number
serviceProviders.commissions.amount number
serviceProviders.commissions.forCoveragePaymentType string
serviceProviders.commissionsPost object[]

commissions used post invoicing
serviceProviders.commissionsPost.id string
serviceProviders.commissionsPost.type string
serviceProviders.commissionsPost.subtype string
serviceProviders.commissionsPost.providerType string
serviceProviders.commissionsPost.provider string
serviceProviders.commissionsPost.percentage number
serviceProviders.commissionsPost.amount number
serviceProviders.commissionsPost.forCoveragePaymentType 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 Provider - Get

Back to top

Get a specific service provider

GET /service-providers/: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-providers/<service-provider-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
service string
provider string
priceCurrency string

currency code
price number
tax number
taxCode string
coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions object[]

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string
commissionsPost object[]

commissions used post invoicing
commissionsPost.id string
commissionsPost.type string
commissionsPost.subtype string
commissionsPost.providerType string
commissionsPost.provider string
commissionsPost.percentage number
commissionsPost.amount number
commissionsPost.forCoveragePaymentType string

Success response example

Success response example - Success-Response:

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

Service Provider - Patch

Back to top

Update service provider

PATCH /service-providers/: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
createdAt number optional Default value: currentTime
priceCurrency string optional

currency code
price number optional
tax number optional
taxCode string optional
coverages string[] optional

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions object[] optional

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string
commissionsPost object[] optional

commissions used post invoicing
commissionsPost.id string
commissionsPost.type string
commissionsPost.subtype string
commissionsPost.providerType string
commissionsPost.provider string
commissionsPost.percentage number
commissionsPost.amount number
commissionsPost.forCoveragePaymentType string

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "tax": 12
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
service string
provider string
priceCurrency string

currency code
price number
tax number
taxCode string
coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions object[]

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string
commissionsPost object[]

commissions used post invoicing
commissionsPost.id string
commissionsPost.type string
commissionsPost.subtype string
commissionsPost.providerType string
commissionsPost.provider string
commissionsPost.percentage number
commissionsPost.amount number
commissionsPost.forCoveragePaymentType string

Success response example

Success response example - Success-Response:

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

Service Provider - Post

Back to top

Create service provider

POST /service-providers

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
createdAt number optional Default value: currentTime
service string
provider string
priceCurrency string optional

currency code
price number optional
tax number optional
taxCode string optional
coverages string[] optional

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions object[] optional

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string
commissionsPost object[] optional

commissions used post invoicing
commissionsPost.id string
commissionsPost.type string
commissionsPost.subtype string
commissionsPost.providerType string
commissionsPost.provider string
commissionsPost.percentage number
commissionsPost.amount number
commissionsPost.forCoveragePaymentType string

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "service": "service-id",
  "provider": "provider-id"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
service string
provider string
priceCurrency string

currency code
price number
tax number
taxCode string
coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions object[]

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string
commissionsPost object[]

commissions used post invoicing
commissionsPost.id string
commissionsPost.type string
commissionsPost.subtype string
commissionsPost.providerType string
commissionsPost.provider string
commissionsPost.percentage number
commissionsPost.amount number
commissionsPost.forCoveragePaymentType 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 ""