PUT Sales Payment

Developing

PUT

{{url}}api/v1/admin/sales/payment/{payment_id}

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'http://ecompulse.test/api/v1/admin/sales/payment/11' \
--header 'Accept: application/json' \
--header 'X-API-Key: exzbLclGAzBCyL0k1Yv29Evu6mwoYOATBF0lWPyT' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sale_id": 5,
    "paid_date": "2024-04-11",
    "amount": 150.00,
    "note": "payment edit",
    "paying_by": 3
}'

Response Example

{
    "status": "success",
    "message": "Payment updated successfully",
    "data": {
        "id": 5,
        "reference_no": "INV-00003",
        "grand_total": "2,715.81",
        "paid": "2,450.00",
        "balance": "265.81",
        "paid_status": {
            "value": 0,
            "text": "Partial"
        },
        "warehouse": {
            "id": 1,
            "name": "Warehouse 1"
        },
        "customer": {
            "id": 3,
            "name": "Tom"
        },
        "biller": {
            "id": 2,
            "name": "William"
        },
        "status": {
            "value": 1,
            "text": "Completed"
        },
        "payments": [
            {
                "id": 7,
                "paid_date": "2024-05-19 23:00:00",
                "amount": "200.00",
                "note": "installment",
                "paying_by": {
                    "value": 1,
                    "text": "Card"
                }
            },
            {
                "id": 11,
                "paid_date": "2024-04-11 00:00:00",
                "amount": "150.00",
                "note": "payment edit",
                "paying_by": {
                    "value": 3,
                    "text": "Other"
                }
            },
            ...
            ...
            ...
        ]
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

payment_id

integer

required

Payment id

Example:

Header Params

string

required

Example:

application/json

X-API-Key

string

required

Example:

Body Params application/json

object {0}

Examples

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2024-05-27 01:29:02

POST Sales Payment

DELETE Sales Payment