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/paymentmethods |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve all payment methods set up for user account. |
Parameters
| Name | Type | Description |
|---|---|---|
| Id | Numeric | Unique id assigned to payment method |
| Name | String | Payment method name |
| IsDefault | Boolean | Flag indicating whether this method is default for user account. |
GET Operation
Returns list of payment methods for invoices.URL : /paymentmethods/invoice
Example response for GET of payment method list
[{
"Id": 409844,
"IsDefault": true,
"Name": "Bank Transfer"
}, {
"Id": 409845,
"IsDefault": false,
"Name": "Cash"
}, {
"Id": 409846,
"IsDefault": false,
"Name": "Cheque"
}, {
"Id": 409847,
"IsDefault": false,
"Name": "Other"
}, {
"Id": 410158,
"IsDefault": false,
"Name": "Test"
}]
GET Operation
Returns list of payment methods for receipts.URL : /paymentmethods/receipt
Example response for GET of payment method list
[{
"Id": 140300,
"Name": "Cheque"
}, {
"Id": 140302,
"Name": "Company Credit Card"
}, {
"Id": 140301,
"Name": "Company Debit Card"
}, {
"Id": 140299,
"Name": "Other"
}, {
"Id": 140606,
"Name": "Test"
}]