Get all payments for a company

GET

/companies/{companyId}/payments

Maintainer:Not configured

Retrieves all payments recorded for a company with associated invoice details

Request

Authorization

Add parameter in header

Example:

X-Token: ********************

Path Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/companies//payments' \
--header 'Authorization: <api-key>'

Response Example

{
    "success": true,
    "data": [
        {
            "id": "inv_pay_123",
            "amount": 1000,
            "currencyCode": "USD",
            "paymentDate": "2024-03-15",
            "notes": "Payment for March services",
            "referenceNumber": "REF123",
            "createdAt": "2024-03-15T10:30:00Z",
            "invoice": {
                "id": "inv_123",
                "number": 1001,
                "prefix": "INV",
                "date": "2024-03-10"
            }
        }
    ],
    "errors": [
        "string"
    ]
}

Modified at 2025-05-14 11:50:50

Delete a company

Client