{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/mandates.json","auth":"required","examples":{"codes":[]},"method":"get","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":""}]},"settings":"","params":[{"name":"page","type":"int","default":"1","desc":"page number","required":false,"in":"query","ref":"","_id":"5cbeffa4f5427400244a8d09"},{"name":"perPage","type":"int","default":"100","desc":"number of objects per page","required":false,"in":"query","ref":"","_id":"5cd4381e3823bd036a5fe48e"}]},"next":{"description":"","pages":[]},"title":"/mandates.json","type":"endpoint","slug":"mandates-list","excerpt":"Returns a collection of sepa mandates","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: /mandates.xml?page={page_number})\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Filter by criteria\"\n}\n[/block]\nGET /mandates.json?received_min={value}&page={page_number}\n\nReturns a collection of SEPA mandates that fits to the 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\": \"fb_person_id\",\n    \"0-1\": \"ID of the [person](doc:persons-list) the SEPA mandate belongs to\",\n    \"1-0\": \"transaction_type\",\n    \"1-1\": \"Type of the SEPA mandate\",\n    \"1-2\": \"Enum (\\\"one-off\\\", \\\"recurrent\\\")\",\n    \"0-2\": \"integer\",\n    \"2-0\": \"date_min\",\n    \"3-0\": \"date_max\",\n    \"4-0\": \"last_usage_min\",\n    \"5-0\": \"last_usage_max\",\n    \"2-2\": \"date\",\n    \"3-2\": \"date\",\n    \"4-2\": \"date\",\n    \"5-2\": \"date\",\n    \"6-0\": \"mandate_status\",\n    \"6-2\": \"Enum (\\\"recurrent\\\", \\\"active\\\", \\\"cancelled\\\")\",\n    \"6-1\": \"Status of the SEPA mandate\",\n    \"2-1\": \"Minimum date\",\n    \"3-1\": \"Maximum date\",\n    \"4-1\": \"Minimum date of last usage\",\n    \"5-1\": \"Maximum date of last usage\",\n    \"7-0\": \"origin\",\n    \"8-0\": \"reference\",\n    \"7-1\": \"Origin of the SEPA mandate\",\n    \"8-1\": \"Part of the SEPA mandate reference.\",\n    \"7-2\": \"Enum (\\\"paper\\\", \\\"eze\\\", \\\"other\\\")\",\n    \"8-2\": \"string\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no mandates with these criteria exist, an empty mandates container will be returned.\"\n}\n[/block]","updates":[],"order":9,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbefea0c3b28a0045954500","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-23T12:01:36.192Z","__v":13,"parentDoc":null}

get/mandates.json

Returns a collection of sepa mandates

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer1
page number
perPage:
integer100
number of objects per page

Result Format


Documentation

[block:callout] { "type": "info", "title": "Pagination", "body": "Maximum is 100 entries, use the page parameter to get the next results.\n\n(with pagination: /mandates.xml?page={page_number})" } [/block] [block:api-header] { "title": "Filter by criteria" } [/block] GET /mandates.json?received_min={value}&page={page_number} Returns a collection of SEPA mandates that fits to the given criteria. These criteria are currently available: [block:parameters] { "data": { "h-0": "Criterion", "h-1": "Description", "h-2": "Type", "0-0": "fb_person_id", "0-1": "ID of the [person](doc:persons-list) the SEPA mandate belongs to", "1-0": "transaction_type", "1-1": "Type of the SEPA mandate", "1-2": "Enum (\"one-off\", \"recurrent\")", "0-2": "integer", "2-0": "date_min", "3-0": "date_max", "4-0": "last_usage_min", "5-0": "last_usage_max", "2-2": "date", "3-2": "date", "4-2": "date", "5-2": "date", "6-0": "mandate_status", "6-2": "Enum (\"recurrent\", \"active\", \"cancelled\")", "6-1": "Status of the SEPA mandate", "2-1": "Minimum date", "3-1": "Maximum date", "4-1": "Minimum date of last usage", "5-1": "Maximum date of last usage", "7-0": "origin", "8-0": "reference", "7-1": "Origin of the SEPA mandate", "8-1": "Part of the SEPA mandate reference.", "7-2": "Enum (\"paper\", \"eze\", \"other\")", "8-2": "string" }, "cols": 3, "rows": 9 } [/block] [block:callout] { "type": "info", "body": "If no mandates with these criteria exist, an empty mandates container will be returned." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}