{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/recurrings.json","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"hasMore\":true,\n    \"data\":[\n        {\n            \"id\":123,\n            ...\n        },\n        {\n            \"id\":124,\n            ...\n        },\n        {\n            \"id\":125,\n            ...\n        }\n    ]\n}","name":""}]},"method":"get","examples":{"codes":[]},"params":[{"name":"page","type":"int","default":"1","desc":"page number","required":false,"in":"query","ref":"","_id":"5cbf003104d60400d53836cd"},{"name":"perPage","type":"int","default":"100","desc":"number of objects per page","required":false,"in":"query","ref":"","_id":"5cd4374277d49202e01e92ca"}]},"next":{"description":"","pages":[]},"title":"/recurrings.json","type":"endpoint","slug":"recurrings-list","excerpt":"Returns a collection of recurring payments that fits to a given criteria array.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Pagination\",\n  \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\\n\\n(with pagination: /recurrings.xml?page={page_number})\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Filter by criteria\"\n}\n[/block]\nGET /recurrings.xml?amount_min={value}&page={page_number}\n\nReturns a collection of recurring payments that fits to a given criteria.\n\nThese criteria are currently available:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Criterion\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"show\",\n    \"1-0\": \"type\",\n    \"2-0\": \"amount_min\",\n    \"3-0\": \"amount_max\",\n    \"4-0\": \"start_min\",\n    \"5-0\": \"start_max\",\n    \"6-0\": \"next_min\",\n    \"7-0\": \"next_max\",\n    \"8-0\": \"interval\",\n    \"9-0\": \"fb_project_id\",\n    \"10-0\": \"fb_type_id\",\n    \"11-0\": \"fb_source_id\",\n    \"12-0\": \"fb_payment_form_configuration_id\",\n    \"13-0\": \"fb_person_id\",\n    \"14-0\": \"ids (separated by comma)\",\n    \"15-0\": \"search_id\",\n    \"15-2\": \"integer\",\n    \"14-2\": \"string\",\n    \"13-2\": \"integer\",\n    \"12-2\": \"integer\",\n    \"11-2\": \"integer\",\n    \"10-2\": \"integer\",\n    \"9-2\": \"integer\",\n    \"4-2\": \"date\",\n    \"5-2\": \"date\",\n    \"6-2\": \"date\",\n    \"7-2\": \"date\",\n    \"2-2\": \"float\",\n    \"3-2\": \"float\",\n    \"15-1\": \"The ID of a smart search\",\n    \"14-1\": \"A comma separated list of IDs\",\n    \"13-1\": \"The ID of a person\",\n    \"12-1\": \"The ID of a payment form\",\n    \"11-1\": \"The ID of a source\",\n    \"10-1\": \"The ID of a payment type\",\n    \"9-1\": \"The ID of a project\",\n    \"8-1\": \"The interval of the recurring\",\n    \"7-1\": \"Maximum next date\",\n    \"6-1\": \"Minimum next date\",\n    \"4-1\": \"Minumum start date\",\n    \"5-1\": \"Maximum start date\",\n    \"2-1\": \"Minimum amount\",\n    \"3-1\": \"Maximum amount\",\n    \"0-2\": \"\\\"active\\\"\",\n    \"0-1\": \"Only show active recurrings when show=active\",\n    \"1-2\": \"Enum (\\\"recurring_membership\\\", \\\"recurring_sponsorship\\\", \\\"recurring_donation\\\", \\\"recurring_fine\\\")\",\n    \"1-1\": \"Type of the recurring payment\",\n    \"8-2\": \"Enum (1, 3, 6, 12)\\n(1 = monthly, 3 = quartely, 6 = half yearly, 12 = yearly)\",\n    \"16-0\": \"is_test\",\n    \"16-1\": \"Filter test donations\",\n    \"16-2\": \"Enum (\\\"yes\\\", \\\"no\\\", \\\"all\\\") - default is \\\"all\\\"\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no recurring payments with these criteria exist, an empty recurring payment container will be returned.\"\n}\n[/block]","updates":[],"order":61,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbef82d779c1a00c885bc0e","project":"571f5e8cd8667f0e00a3c498","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON-REST-API (API-Package)","slug":"rest-api-json","order":9,"from_sync":false,"reference":false,"_id":"5cbeda4b862d090013abd413","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2019-04-23T09:26:35.210Z","__v":1},"user":"5720ba18c669e80e00c35051","createdAt":"2019-04-23T11:34:05.932Z","__v":7,"parentDoc":null}