api-docs v5.116.0

API Docs

Table of contents

Insurance_Coverage

Coverage - Delete

Back to top

Delete an insurance-coverage's details

DELETE /insurance-coverages/: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
id String

id of insurance-coverage

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
contract String
insured String
insurer String
insurerType String
insurerSubtype String
paymentMethod String

how the insurer will pay the insured

  • prepaid
  • postpaid
type String
  • deduction
  • override
  • unknown
name String

coverage name
amount Number
percentage Number
ref String

associated reference id
refType String

associated reference type:

  • services
  • inventory-stock-configurations

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-coverage-id",
  "insured": "<insured-organization's-id>",
  "insurer": "<insured-organization's-id>"
}

Coverage - Find

Back to top

Get insurance-coverages with details

GET /insurance-coverages

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

Success response

Success response - Success 200

Name Type Description
insuranceCoverages Object[]

array of insurance coverage
insuranceCoverages.id String
insuranceCoverages.createdAt Number
insuranceCoverages.createdBy String
insuranceCoverages.contract String
insuranceCoverages.insured String
insuranceCoverages.insurer String
insuranceCoverages.insurerType String
insuranceCoverages.insurerSubtype String
insuranceCoverages.paymentMethod String

how the insurer will pay the insured

  • prepaid
  • postpaid
type String
  • deduction
  • override
  • unknown
insuranceCoverages.name String

coverage name
insuranceCoverages.amount Number
insuranceCoverages.percentage Number
insuranceCoverages.ref String

associated reference id
insuranceCoverages.refType String

associated reference type:

  • services
  • inventory-stock-configurations

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "insurance-coverage-id",
    "insured": "<insured-organization's-id>",
    "insurer": "<insured-organization's-id>"
  },
  {
    "id": "insurance-coverage-id",
    "insured": "<insured-organization's-id>",
    "insurer": "<insured-organization's-id>"
  }
]

Coverage - Get

Back to top

Get an insurance-coverage's details

GET /insurance-coverages/: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
id String

id of insurance-coverage

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
contract String
insured String
insurer String
insurerType String
insurerSubtype String
paymentMethod String

how the insurer will pay the insured

  • prepaid
  • postpaid
type String
  • deduction
  • override
  • unknown
name String

coverage name
amount Number
percentage Number
ref String

associated reference id
refType String

associated reference type:

  • services
  • inventory-stock-configurations

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-coverage-id",
  "insured": "<insured-organization's-id>",
  "insurer": "<insured-organization's-id>"
}

Coverage - Patch

Back to top

Update an insurance-coverage

PATCH /insurance-coverages/: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
id String

id of insurance-coverage
createdAt Number optional
paymentMethod String optional

how the insurer will pay the insured

  • prepaid means the insurer already paid a consumable amount of credits to the insured
  • postpaid means that the insurer will pay the insurer the accumulated amount in a set time
Allowed values: "prepaid","postpaid"
type String Allowed values: "deduction","override","unknown"
name String

coverage name
amount Number optional
percentage Number optional
ref String optional

associated reference id
refType String optional

associated reference type

Allowed values: "services","inventory-stock-configurations"

Examples

Example usage:

curl "https://yourdomain.com/insurance-coverages/<insurance-coverage-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "name": "updated name"
  }'

Parameters examples

json - Request-Example

{
  "name": "updated name"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
contract String
insured String
insurer String
insurerType String
insurerSubtype String
paymentMethod String

how the insurer will pay the insured

  • prepaid
  • postpaid
type String
  • deduction
  • override
  • unknown
name String

coverage name
amount Number
percentage Number
ref String

associated reference id
refType String

associated reference type:

  • services
  • inventory-stock-configurations

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-coverage-id",
  "insured": "<insured-organization's-id>",
  "insurer": "<insured-organization's-id>"
}

Coverage - Post

Back to top

Create an insurance-coverage

POST /insurance-coverages

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
paymentMethod String optional

how the insurer will pay the insured

  • prepaid means the insurer already paid a consumable amount of credits to the insured
  • postpaid means that the insurer will pay the insurer the accumulated amount in a set time
Allowed values: "prepaid","postpaid"
type String Allowed values: "deduction","override","unknown"
contract String
name String

coverage name
amount Number optional
percentage Number optional
ref String optional

associated reference id
refType String optional

associated reference type

Allowed values: "services","inventory-stock-configurations"

Examples

Example usage:

curl "https://yourdomain.com/insurance-coverages" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "contract": "some contract",
    "type": "deduction",
    "name": "name of the coverage"
  }'

Parameters examples

json - Request-Example

{
  "contract": "some contract",
  "type": "deduction",
  "name": "name of the coverage"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
contract String
insured String
insurer String
insurerType String
insurerSubtype String
paymentMethod String

how the insurer will pay the insured

  • prepaid
  • postpaid
type String
  • deduction
  • override
  • unknown
name String

coverage name
amount Number
percentage Number
ref String

associated reference id
refType String

associated reference type:

  • services
  • inventory-stock-configurations

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "insurance-coverage-id",
  "insured": "<insured-organization's-id>",
  "insurer": "<insured-organization's-id>"
}

results matching ""

    No results matching ""