Receipt Events

Receipt Events

curl --request POST \
  --url https://{partner_host}/registered_url_for_receipt_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "receipt.created",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "receipt_id": 2579,
    "aid": "d-75f3dcf1-5de3-40fc-8ccd-f42c8d54e8e8",
    "doctor_oid": "161467756044203",
    "clinic_id": "60b0ee0c0b5804795509aefb",
    "patient_oid": "176345969121476",
    "created_at": 1763476917560,
    "updated_at": 1763476917560,
    "receipt_number": null,
    "receipt_url": "https://doc-receipt.s3.ap-south-1.amazonaws.com/v2/b-161467756044203/161467756044203/60b0ee0c0b5804795509aefb/1763476916985.pdf",
    "receipt_status": "SUCCESS",
    "receipt_amount": 120,
    "additional_discount_value": 10,
    "additional_discount_type": "AMOUNT",
    "additional_discount_amount": 10,
    "net_amount": 120,
    "name": "gc baby normal",
    "mobile": "+919008888888",
    "flavour": null,
    "sku_discount_amount": 10,
    "amount_due": 10,
    "archive": 0,
    "remarks": "",
    "ref_trx_id": "",
    "payment_id": "ret-dfwef-dsfsd-fwefdsf",
    "payment_link": "https://example.link.com",
    "amount_paid": 10,
    "actor": "doctor"
  }
}
'

POST

registered_url_for_receipt_events

Receipt Events

curl --request POST \
  --url https://{partner_host}/registered_url_for_receipt_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "receipt.created",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "receipt_id": 2579,
    "aid": "d-75f3dcf1-5de3-40fc-8ccd-f42c8d54e8e8",
    "doctor_oid": "161467756044203",
    "clinic_id": "60b0ee0c0b5804795509aefb",
    "patient_oid": "176345969121476",
    "created_at": 1763476917560,
    "updated_at": 1763476917560,
    "receipt_number": null,
    "receipt_url": "https://doc-receipt.s3.ap-south-1.amazonaws.com/v2/b-161467756044203/161467756044203/60b0ee0c0b5804795509aefb/1763476916985.pdf",
    "receipt_status": "SUCCESS",
    "receipt_amount": 120,
    "additional_discount_value": 10,
    "additional_discount_type": "AMOUNT",
    "additional_discount_amount": 10,
    "net_amount": 120,
    "name": "gc baby normal",
    "mobile": "+919008888888",
    "flavour": null,
    "sku_discount_amount": 10,
    "amount_due": 10,
    "archive": 0,
    "remarks": "",
    "ref_trx_id": "",
    "payment_id": "ret-dfwef-dsfsd-fwefdsf",
    "payment_link": "https://example.link.com",
    "amount_paid": 10,
    "actor": "doctor"
  }
}
'

Body

application/json

event

enum<string>

required

Type of event

Available options:

receipt.created,

receipt.updated,

receipt.deleted

Example:

"receipt.created"

event_time

integer

required

Event occurred timestamp

Example:

1730189586

timestamp

integer

required

Timestamp of the event

Example:

1730189586

client_id

string

required

Client ID for the schedule

Example:

"67978400352a61001d64e9fb"

business_id

string

required

Business ID for the schedule

Example:

"174159057718553"

data

object

required

Show child attributes

data.receipt_id

integer

required

Unique identifier for the receipt

Example:

2579

data.aid

string

required

Appointment Id

Example:

"d-75f3dcf1-5de3-40fc-8ccd-f42c8d54e8e8"

data.doctor_oid

string

required

Unique identifier for the doctor

Example:

"161467756044203"

data.clinic_id

string

required

Clinic identifier

Example:

"60b0ee0c0b5804795509aefb"

data.patient_oid

string

required

Unique identifier for the patient

Example:

"176345969121476"

data.created_at

integer

required

Timestamp when the receipt was created (in milliseconds)

Example:

1763476917560

data.updated_at

integer

required

Timestamp when the receipt was last updated (in milliseconds)

Example:

1763476917560

data.receipt_number

string

required

Human-readable receipt number

Example:

null

data.receipt_url

string

required

URL to download/view the receipt

Example:

"https://doc-receipt.s3.ap-south-1.amazonaws.com/v2/b-161467756044203/161467756044203/60b0ee0c0b5804795509aefb/1763476916985.pdf"

data.receipt_status

string

required

Status of the receipt

Example:

"SUCCESS"

data.receipt_amount

number

required

Total amount on the receipt

Example:

120

data.additional_discount_value

number

required

Value of any additional discount

Example:

10

data.additional_discount_type

string

required

Type of additional discount

Example:

"AMOUNT"

data.additional_discount_amount

number

required

Amount reduced due to additional discount

Example:

10

data.net_amount

number

required

Net payable amount after discounts

Example:

120

data.name

string

required

Name of the patient

Example:

"gc baby normal"

data.mobile

string

required

Patient's mobile number

Example:

"+919008888888"

data.flavour

string

required

Flavour or type of receipt/service

Example:

null

data.sku_discount_amount

number

required

Discount amount applied per SKU/item

Example:

10

data.amount_due

number

required

Remaining amount to be paid

Example:

10

data.archive

integer

required

Whether the receipt is archived (0 or 1)

Example:

0

data.remarks

string

required

Additional remarks about the transaction

Example:

""

data.ref_trx_id

string

required

Reference transaction ID

Example:

""

data.payment_id

string

required

Unique identifier for the payment

Example:

"ret-dfwef-dsfsd-fwefdsf"

data.payment_link

string

required

URL for payment completion

Example:

"https://example.link.com"

data.amount_paid

number

required

Amount already paid

Example:

10

data.actor

string

required

Who performed the action or update

Example:

"doctor"

Consent Form Events Overview

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Body