Skip to main content

Transactions

Track income and expenses with transaction records.

Create Transaction

POST https://api.invoiless.com/v1/transactions

Create a new transaction (income or expense).

Example:

{
"type": "Income",
"amount": 1500.0,
"currency": "USD",
"date": "2024-01-15",
"customer": "customer_id",
"category": "category_id",
"method": "BankTransfer",
"referenceId": "INV-2024-001",
"notes": "Payment for invoice #001",
"taxes": [
{
"name": "VAT",
"type": "Percentage",
"value": 20
}
]
}

Body Parameters

NameTypeDescriptionRequired
typestringTransaction type: Income or ExpenseYes
amountnumberTransaction amount (must be > 0)Yes
currencystringISO 4217 currency codeNo
datedateTransaction dateNo
customerstringCustomer IDNo
categorystringCategory IDNo
methodstringPayment method: Cash, Cheque, Card, BankTransfer, or OtherNo
referenceIdstringReference ID (max 50 characters)No
notesstringTransaction notes (max 500 characters)No
taxesarrayTransaction taxes (max 3 taxes)No

Taxes Parameters

NameTypeDescriptionRequired
namestringTax name (max 15 characters)No
typestringTax type, possible values are Flat or PercentageNo, default is Percentage
valuenumberTax valueYes

Response HTTP/1.1 201 Created

Returns the created transaction object.

Update Transaction

PUT https://api.invoiless.com/v1/transactions/:id

PATCH https://api.invoiless.com/v1/transactions/:id

Update an existing transaction. See PUT vs PATCH for details on the differences.

Path Parameters

NameTypeDescriptionRequired
idstringTransaction idYes

Body Parameters

Accepts the same parameters as Create Transaction.

Get Transaction

GET https://api.invoiless.com/v1/transactions/:id

Retrieve a specific transaction by ID.

Path Parameters

NameTypeDescriptionRequired
idstringTransaction idYes

Get Transactions

GET https://api.invoiless.com/v1/transactions

Retrieve a paginated list of all transactions.

Query Parameters

NameTypeDescriptionRequired
pagenumberPage numberNo, default is 1
limitnumberPage limitNo , default is 50
searchstringSearch by reference ID or notesNo

Delete Transaction

DELETE https://api.invoiless.com/v1/transactions/:id

Permanently delete a transaction.

Path Parameters

NameTypeDescriptionRequired
idstringTransaction idYes