Create invoice

POST

/companies/{companyId}/invoices

Maintainer:Not configured

Raise an invoice for a company

Request

Authorization

Add parameter in header

Example:

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

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/companies//invoices' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientId": "string",
    "date": "string",
    "dueDate": "string",
    "currency": "USD",
    "prefix": "string",
    "lineItems": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "GOODS",
            "description": "Premium Widget",
            "price": 100,
            "quantity": 2,
            "unit": "pieces",
            "sortOrder": 1,
            "taxId": "string"
        }
    ],
    "status": "string",
    "discountType": "percentage",
    "discountValue": 0,
    "deliveryOptions": {
        "email": {
            "send": true,
            "subject": "string",
            "recipients": [
                "string"
            ],
            "body": "string"
        }
    }
}'

Response Example

{
    "success": true,
    "data": {
        "id": "string",
        "companyId": "string",
        "clientId": "string",
        "number": 0,
        "prefix": "string",
        "financialYear": "string",
        "date": "string",
        "dueDate": "string",
        "status": "string",
        "currency": "string",
        "createdAt": "string",
        "lineItems": [
            {
                "id": "string",
                "invoiceId": "string",
                "itemId": "string",
                "type": "GOODS",
                "description": "string",
                "price": 0,
                "quantity": 0,
                "unit": "string",
                "sortOrder": 0,
                "createdAt": "string",
                "taxId": "string"
            }
        ],
        "client": {},
        "company": {},
        "discountType": "percentage",
        "discountValue": 0,
        "paymentStatus": "paid",
        "payments": [
            {
                "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

List invoices

Get invoice by ID