api-docs v5.116.0

API Docs

Table of contents

Billing_Payment

Billing Payment - Delete

Back to top

Delete a specific billing payment

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

Success response

Success response - Success 200

Name Type Description
id string

payment id (internal to invoice item)
createdAt number

timestamp
createdBy string

account uid
facility string
target string

soa id if for soa
item string

invoice item id
itemType string
idemp string

idempotency key
type string Allowed values: private,insurance-converage,corporate-partner-coverage,refund,action-code,soa
subtype string Allowed values: government,hmo
paymentMethod string

payment method code
paymentMethodType string
paymentMethodName string
ref string
amount number
coverage string

coverage id for resolving coverage
notes string
metadata object
voidedAt number
voidedBy string
voidReason string
returnedAt number
returnedBy string
returnReason string

Success response example

Success response example - Success-Response:

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

Billing Payment - Find

Back to top

Get list of billing payments

GET /billing-payments

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

Success response

Success response - Success 200

Name Type Description
billingPayments object[]

array of billingPayment
billingPayments.id string

payment id (internal to invoice item)
billingPayments.createdAt number

timestamp
billingPayments.createdBy string
billingPayments.facility string
billingPayments.target string

soa id if for soa
billingPayments.item string

invoice item id
billingPayments.itemType string
billingPayments.idemp string

idempotency key
billingPayments.type string
billingPayments.subtype string
billingPayments.paymentMethod string

payment method code
billingPayments.paymentMethodType string
billingPayments.paymentMethodName string
billingPayments.ref string
billingPayments.amount number
billingPayments.coverage string

coverage id for resolving coverage
billingPayments.notes string
billingPayments.metadata object
billingPayments.voidedAt number
billingPayments.voidedBy string
billingPayments.voidReason string
billingPayments.returnedAt number
billingPayments.returnedBy string
billingPayments.returnReason 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 Payment - Get

Back to top

Get a specific billing payment

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

Success response

Success response - Success 200

Name Type Description
id string

payment id (internal to invoice item)
createdAt number

timestamp
createdBy string

account uid
facility string
target string

soa id if for soa
item string

invoice item id
itemType string
idemp string

idempotency key
type string Allowed values: private,insurance-converage,corporate-partner-coverage,refund,action-code,soa
subtype string Allowed values: government,hmo
paymentMethod string

payment method code
paymentMethodType string
paymentMethodName string
ref string
amount number
coverage string

coverage id for resolving coverage
notes string
metadata object
voidedAt number
voidedBy string
voidReason string
returnedAt number
returnedBy string
returnReason string

Success response example

Success response example - Success-Response:

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

Billing Payment - Post

Back to top

Create billing payment

POST /billing-payments

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

timestamp

Default value: currentTime
target string optional

soa id if for soa
item string optional

invoice item id
itemType string optional
idemp string optional

idempotency key
type string Allowed values: private,insurance-converage,corporate-partner-coverage,refund,action-code,soa
subtype string optional Allowed values: government,hmo
paymentMethod string optional

payment method code
paymentMethodType string optional
paymentMethodName string optional
ref string optional
amount number
coverage string optional

coverage id for resolving coverage
notes string optional
metadata object optional
voidedAt number
voidedBy string
voidReason string
returnedAt number
returnedBy string
returnReason string

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "facility": "facility-id",
  "type": "private",
  "amount": 1000
}

Success response

Success response - Success 200

Name Type Description
id string

payment id (internal to invoice item)
createdAt number

timestamp
createdBy string

account uid
facility string
target string

soa id if for soa
item string

invoice item id
itemType string
idemp string

idempotency key
type string Allowed values: private,insurance-converage,corporate-partner-coverage,refund,action-code,soa
subtype string Allowed values: government,hmo
paymentMethod string

payment method code
paymentMethodType string
paymentMethodName string
ref string
amount number
coverage string

coverage id for resolving coverage
notes string
metadata object
voidedAt number
voidedBy string
voidReason string
returnedAt number
returnedBy string
returnReason 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 ""