This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!
URL: | https://api.kashflow.com/v2/bankaccounts/{accountId}/transactionlist |
Method(s): | delete, put |
Response Formats: | JSON or XML |
Description: | Delete method allows to delete multiple bank transactions at one go. Put method allows to assign transaction to an invoice/receipt payment. The request body should consist of List (array) of transaction ids to be deleted. |
Parameters
| Name | Type | Description |
|---|---|---|
| Account Id | Numeric | Unique bank identifier. |
| TransactionId | Numeric | Unique transaction identifier. |
| PaymentMethod | Numeric | Invoice/Purchase payment method identifier. Refer to Payment Methods API |
| Number | Numeric | The number of invoice/purchase to which the transaction is to be assigned. |
DELETE Operation
Deletes the bank transactions specified in the list of transaction ids. If any of the specified transaction id is invalid/locked, API will respond with 200 status including all invalid/locked transactions. In such a scenario, valid bank transaction will be deleted.
If all transactions are deleted successfully, API will respond with 204 status.
URL : /bankaccounts/{accountId}/transactionlist
{accountId} in the URL will be replaced by bank account id for which transactions needs to be deleted. If invalid bank account id is specified API will respond with 404.
Example request for DELETE of bank transactions
[ 101, 123, 2345, 65 ]
PUT Operation
Assign Transactions to Invoice/Purchase
URL : /bankaccounts/{accountId}/transactionlist
Assigns bank transaction to invoices and/or purchases. Note that, multiple transactions can be assigned to an Invoice or a Receipt, but vice-versa is not possible. So for example, in the below request, you can repeat an invoice number multiple times with different transactionIds. But you can’t repeat a transactionId with different invoices.
Example request for assigning transactions to invoice and/or purchase
{
"AssignToInvoices":[
{
"TransactionId":2378,
"PaymentMethod": 12,
"Number":67
},
{
"TransactionId":3452,
"PaymentMethod": 123,
"Number":27
}
],
"AssignToPurchases":[
{
"TransactionId":31413428,
"PaymentMethod": 123,
"Number":43
},
{
"TransactionId":3452,
"PaymentMethod": 123,
"Number":93
}
]
}
Status code 200 OK will be returned and Invalid/Failed bank transactions will be listed in the response.
If transaction Id is less than one, status code 400 will be returned and no transactions will be assigned.
Example response for assigning transactions to invoice and/or purchase
{
"AssignToInvoices":[11298,57672],
"AssignToPurchases":[168298,52312]
}