Appointment Billing Details API

Field

Data Type

Max Length

Description

Required

Expected Value

Example

Field

Data Type

Max Length

Description

Required

Expected Value

Example

1

appointmentId

Integer

 

Appointment Id

Yes

Integer

28140368

2

evvStatusId

Integer

 

Code of Evv Status

No

Pending = 1,

Approved = 2,

Submitted = 3,

Success = 4,

Rejected = 5   

null,

2

null

 

3

evvRejectedReason

string

 

Description of the reason for EVV rejected status

No

String value, null

  null,

  "Appointment has empty HhaxTransactionID" …

4

evvReasonCodes

Array of EvvReason models

-

 

No

EvvReasonCodes

  id                                 integer($int32)

  appointmentId              integer($int32)

  evvReasonCodeId       integer($int32)

  isDeactivated               boolean

nullable: true

note 

string

nullable: true

Examples:

"evvReasonCodes": [

{

"id": 2764,            "appointmentId": 7452637,          "evvReasonCodeId": 23,          "isDeactivated": null,

"note": null

},

{

"id": 2765,

"appointmentId": 7452637,

"evvReasonCodeId": 22,

"isDeactivated": true,

"note": “Some note”

}

  ]

5

evvAcknowledgedExceptions

Array of AcknowledgeableException

-

 

No

AcknowledgeableException

  id                       integer($int32)

  appointmentId    integer($int32)

  exceptionId       integer($int32)

Examples:

"evvAcknowledgedExceptions": [

            {

                "id": 463,             "appointmentId": 28140368,          "exceptionId": 11 }

6

kareoEncounterId

Integer

-

 

No

Integer value, null

null

440223

7

sandataID

string

250

 

No

String value, null

null

981426e4-079e-4ad5-905c-41e9825d527b

8

hhaxTransactionID

string

250

 

No

String value, null

null

4f6e1533-bf2e-4059-90cf-ada6fa5f081d