Create claim for transaction
curl --request POST \
--url https://api.halth.com/v1/businesses/{businessId}/transactions/{transactionId}/claims \
--header 'Content-Type: application/json' \
--data '
{
"medicare": {
"medicareCardId": "<string>"
}
}
'{
"id": "<string>",
"businessId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"paymentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123,
"adjustmentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123
}
],
"paymentId": "<string>",
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"paymentMethodId": "<string>",
"clientSecret": "<string>"
},
"claimId": "<string>",
"claim": {
"id": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"isRebateEstimate": true,
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"providerNumber": "<string>",
"items": [
{
"id": "<string>",
"chargeAmount": 123,
"itemCode": "<string>",
"serviceDate": "2023-11-07T05:31:56Z",
"patientReferenceNumber": "<string>",
"rebateAmount": 123,
"serviceReference": "<string>",
"itemDescription": "<string>",
"itemName": "<string>",
"response": {
"statusCode": "<string>",
"responseCode": "<string>"
}
}
],
"device": {
"terminalId": "<string>"
},
"serviceType": {
"code": "<string>",
"name": "<string>"
},
"healthFund": {
"id": "<string>",
"name": "<string>",
"capabilities": {}
},
"rules": {
"reversal": {
"enabled": true
}
},
"cancelledAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"response": {
"statusCode": "<string>",
"responseCode": "<string>",
"freeText": "<string>"
},
"payment": {
"paymentAmount": 123,
"bankAccountNumberLast4": "<string>",
"bankAccountBsb": "<string>",
"paymentDate": "2023-11-07T05:31:56Z",
"paymentReference": "<string>"
},
"provider": {
"providerNumber": "<string>",
"name": "<string>",
"categoryCode": "<string>"
}
},
"medicareClaimId": "<string>",
"medicareClaim": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"type": {},
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"itemsCount": 123,
"mcolTransactionId": "<string>",
"items": [
{
"id": "<string>",
"itemCode": "<string>",
"chargeAmount": 123,
"rebateAmount": 123,
"gapAmount": 123,
"mcolAssessmentCode": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"patientCount": 123,
"quantity": 123
}
],
"paymentStatus": {},
"rules": {
"reversal": {
"enabled": true
}
},
"reference": "<string>",
"patientMedicareCardId": "<string>",
"claimantMedicareCardId": "<string>",
"mcolClaimId": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"transactionId": "<string>"
}
}
],
"transactionItems": [
{
"chargeAmount": 123,
"id": "<string>",
"description": "<string>",
"clinicalCode": "<string>",
"itemCode": "<string>",
"billableItemId": "<string>",
"billableItem": {
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"id": "<string>",
"itemCode": "<string>",
"serviceItem": {
"id": "<string>",
"itemCode": "<string>",
"category": "<string>",
"description": "<string>"
},
"pmsBillableItemId": "<string>"
},
"appointmentTypeId": "<string>"
}
],
"confirmations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"contactValue": "<string>",
"verified": true,
"expiresAt": "2023-11-07T05:31:56Z",
"verificationCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"paymentMethodId": "<string>",
"paymentMethod": {
"id": "<string>",
"brand": "<string>",
"last4": "<string>",
"customerId": "<string>"
},
"healthFundCardId": "<string>",
"healthFundCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"healthFundId": "<string>",
"healthFund": {
"id": "<string>",
"name": "<string>",
"capabilities": {}
},
"cardholders": [
"<string>"
],
"fingerprint": "<string>",
"verified": true,
"defaultReferenceNumber": "<string>",
"issueNumber": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"medicareCardId": "<string>",
"medicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"bookingId": "<string>",
"customer": {
"name": "<string>"
},
"clientName": "<string>",
"client": {
"id": "<string>",
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"mobileNumber": "<string>",
"email": "<string>",
"pmsPatientId": "<string>",
"pmsCreatedAt": "2023-11-07T05:31:56Z",
"profileImageUrl": "<string>"
},
"serviceProvider": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationIds": [
"<string>"
],
"deleted": true,
"bookingsEnabled": true,
"mobileNumber": "<string>",
"email": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"profileImageUrl": "<string>",
"locationLinks": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetter": "<string>"
},
"association": {
"registrationLetter": "<string>"
}
}
],
"locations": [
{
"id": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"timeZone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"suggestedTaxIdentifier": "<string>",
"bookingCustomText": "<string>",
"businessId": "<string>",
"business": {
"id": "<string>",
"name": "<string>",
"settings": {
"autoReconciliationEnabled": true,
"autoInviteClientsEnabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"taxIdentifier": "<string>",
"countryCode": "<string>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"status": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
}
}
]
},
"location": {
"id": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"timeZone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"suggestedTaxIdentifier": "<string>",
"bookingCustomText": "<string>",
"businessId": "<string>",
"business": {
"id": "<string>",
"name": "<string>",
"settings": {
"autoReconciliationEnabled": true,
"autoInviteClientsEnabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"taxIdentifier": "<string>",
"countryCode": "<string>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"status": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
}
}
}Transaction
Create claim for transaction
Create a claim for a transaction
POST
/
v1
/
businesses
/
{businessId}
/
transactions
/
{transactionId}
/
claims
Create claim for transaction
curl --request POST \
--url https://api.halth.com/v1/businesses/{businessId}/transactions/{transactionId}/claims \
--header 'Content-Type: application/json' \
--data '
{
"medicare": {
"medicareCardId": "<string>"
}
}
'{
"id": "<string>",
"businessId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"paymentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123,
"adjustmentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123
}
],
"paymentId": "<string>",
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"paymentMethodId": "<string>",
"clientSecret": "<string>"
},
"claimId": "<string>",
"claim": {
"id": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"isRebateEstimate": true,
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"providerNumber": "<string>",
"items": [
{
"id": "<string>",
"chargeAmount": 123,
"itemCode": "<string>",
"serviceDate": "2023-11-07T05:31:56Z",
"patientReferenceNumber": "<string>",
"rebateAmount": 123,
"serviceReference": "<string>",
"itemDescription": "<string>",
"itemName": "<string>",
"response": {
"statusCode": "<string>",
"responseCode": "<string>"
}
}
],
"device": {
"terminalId": "<string>"
},
"serviceType": {
"code": "<string>",
"name": "<string>"
},
"healthFund": {
"id": "<string>",
"name": "<string>",
"capabilities": {}
},
"rules": {
"reversal": {
"enabled": true
}
},
"cancelledAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"response": {
"statusCode": "<string>",
"responseCode": "<string>",
"freeText": "<string>"
},
"payment": {
"paymentAmount": 123,
"bankAccountNumberLast4": "<string>",
"bankAccountBsb": "<string>",
"paymentDate": "2023-11-07T05:31:56Z",
"paymentReference": "<string>"
},
"provider": {
"providerNumber": "<string>",
"name": "<string>",
"categoryCode": "<string>"
}
},
"medicareClaimId": "<string>",
"medicareClaim": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"type": {},
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"itemsCount": 123,
"mcolTransactionId": "<string>",
"items": [
{
"id": "<string>",
"itemCode": "<string>",
"chargeAmount": 123,
"rebateAmount": 123,
"gapAmount": 123,
"mcolAssessmentCode": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"patientCount": 123,
"quantity": 123
}
],
"paymentStatus": {},
"rules": {
"reversal": {
"enabled": true
}
},
"reference": "<string>",
"patientMedicareCardId": "<string>",
"claimantMedicareCardId": "<string>",
"mcolClaimId": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"transactionId": "<string>"
}
}
],
"transactionItems": [
{
"chargeAmount": 123,
"id": "<string>",
"description": "<string>",
"clinicalCode": "<string>",
"itemCode": "<string>",
"billableItemId": "<string>",
"billableItem": {
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"id": "<string>",
"itemCode": "<string>",
"serviceItem": {
"id": "<string>",
"itemCode": "<string>",
"category": "<string>",
"description": "<string>"
},
"pmsBillableItemId": "<string>"
},
"appointmentTypeId": "<string>"
}
],
"confirmations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"contactValue": "<string>",
"verified": true,
"expiresAt": "2023-11-07T05:31:56Z",
"verificationCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"paymentMethodId": "<string>",
"paymentMethod": {
"id": "<string>",
"brand": "<string>",
"last4": "<string>",
"customerId": "<string>"
},
"healthFundCardId": "<string>",
"healthFundCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"healthFundId": "<string>",
"healthFund": {
"id": "<string>",
"name": "<string>",
"capabilities": {}
},
"cardholders": [
"<string>"
],
"fingerprint": "<string>",
"verified": true,
"defaultReferenceNumber": "<string>",
"issueNumber": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"medicareCardId": "<string>",
"medicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"bookingId": "<string>",
"customer": {
"name": "<string>"
},
"clientName": "<string>",
"client": {
"id": "<string>",
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"mobileNumber": "<string>",
"email": "<string>",
"pmsPatientId": "<string>",
"pmsCreatedAt": "2023-11-07T05:31:56Z",
"profileImageUrl": "<string>"
},
"serviceProvider": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationIds": [
"<string>"
],
"deleted": true,
"bookingsEnabled": true,
"mobileNumber": "<string>",
"email": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"profileImageUrl": "<string>",
"locationLinks": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetter": "<string>"
},
"association": {
"registrationLetter": "<string>"
}
}
],
"locations": [
{
"id": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"timeZone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"suggestedTaxIdentifier": "<string>",
"bookingCustomText": "<string>",
"businessId": "<string>",
"business": {
"id": "<string>",
"name": "<string>",
"settings": {
"autoReconciliationEnabled": true,
"autoInviteClientsEnabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"taxIdentifier": "<string>",
"countryCode": "<string>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"status": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
}
}
]
},
"location": {
"id": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"timeZone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"suggestedTaxIdentifier": "<string>",
"bookingCustomText": "<string>",
"businessId": "<string>",
"business": {
"id": "<string>",
"name": "<string>",
"settings": {
"autoReconciliationEnabled": true,
"autoInviteClientsEnabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"taxIdentifier": "<string>",
"countryCode": "<string>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"status": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.halth.com/llms.txt
Use this file to discover all available pages before exploring further.
Body
application/json
Show child attributes
Show child attributes
Response
201 - application/json
Available options:
standard, late_cancellation, no_show Available options:
pending, completed, requires_confirmation, requires_payment, requires_review, reversed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
