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": "ABC 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": "ABC 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
}

---

Updated As Of Version 7.0.1