Payments Collected
GET https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/payments_collected
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | created during or after the given date i.e. 2019-01-01 | |
end_date | string | created during or before the given date i.e. 2019-05-01 | |
currency_code | string | reports using the given currency as primary currency i.e. "USD" | |
clientids | null | returns data from specific client(s) i.e. 31007, 32291 | |
payment_method | string | returns data from clients who used the specific method of payment i.e. "Visa", "Cash", etc. |
RESPONSES
status: OK
{"response":{"result":{"payments_collected":{"clientids":[],"currency_codes":[],"download_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJwYXltZW50c19jb2xsZWN0ZWQiLCJwYXJhbXMiOnsic3RhcnRfZGF0ZSI6IjIwMTktMDQtMjQiLCJlbmRfZGF0ZSI6IjIwMTktMDQtMjQiLCJjdXJyZW5jeV9jb2RlcyI6bnVsbCwiY2xpZW50aWRzIjpudWxsLCJwYXltZW50X21ldGhvZHMiOm51bGx9LCJpYXQiOjE1NTYxMzA2MzksImV4cCI6MTU1ODcyMjYzOX0.MzRz-wIKOTpSjvsp90JGLQmO1oIA92SqLz93tPlHCRU","end_date":"2019-04-24","payment_methods":[],"payments":[],"start_date":"2019-04-24","totals":[]}}}}