curl --request GET \
--url https://api.halth.com/v1/businesses/{businessId}/transactions{
"items": [
{
"id": "<string>",
"businessId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"status": "pending",
"amount": 123,
"currency": "<string>",
"paymentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123,
"status": "pending",
"paymentId": "<string>",
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"paymentMethodId": "<string>",
"clientSecret": "<string>"
},
"claimId": "<string>",
"claim": {
"id": "<string>",
"referenceNumber": "<string>",
"status": "created",
"createdAt": "2023-11-07T05:31:56Z",
"isRebateEstimate": true,
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"serviceTypeCode": "F",
"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": {
"claims": "active",
"rebatesEstimates": "active"
}
},
"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>",
"serviceTypeCode": "F"
}
},
"medicareClaimId": "<string>",
"medicareClaim": {
"id": "<string>",
"status": "created",
"createdAt": "2023-11-07T05:31:56Z",
"type": "patient",
"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": "full_paid",
"reference": "<string>",
"patientMedicareCardId": "<string>",
"claimantMedicareCardId": "<string>",
"mcolClaimId": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"transactionId": "<string>"
}
}
],
"transactionItems": [
{
"id": "<string>",
"type": "charge",
"chargeAmount": 123,
"description": "<string>",
"clinicalCode": "<string>",
"itemCode": "<string>",
"billableItemId": "<string>",
"billableItem": {
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"type": "service",
"id": "<string>",
"itemCode": "<string>",
"pmsBillableItemId": "<string>"
},
"appointmentTypeId": "<string>"
}
],
"confirmations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"contactType": "sms",
"contactValue": "<string>",
"verified": true,
"action": "payment_confirmation",
"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": {
"claims": "active",
"rebatesEstimates": "active"
}
},
"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>"
}
}
],
"page": 1,
"limit": 10,
"totalItems": 100,
"totalPages": 10
}Get a paged list of transactions for a business
curl --request GET \
--url https://api.halth.com/v1/businesses/{businessId}/transactions{
"items": [
{
"id": "<string>",
"businessId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"status": "pending",
"amount": 123,
"currency": "<string>",
"paymentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123,
"status": "pending",
"paymentId": "<string>",
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"paymentMethodId": "<string>",
"clientSecret": "<string>"
},
"claimId": "<string>",
"claim": {
"id": "<string>",
"referenceNumber": "<string>",
"status": "created",
"createdAt": "2023-11-07T05:31:56Z",
"isRebateEstimate": true,
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"serviceTypeCode": "F",
"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": {
"claims": "active",
"rebatesEstimates": "active"
}
},
"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>",
"serviceTypeCode": "F"
}
},
"medicareClaimId": "<string>",
"medicareClaim": {
"id": "<string>",
"status": "created",
"createdAt": "2023-11-07T05:31:56Z",
"type": "patient",
"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": "full_paid",
"reference": "<string>",
"patientMedicareCardId": "<string>",
"claimantMedicareCardId": "<string>",
"mcolClaimId": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"transactionId": "<string>"
}
}
],
"transactionItems": [
{
"id": "<string>",
"type": "charge",
"chargeAmount": 123,
"description": "<string>",
"clinicalCode": "<string>",
"itemCode": "<string>",
"billableItemId": "<string>",
"billableItem": {
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"type": "service",
"id": "<string>",
"itemCode": "<string>",
"pmsBillableItemId": "<string>"
},
"appointmentTypeId": "<string>"
}
],
"confirmations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"contactType": "sms",
"contactValue": "<string>",
"verified": true,
"action": "payment_confirmation",
"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": {
"claims": "active",
"rebatesEstimates": "active"
}
},
"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>"
}
}
],
"page": 1,
"limit": 10,
"totalItems": 100,
"totalPages": 10
}Page number
1 <= x <= 90071992547409911
Number of items per page
1 <= x <= 20010
transactionItems.billableItem, paymentTransactions.payment.clientSecret