api-docs v5.116.0

API Docs

Table of contents

Billing_SOA

Billing SOA - Delete

Back to top

Delete a specific billing soa. Can only delete finalized items

DELETE /billing-soas/: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/billing-soas/<billing-soa-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string Allowed values: organization,insurance-contract
externalSOAId string
customer string
template string
LOANo string
invoices string[]
invoiceItems string[]
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
receivedAt number

timestamp
paymentTerms number
note string
coveragePaymentMethod string Allowed values: prepaid,postpaid
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
finalizedAt number

timestamp
finalizedBy string

account uid
customerType string
customerSubtype string

Success response example

Success response example - Success-Response:

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

Billing SOA - Find

Back to top

Get list of billing soas

GET /billing-soas

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

Success response

Success response - Success 200

Name Type Description
billingSOAs[] object[]

array of billingSOA
billingSOAs.id string
billingSOAs.facility string
billingSOAs.type string Allowed values: organization,insurance-contract
billingSOAs.externalSOAId string
billingSOAs.customer string
billingSOAs.template string
billingSOAs.LOANo string
billingSOAs.invoices string[]
billingSOAs.invoiceItems string[]
billingSOAs.startAt number

timestamp
billingSOAs.endAt number

timestamp
billingSOAs.preparedAt number

timestamp
billingSOAs.receivedAt number

timestamp
billingSOAs.paymentTerms number
billingSOAs.note string
billingSOAs.coveragePaymentMethod string Allowed values: prepaid,postpaid
billingSOAs.createdAt number

timestamp

Default value: currentTime
billingSOAs.createdBy string

account uid
billingSOAs.finalizedAt number

timestamp
billingSOAs.finalizedBy string

account uid
billingSOAs.customerType string
billingSOAs.customerSubtype 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"
  }
]

Billing SOA - Get

Back to top

Get a specific billing soa

GET /billing-soas/: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/billing-soas/<billing-soa-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string Allowed values: organization,insurance-contract
externalSOAId string
customer string
template string
LOANo string
invoices string[]
invoiceItems string[]
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
receivedAt number

timestamp
paymentTerms number
note string
coveragePaymentMethod string Allowed values: prepaid,postpaid
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
finalizedAt number

timestamp
finalizedBy string

account uid
customerType string
customerSubtype string

Success response example

Success response example - Success-Response:

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

Billing SOA - Patch

Back to top

Update billing soa

PATCH /billing-soas/: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
externalSOAId string optional
template string optional
LOANo string optional
invoices string[] optional
invoiceItems string[] optional
startAt number optional

timestamp
endAt number optional

timestamp
preparedAt number optional

timestamp
receivedAt number optional

timestamp
paymentTerms number optional
note string optional
coveragePaymentMethod string optional Allowed values: prepaid,postpaid
createdAt number optional

timestamp

Default value: currentTime
finalize boolean optional

directive

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "note": "some note"
}

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string Allowed values: organization,insurance-contract
externalSOAId string
customer string
template string
LOANo string
invoices string[]
invoiceItems string[]
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
receivedAt number

timestamp
paymentTerms number
note string
coveragePaymentMethod string Allowed values: prepaid,postpaid
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
finalizedAt number

timestamp
finalizedBy string

account uid
customerType string
customerSubtype string

Success response example

Success response example - Success-Response:

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

Billing SOA - Post

Back to top

Create billing soa

POST /billing-soas

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
facility string
type string Allowed values: organization,insurance-contract
externalSOAId string optional
customer string
template string optional
LOANo string optional
invoices string[] optional
invoiceItems string[] optional
startAt number optional

timestamp
endAt number optional

timestamp
preparedAt number optional

timestamp
receivedAt number optional

timestamp
paymentTerms number optional
note string optional
coveragePaymentMethod string optional Allowed values: prepaid,postpaid
createdAt number optional

timestamp

Default value: currentTime

Examples

Example usage:

curl "https://yourdomain.com/billing-soas" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "facility": "facility-id",
    "type": "organization",
    "customer": "customer-id"
  }'

Parameters examples

json - Request-Example

{
  "facility": "facility-id",
  "type": "organization",
  "customer": "customer-id"
}

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string Allowed values: organization,insurance-contract
externalSOAId string
customer string
template string
LOANo string
invoices string[]
invoiceItems string[]
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
receivedAt number

timestamp
paymentTerms number
note string
coveragePaymentMethod string Allowed values: prepaid,postpaid
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
finalizedAt number

timestamp
finalizedBy string

account uid
customerType string
customerSubtype 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 ""