Invoice Summary
The following Invoice Summary APIs allows users to view, retrieve, pay, adjust the invoices.
1. Invoice Records¶
Description
The invoiceRecords endpoint allows users to fetch the existing Invoice information.
Request
Endpoint
/ui/v1/invoiceRecords
Method
POST
Header
Content-Type: application/json
| ELEMENT | DESCRIPTION |
|---|---|
| startDate | Required Start Date to fetch the invoices from |
| endDate | Required End Date to fetch the invoices till that date |
| dateType name | Required Name of the Date Type ex: DUE, INVOICE,PAID |
| dateType value | Optional Value of the Date Type ex: DUE, INVOICE,PAID |
| merchantId | Required specific code used for each merchant |
Request Body
{
"startDate": "2021-03-23",
"endDate": "2021-03-30",
"invoiceStatus": [],
"customerType": [],
"dateType": {
"name": "DUE",
"value": "Due"
},
"customerId": [],
"paidByUserId": [],
"merchantId": ["1"]
}
Response
{
"records": null,
"recordCount": null,
"message": {
"code": "9999",
"type": {
"value": "Informational",
"name": "INFORMATIONAL"
},
"text": null,
"include_i_icon": false,
"description": "No records were found that match the filter criteria you entered."
}
}
2. Mark As Paid¶
Description
The markAsPaidStatus endpoint allows user to mark an Unpaid Invoice to Paid.
Request
Endpoint
/ui/v1/markAsPaidStatus
Method
POST
Header
Content-Type: application/json
Request Body
{
"id": 6384,
"invoiceNumber": "1111",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 33.93,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": null,
"amountDue": {
"amount": 33.93,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": "65",
"invoiceStatus": {
"value": "Unpaid",
"name": "PAID_OFFLINE"
},
"customerId": 6043,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Paid",
"amountAdjustedReason": null,
"customerNumber": "1000",
"customerName": "Xyz Abc",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": null,
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
Response
{
"id": 6384,
"invoiceNumber": "1111",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 33.93,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": 33.93,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"amountDue": {
"amount": 0.00,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": 65,
"invoiceStatus": {
"value": "Paid Offline",
"name": "PAID_OFFLINE"
},
"customerId": 6043,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Paid",
"amountAdjustedReason": null,
"customerNumber": "1000",
"customerName": "Xyz Abc",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": {
"code": "80",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Invoice <strong>1111</strong> has been Marked as Paid successfully."
},
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
3. Mark As Partially Paid¶
Description
The markAsPartiallyPaidStatus endpoint allows users to pay the invoices partially.
Request
Endpoint
/ui/v1/markAsPartiallyPaidStatus
Method
POST
Header
Content-Type: application/json
Request Body
{
"id": 6385,
"invoiceNumber": "1112",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": "100.00"
},
"amountDue": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": "65",
"invoiceStatus": {
"value": "Unpaid",
"name": "PARTIALLY_PAID_OFFLINE"
},
"customerId": 6044,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Partially paid",
"amountAdjustedReason": null,
"customerNumber": "1001",
"customerName": "Patient Test",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": null,
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
Response
{
"id": 6385,
"invoiceNumber": "1112",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": 100.00,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"amountDue": {
"amount": 125.00,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": 65,
"invoiceStatus": {
"value": "Partially Paid Offline",
"name": "PARTIALLY_PAID_OFFLINE"
},
"customerId": 6044,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Partially paid",
"amountAdjustedReason": null,
"customerNumber": "1001",
"customerName": "Patient Test",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": {
"code": "137",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Invoice <strong>1112</strong> has been Marked as Partially Paid successfully."
},
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
4. Mark As Unpaid¶
Description
The markAsUnpaid endpoint allows users to mark an paid invoice to Unpaid
Request
Endpoint
/ui/v1/markAsUnpaid
Method
POST
Header
Content-Type: application/json
Request Body
{
"id": 6385,
"invoiceNumber": "1112",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"amountDue": {
"amount": 0,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": "65",
"invoiceStatus": {
"value": "Paid Offline",
"name": "UNPAID"
},
"customerId": 6044,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Unpaid",
"amountAdjustedReason": null,
"customerNumber": "1001",
"customerName": "Patient Test",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": null,
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
Response
{
"id": 6385,
"invoiceNumber": "1112",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": 0.00,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"amountDue": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": 65,
"invoiceStatus": {
"value": "Unpaid",
"name": "UNPAID"
},
"customerId": 6044,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Unpaid",
"amountAdjustedReason": null,
"customerNumber": "1001",
"customerName": "Patient Test",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": {
"code": "81",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Invoice <strong>1112</strong> has been Marked as Unpaid successfully."
},
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
5. Adjust Balance¶
Description
The adjustInvoiceAmount endpoint allows users to adjust the balance of the invoices.
Request
Endpoint
/ui/v1/adjustInvoiceAmount
Method
POST
Header
Content-Type: application/json
Request Body
{
"id": 6385,
"invoiceNumber": "1112",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 225,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": 0,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"amountDue": {
"amount": "100.00",
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": "65",
"invoiceStatus": {
"value": "Unpaid",
"name": "UNPAID"
},
"customerId": 6044,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Unpaid",
"amountAdjustedReason": "Adjust",
"customerNumber": "1001",
"customerName": "Patient Test",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": null,
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
Response
{
"id": 6385,
"invoiceNumber": "1112",
"createdDateTime": 1604957997000,
"lastUpdatedDateTime": null,
"invoiceDate": 1604898000000,
"paidDate": null,
"dueDate": 1607490000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 100.00,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": 0,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"amountDue": {
"amount": 100.00,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 65,
"lastModifiedUserId": 65,
"invoiceStatus": {
"value": "Unpaid",
"name": "UNPAID"
},
"customerId": 6044,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark As Unpaid",
"amountAdjustedReason": "Adjust",
"customerNumber": "1001",
"customerName": "Patient Test",
"merchantName": "Zywie Business",
"paidByUserName": null,
"message": {
"code": "151",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Balance has been adjusted successfully."
},
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
6. Invoice Detail¶
Description
The invoiceDetail endpoint allows users to view the details of the invoices.
Request
Endpoint
/ui/v1/invoiceDetail?invoiceid=id
Note
Replace id with the internal id of the invoice.
Method
POST
Header
Content-Type: application/json
Request Body
{
"invoiceId": 137
}
Response
{
"id": 137,
"invoiceNumber": "500000051",
"createdDateTime": 1591980624000,
"lastUpdatedDateTime": 1607112324000,
"invoiceDate": 1591934400000,
"paidDate": null,
"dueDate": 1591848000000,
"terms": 30,
"aging": 0,
"invoiceAmount": {
"amount": 2000.000,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608316900000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"paidAmount": {
"amount": 0.000,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608316900000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"amountDue": {
"amount": 2000.000,
"currency": {
"id": 1,
"currencyCode": "USD",
"currencyText": "United States Dollar",
"currencySymbol": "$",
"fractionalUnit": "Cent",
"numOfDecimalPlaces": "2",
"supportedByVisaCheckout": true,
"createdDateTime": 1608316900000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"createdUserId": 231,
"lastModifiedUserId": 218,
"invoiceStatus": {
"value": "Unpaid",
"name": "UNPAID"
},
"customerId": 64,
"invoiceBatchId": null,
"paidByUserId": null,
"merchantId": 3,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"waiveReasonOnLateFees": null,
"waiveLateFeesByPercentage": null,
"waivedByUserId": null,
"waivedDate": null,
"memo": "Mark the invoice as Unpaid",
"amountAdjustedReason": null,
"customerNumber": "500020",
"customerName": "KK Health Care",
"merchantName": null,
"paidByUserName": null,
"message": null,
"geolocation": null,
"channelId": null,
"roleType": null,
"paymentAction": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"zipCode": null,
"phone": null,
"merchantCode": null
}
Updated As Of Version 3.8.0.9