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//customers/{code}/advancepayments |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | Allows to retrieve advance payment for specified customer. |
Parameters
Name | Type | Description |
---|---|---|
Id | Numeric | Unique identifier for each payment |
Amount | Numeric | Payment amount |
Date | Date | Date on which payment is done |
Comment | String | Note for this record |
GET Operation
Returns a list of advance payment list.URL : /customers/{code}/advancepayments
{code} in the URL will be replaced by customer code for which advance payments needs to be fetched.
Example response for GET of credit list
[{
"Amount": 46.0000,
"Comment": "Advance Payment on Invoice Test #1111111435",
"Date": "2013-06-07 12:00:00",
"Id": 23438824
},
{
"Amount": 100.0000,
"Comment": "Advance Payment on Invoice Test #1111111462",
"Date": "2013-06-10 12:00:00",
"Id": 23438895
}, {
"Amount": 100.0000,
"Comment": "Advance Payment on Invoice Test #1111111465",
"Date": "2013-06-10 12:00:00",
"Id": 23438896
}, {
"Amount": 468.0000,
"Comment": "Advance Payment on Invoice Test #1111111461",
"Date": "2013-06-10 12:00:00",
"Id": 23438898,
"Type": "AdvancePayment"
}]