{"docs":{"name":"Suran API","info":"\n\u003cp\u003eAPI v2 used with products from Suran Systems.\u003c/p\u003e\n","copyright":"\u0026copy; 2026 Suran Systems","doc_url":"/apipie/v2","api_url":"/api/v2","resources":{"authenticated_test":{"doc_url":"/apipie/v2/authenticated_test","id":"authenticated_test","api_url":"/api/v2","name":"Authenticated test","short_description":"Test routes for System and Session authentication","full_description":"\n\u003cp\u003eAuthentication test routes allow 3rd party integrations against Suran-API to validate access to other resource routes will not throw an error due to authentication.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/authenticated_test/authenticated_test_system","name":"authenticated_test_system","apis":[{"api_url":"/api/v2/authenticated_test_system","http_method":"GET","short_description":"Test system authentication","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":200,"description":"Authenticated for system request","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eInformation about system request authentication\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"message","full_name":"data[message]","description":"\n\u003cp\u003eMessage to state request was successful\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"data[provision]","description":"\n\u003cp\u003eProvision header from request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":["GET /api/v2/authenticated_test_system\n200\n{\n \"data\": {\n \"message\": \"System request authenticated\",\n \"provision\": \"3fd36f9a-a02e-11e5-a8b2-8cfcc2b18ac3\"\n }\n}"],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":true},{"doc_url":"/apipie/v2/authenticated_test/authenticated_test_session","name":"authenticated_test_session","apis":[{"api_url":"/api/v2/authenticated_test_session","http_method":"GET","short_description":"Test session authentication","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Authenticated for session request","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eInformation about system request authentication\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"message","full_name":"data[message]","description":"\n\u003cp\u003eMessage to state request was successful\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"data[provision]","description":"\n\u003cp\u003eProvision header from request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":["GET /api/v2/authenticated_test_session\n200\n{\n \"data\": {\n \"message\": \"Session request authenticated\",\n \"provision\": \"3fd36f9a-a02e-11e5-a8b2-8cfcc2b18ac3\"\n }\n}"],"metadata":{},"see":[{"link":"/apipie/v2/login/login","description":"login endpoint for starting authenticated session"},{"link":"/apipie/v2/sessions/destroy","description":"logout endpoint for ending authenticated session"}],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"candid_tracker":{"doc_url":"/apipie/v2/candid_tracker","id":"candid_tracker","api_url":"/api/v2","name":"Candid tracker","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/candid_tracker/save_candid_request","name":"save_candid_request","apis":[{"api_url":"/api/v2/save_candid_request","http_method":"POST","short_description":"Save record to regional.tax_exemtion_tracker","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"request_church","full_name":"request_church","description":"\n\u003cp\u003eHash of information required for candid request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"church_finder":{"doc_url":"/apipie/v2/church_finder","id":"church_finder","api_url":"/api/v2","name":"Church finder","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/church_finder/index","name":"index","apis":[{"api_url":"/api/v2/church-finder","http_method":"GET","short_description":"find churches in proximity to given location","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"distance_from_longitude","full_name":"distance_from_longitude","description":"\n\u003cp\u003eLongitude of the location to calculate distance from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"distance_from_latitude","full_name":"distance_from_latitude","description":"\n\u003cp\u003eLatitude of the location to calculate distance from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"longitude","full_name":"longitude","description":"\n\u003cp\u003eLongitude of the given location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"latitude","full_name":"latitude","description":"\n\u003cp\u003eLatitude of the given location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"range","full_name":"range","description":"\n\u003cp\u003eRange to search within\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ona_only","full_name":"ona_only","description":"\n\u003cp\u003eOnly return churches that are open and affirming\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"accessible_only","full_name":"accessible_only","description":"\n\u003cp\u003eOnly return churches that are accessible\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"doc":{"doc_url":"/apipie/v2/doc","id":"doc","api_url":"/api/v2","name":"Disciples of Christ","short_description":"Disciples of Christ specific resources","full_description":"\n\u003cp\u003eReturns information specific to Disciples of Christ CDM+ Desktop/Engage/Mobile users\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/doc/get_ministers","name":"get_ministers","apis":[{"api_url":"/api/v2/doc/ministers","http_method":"GET","short_description":"List of DOC ministers that have standing","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"Invalid custom version","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"List of ministers","is_array":true,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eLast name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eFirst name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"middle_name","full_name":"middle_name","description":"\n\u003cp\u003eMiddle name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"title","full_name":"title","description":"\n\u003cp\u003eTitle\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"suffix_name","full_name":"suffix_name","description":"\n\u003cp\u003eSuffix\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"greeting","full_name":"greeting","description":"\n\u003cp\u003eGreeting\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"order_of_ministry_id","full_name":"order_of_ministry_id","description":"\n\u003cp\u003eOrder of Ministry ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"order_of_ministry_desc","full_name":"order_of_ministry_desc","description":"\n\u003cp\u003eOrder of Ministry description\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"professional_code_id","full_name":"professional_code_id","description":"\n\u003cp\u003eProfessional Code ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"professional_code_desc","full_name":"professional_code_desc","description":"\n\u003cp\u003eProfessional Code description\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"region_id","full_name":"region_id","description":"\n\u003cp\u003eRegion ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"region_desc","full_name":"region_desc","description":"\n\u003cp\u003eRegion description\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"address1","full_name":"address1","description":"\n\u003cp\u003eAddress line 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"address2","full_name":"address2","description":"\n\u003cp\u003eAddress line 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"address3","full_name":"address3","description":"\n\u003cp\u003eAddress line 3\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"city","full_name":"city","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"state","full_name":"state","description":"\n\u003cp\u003eState\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"zip","full_name":"zip","description":"\n\u003cp\u003eZIP/Postal Code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"country","full_name":"country","description":"\n\u003cp\u003eCountry Code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"has_standing","full_name":"has_standing","description":"\n\u003cp\u003eMinister has standing\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true},{"name":"phones","full_name":"phones","description":"\n\u003cp\u003eMinister Phone numbers\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"phones","full_name":"phones[phones]","description":"\n\u003cp\u003eList of Phone numbers\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"type","full_name":"phones[phones][type]","description":"\n\u003cp\u003ePhone number type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone","full_name":"phones[phones][phone]","description":"\n\u003cp\u003ePhone number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"emails","full_name":"emails","description":"\n\u003cp\u003eMinister Emails\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"emails","full_name":"emails[emails]","description":"\n\u003cp\u003eList of Email addresses\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"type","full_name":"emails[emails][type]","description":"\n\u003cp\u003eEmail address type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"emails[emails][email]","description":"\n\u003cp\u003eEmail address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"positions","full_name":"positions","description":"\n\u003cp\u003eMinister Positions\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"positions","full_name":"positions[positions]","description":"\n\u003cp\u003eList of Positions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"position","full_name":"positions[positions][position]","description":"\n\u003cp\u003ePosition description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pin","full_name":"positions[positions][pin]","description":"\n\u003cp\u003ePosition PIN\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"historical","full_name":"positions[positions][historical]","description":"\n\u003cp\u003eHistorical Position status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"begin_date","full_name":"positions[positions][begin_date]","description":"\n\u003cp\u003ePosition begin date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"positions[positions][end_date]","description":"\n\u003cp\u003ePosition end date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"ethnic_codes","full_name":"ethnic_codes","description":"\n\u003cp\u003eMinister Ethnic Codes\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"ethnic_codes","full_name":"ethnic_codes[ethnic_codes]","description":"\n\u003cp\u003eList of Ethnic Codes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"ethnic_codes[ethnic_codes][id]","description":"\n\u003cp\u003eEthnic Code ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ethnic_codes[ethnic_codes][description]","description":"\n\u003cp\u003eEthnic Code description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":["GET /api/v2/doc/ministers\n422\n{\n \"errors\": [\n {\n \"error\": \"You do not have permission to perform this action.\",\n \"status\": 422\n }\n ]\n}","GET /api/v2/doc/ministers\n200\n[\n {\n \"id\": \"2826\",\n \"last_name\": \"Styles\",\n \"first_name\": \"Allen\",\n \"middle_name\": \"James\",\n \"title\": \"Champion\",\n \"suffix_name\": \"Jr.\",\n \"greeting\": \"Hello AJ!\",\n \"order_of_ministry_id\": \"361\",\n \"order_of_ministry_desc\": \"Current Status\",\n \"professional_code_id\": \"128\",\n \"professional_code_desc\": \"Prospective\",\n \"region_id\": \"0\",\n \"region_desc\": \"\",\n \"address1\": \"Test\",\n \"address2\": \"Address 2\",\n \"address3\": \"\",\n \"city\": \"Versailles\",\n \"state\": \"KY\",\n \"zip\": \"40383\",\n \"country\": \"US\",\n \"has_standing\": true,\n \"phones\": {\n \"phones\": [\n {\n \"type\": \"Mobile phone\",\n \"phone\": \"0123456789\"\n },\n {\n \"type\": \"Mobile phone\",\n \"phone\": \"9876543210\"\n }\n ]\n },\n \"emails\": {\n \"emails\": [\n {\n \"type\": \"E-mail address\",\n \"email\": \"aj@test.com\"\n },\n {\n \"type\": \"E-mail address\",\n \"email\": \"secondaj@gmail.com\"\n }\n ]\n },\n \"positions\": null,\n \"ethnic_codes\": {\n \"ethnic_codes\": []\n }\n }\n]"],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false},"geo":{"doc_url":"/apipie/v2/geo","id":"geo","api_url":"/api/v2","name":"Geo","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/geo/get_coordinates","name":"get_coordinates","apis":[{"api_url":"/api/v2/geo/get-coordinates","http_method":"GET","short_description":"Return coordinates based on a given address","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"address","full_name":"address","description":"\n\u003cp\u003eAddress of the given location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/geo/get_address","name":"get_address","apis":[{"api_url":"/api/v2/geo/get-address","http_method":"GET","short_description":"Return an address based on given coordinates","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"longitude","full_name":"longitude","description":"\n\u003cp\u003eLongitude of the given location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"latitude","full_name":"latitude","description":"\n\u003cp\u003eLatitude of the given location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"giving_detail":{"doc_url":"/apipie/v2/giving_detail","id":"giving_detail","api_url":"/api/v2","name":"Giving detail","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/giving_detail/search_transactions","name":"search_transactions","apis":[{"api_url":"/api/v2/search_transactions","http_method":"GET","short_description":"Search transactions for database","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStarting Date of Search\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnding Date of Search\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/giving_detail/transaction_detail","name":"transaction_detail","apis":[{"api_url":"/api/v2/transaction_detail/:transaction_guid","http_method":"GET","short_description":"Return details about transaction","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"donor_guid","full_name":"donor_guid","description":"\n\u003cp\u003eDonor GUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transaction_guid","full_name":"transaction_guid","description":"\n\u003cp\u003eTransaction GUID of transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_guid","full_name":"account_guid","description":"\n\u003cp\u003eAccount GUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/giving_detail/refund_transaction","name":"refund_transaction","apis":[{"api_url":"/api/v2/refund/:transaction_guid","http_method":"GET","short_description":"Refund a transaction","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"donor_guid","full_name":"donor_guid","description":"\n\u003cp\u003eDonor GUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transaction_guid","full_name":"transaction_guid","description":"\n\u003cp\u003eTransaction GUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_schedule_guid","full_name":"account_schedule_guid","description":"\n\u003cp\u003eAccount Schedule GUID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/giving_detail/giving_history","name":"giving_history","apis":[{"api_url":"/api/v2/giving_history/:individual_id","http_method":"GET","short_description":"List all Giving History for an individual","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"individual_id","full_name":"individual_id","description":"\n\u003cp\u003eIndividual ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/giving_detail/giving_detail","name":"giving_detail","apis":[{"api_url":"/api/v2/giving_detail/:contreference","http_method":"GET","short_description":"List of all giving records with that contreference","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"contreference","full_name":"contreference","description":"\n\u003cp\u003eContreference for giving\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/giving_detail/deposit_detail_designation_detail_with_contact_info","name":"deposit_detail_designation_detail_with_contact_info","apis":[{"api_url":"/api/v2/deposit_detail_designation_detail_with_contact_info","http_method":"GET","short_description":"Returns details about deposits, their designations, and the contact information for their respective donors","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart Deposit Date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd Deposit Date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_pending","full_name":"include_pending","description":"\n\u003cp\u003eInclude Pending Deposits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"Deposit Detail Designation Detail With Contact Info","is_array":true,"returns_object":[{"name":"response","full_name":"response","description":"\n\u003cp\u003eResponse for deposit detail designation detail with contact info\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"deposit_id","full_name":"response[deposit_id]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transaction_date","full_name":"response[transaction_date]","description":"\n\u003cp\u003eDate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deposit_date","full_name":"response[deposit_date]","description":"\n\u003cp\u003eDate of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transaction_id","full_name":"response[transaction_id]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"allocation_id","full_name":"response[allocation_id]","description":"\n\u003cp\u003eID of the allocation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"donor_id","full_name":"response[donor_id]","description":"\n\u003cp\u003eID of the Donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"donor_first_name","full_name":"response[donor_first_name]","description":"\n\u003cp\u003eDonor’s first name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"donor_last_name","full_name":"response[donor_last_name]","description":"\n\u003cp\u003eDonor’s last name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address1","full_name":"response[address1]","description":"\n\u003cp\u003eAddress line 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address2","full_name":"response[address2]","description":"\n\u003cp\u003eAddress line 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address3","full_name":"response[address3]","description":"\n\u003cp\u003eAddress line 3\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"response[city]","description":"\n\u003cp\u003eAddress city\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state","full_name":"response[state]","description":"\n\u003cp\u003eAddress state\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zip","full_name":"response[zip]","description":"\n\u003cp\u003eAddress zip code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone","full_name":"response[phone]","description":"\n\u003cp\u003ePhone number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email_address","full_name":"response[email_address]","description":"\n\u003cp\u003eEmail Address\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"response[amount]","description":"\n\u003cp\u003eAmount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fee_amount","full_name":"response[fee_amount]","description":"\n\u003cp\u003eAmount of the transaction fee\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"net_amount","full_name":"response[net_amount]","description":"\n\u003cp\u003eAmount of both the transaction and fee\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"response[status]","description":"\n\u003cp\u003eStatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_type","full_name":"response[account_type]","description":"\n\u003cp\u003eType of account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payment_type","full_name":"response[payment_type]","description":"\n\u003cp\u003eType of payment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designation_id","full_name":"response[designation_id]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"designation","full_name":"response[designation]","description":"\n\u003cp\u003eDesignation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designation_memo","full_name":"response[designation_memo]","description":"\n\u003cp\u003eMemo of the Designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"main_memo","full_name":"response[main_memo]","description":"\n\u003cp\u003eMain Memo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":["GET /api/v2/deposit_detail_designation_detail_with_contact_info\n422\n{\n \"errors\": [\n {\n \"error\": \"Start date cannot be greater than the end date.\",\n \"status\": 422\n }\n ]\n}","GET /api/v2/deposit_detail_designation_detail_with_contact_info\n422\n{\n \"errors\": [\n {\n \"error\": \"Invalid parameter(s)\",\n \"status\": 422\n }\n ]\n}","GET /api/v2/deposit_detail_designation_detail_with_contact_info\n200\n{\n \"response\": [\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2014-09-14\",\n \"deposit_date\": \"2021-04-01\",\n \"transaction_id\": \"P114\",\n \"allocation_id\": \"P269\",\n \"donor_id\": 0,\n \"donor_first_name\": \"\",\n \"donor_last_name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\",\n \"email_address\": \"\",\n \"amount\": \"2758.0\",\n \"fee_amount\": \"86.62\",\n \"net_amount\": \"2671.38\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 6,\n \"designation\": \"Memorial\",\n \"designation_memo\": \"\",\n \"main_memo\": \"Test gift\"\n },\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2021-06-11\",\n \"deposit_date\": \"2022-03-24\",\n \"transaction_id\": \"2053\",\n \"allocation_id\": \"2783\",\n \"donor_id\": 1,\n \"donor_first_name\": \"Pablo \u0026 Paula\",\n \"donor_last_name\": \"*Manning\",\n \"address1\": \"305 Crossfield Drive 3\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"Big City\",\n \"state\": \"KY\",\n \"zip\": \"40383\",\n \"phone\": \"\",\n \"email_address\": \"jasen@suran.com\",\n \"amount\": \"442.0\",\n \"fee_amount\": \"14.36\",\n \"net_amount\": \"427.64\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 119,\n \"designation\": \"Overseas Ministries\",\n \"designation_memo\": \"\",\n \"main_memo\": \"\"\n },\n {\n \"deposit_id\": \"1206201\",\n \"transaction_date\": \"2021-07-11\",\n \"deposit_date\": \"2022-03-24\",\n \"transaction_id\": \"P2054\",\n \"allocation_id\": \"P2784\",\n \"donor_id\": 1,\n \"donor_first_name\": \"Pablo \u0026 Paula\",\n \"donor_last_name\": \"*Manning\",\n \"address1\": \"305 Crossfield Drive 3\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"Big City\",\n \"state\": \"KY\",\n \"zip\": \"40383\",\n \"phone\": \"\",\n \"email_address\": \"jasen@suran.com\",\n \"amount\": \"442.0\",\n \"fee_amount\": \"14.36\",\n \"net_amount\": \"427.64\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 119,\n \"designation\": \"Overseas Ministries\",\n \"designation_memo\": \"\",\n \"main_memo\": \"\"\n }\n ]\n}","GET /api/v2/deposit_detail_designation_detail_with_contact_info\n200\n{\n \"response\": [\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2014-09-14\",\n \"deposit_date\": \"2021-04-01\",\n \"transaction_id\": \"P114\",\n \"allocation_id\": \"P269\",\n \"donor_id\": 0,\n \"donor_first_name\": \"\",\n \"donor_last_name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\",\n \"email_address\": \"\",\n \"amount\": \"2758.0\",\n \"fee_amount\": \"86.62\",\n \"net_amount\": \"2671.38\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 6,\n \"designation\": \"Memorial\",\n \"designation_memo\": \"\",\n \"main_memo\": \"Test gift\"\n },\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2021-06-11\",\n \"deposit_date\": \"2022-03-24\",\n \"transaction_id\": \"2053\",\n \"allocation_id\": \"2783\",\n \"donor_id\": 1,\n \"donor_first_name\": \"Pablo \u0026 Paula\",\n \"donor_last_name\": \"*Manning\",\n \"address1\": \"305 Crossfield Drive 3\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"Big City\",\n \"state\": \"KY\",\n \"zip\": \"40383\",\n \"phone\": \"\",\n \"email_address\": \"jasen@suran.com\",\n \"amount\": \"442.0\",\n \"fee_amount\": \"14.36\",\n \"net_amount\": \"427.64\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 119,\n \"designation\": \"Overseas Ministries\",\n \"designation_memo\": \"\",\n \"main_memo\": \"\"\n }\n ]\n}","GET /api/v2/deposit_detail_designation_detail_with_contact_info\n422\n{\n \"errors\": [\n {\n \"error\": \"Start date cannot be greater than the end date.\",\n \"status\": 422\n }\n ]\n}","GET /api/v2/deposit_detail_designation_detail_with_contact_info\n422\n{\n \"errors\": [\n {\n \"error\": \"Invalid parameter(s)\",\n \"status\": 422\n }\n ]\n}","GET /api/v2/deposit_detail_designation_detail_with_contact_info\n200\n{\n \"response\": [\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2014-09-14\",\n \"deposit_date\": \"2021-04-01\",\n \"transaction_id\": \"P114\",\n \"allocation_id\": \"P269\",\n \"donor_id\": 0,\n \"donor_first_name\": \"\",\n \"donor_last_name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\",\n \"email_address\": \"\",\n \"amount\": \"2758.0\",\n \"fee_amount\": \"86.62\",\n \"net_amount\": \"2671.38\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 6,\n \"designation\": \"Memorial\",\n \"designation_memo\": \"\",\n \"main_memo\": \"Test gift\"\n },\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2021-06-11\",\n \"deposit_date\": \"2022-03-24\",\n \"transaction_id\": \"2053\",\n \"allocation_id\": \"2783\",\n \"donor_id\": 1,\n \"donor_first_name\": \"Pablo \u0026 Paula\",\n \"donor_last_name\": \"*Manning\",\n \"address1\": \"305 Crossfield Drive 3\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"Big City\",\n \"state\": \"KY\",\n \"zip\": \"40383\",\n \"phone\": \"\",\n \"email_address\": \"jasen@suran.com\",\n \"amount\": \"442.0\",\n \"fee_amount\": \"14.36\",\n \"net_amount\": \"427.64\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 119,\n \"designation\": \"Overseas Ministries\",\n \"designation_memo\": \"\",\n \"main_memo\": \"\"\n }\n ]\n}","GET /api/v2/deposit_detail_designation_detail_with_contact_info\n200\n{\n \"response\": [\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2014-09-14\",\n \"deposit_date\": \"2021-04-01\",\n \"transaction_id\": \"P114\",\n \"allocation_id\": \"P269\",\n \"donor_id\": 0,\n \"donor_first_name\": \"\",\n \"donor_last_name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\",\n \"email_address\": \"\",\n \"amount\": \"2758.0\",\n \"fee_amount\": \"86.62\",\n \"net_amount\": \"2671.38\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 6,\n \"designation\": \"Memorial\",\n \"designation_memo\": \"\",\n \"main_memo\": \"Test gift\"\n },\n {\n \"deposit_id\": \"1206200\",\n \"transaction_date\": \"2021-06-11\",\n \"deposit_date\": \"2022-03-24\",\n \"transaction_id\": \"2053\",\n \"allocation_id\": \"2783\",\n \"donor_id\": 1,\n \"donor_first_name\": \"Pablo \u0026 Paula\",\n \"donor_last_name\": \"*Manning\",\n \"address1\": \"305 Crossfield Drive 3\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"Big City\",\n \"state\": \"KY\",\n \"zip\": \"40383\",\n \"phone\": \"\",\n \"email_address\": \"jasen@suran.com\",\n \"amount\": \"442.0\",\n \"fee_amount\": \"14.36\",\n \"net_amount\": \"427.64\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 119,\n \"designation\": \"Overseas Ministries\",\n \"designation_memo\": \"\",\n \"main_memo\": \"\"\n },\n {\n \"deposit_id\": \"1206201\",\n \"transaction_date\": \"2021-07-11\",\n \"deposit_date\": \"2022-03-24\",\n \"transaction_id\": \"P2054\",\n \"allocation_id\": \"P2784\",\n \"donor_id\": 1,\n \"donor_first_name\": \"Pablo \u0026 Paula\",\n \"donor_last_name\": \"*Manning\",\n \"address1\": \"305 Crossfield Drive 3\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"Big City\",\n \"state\": \"KY\",\n \"zip\": \"40383\",\n \"phone\": \"\",\n \"email_address\": \"jasen@suran.com\",\n \"amount\": \"442.0\",\n \"fee_amount\": \"14.36\",\n \"net_amount\": \"427.64\",\n \"status\": \"\",\n \"account_type\": \"\",\n \"designation_id\": 119,\n \"designation\": \"Overseas Ministries\",\n \"designation_memo\": \"\",\n \"main_memo\": \"\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"login":{"doc_url":"/apipie/v2/login","id":"login","api_url":"/api/v2","name":"Login","short_description":"Endpoints for authentication, beginning a Session","full_description":"\n\u003cp\u003eAfter a successful login, provide the session cookie in headers to request Session resources.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/login/login","name":"login","apis":[{"api_url":"/api/v2/login","http_method":"POST","short_description":"Login, beginning a Session","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Provision/PIN missing","metadata":null},{"code":422,"description":"Provision/PIN incorrect","metadata":null},{"code":422,"description":"Provision does not exist","metadata":null}],"params":[{"name":"username","full_name":"username","description":"\n\u003cp\u003eUsername for individual you want to log in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":false,"validations":[]},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword for individual you want to log in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":false,"validations":[]},{"name":"provision","full_name":"provision","description":"\n\u003cp\u003eMobile provision\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pin","full_name":"pin","description":"\n\u003cp\u003ePin for mobile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Successful login","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eMessage returned for successful login\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/v2/login\n{\n \"pin\": \"4321\",\n \"provision\": \"11112222-3333-4444-5555-666677778888\"\n}\n422\n{\n \"errors\": [\n {\n \"error\": \"Provision or pin was incorrect.\",\n \"status\": 422\n }\n ]\n}","POST /api/v2/login\n{\n \"pin\": \"1234\",\n \"provision\": \"12345678-1111-2222-3333-123412341234\"\n}\n200\n{\n \"data\": \"Login successful\"\n}","POST /api/v2/login\n{\n \"pin\": \"1234\",\n \"username\": \"Bob\"\n}\n422\n{\n \"errors\": [\n {\n \"error\": \"Provision/PIN is required for login\",\n \"status\": 422\n }\n ]\n}","POST /api/v2/login\n{\n \"pin\": \"4321\",\n \"provision\": \"baaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\"\n}\n422\n{\n \"errors\": [\n {\n \"error\": \"setup failed\",\n \"status\": 422\n }\n ]\n}"],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":true},{"doc_url":"/apipie/v2/login/engage_login","name":"engage_login","apis":[{"api_url":"/api/v2/engage_login","http_method":"POST","short_description":"Login","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Provision/PIN missing","metadata":null},{"code":422,"description":"Provision/PIN incorrect","metadata":null},{"code":422,"description":"Provision does not exist","metadata":null}],"params":[{"name":"username","full_name":"username","description":"\n\u003cp\u003eUsername for individual you want to log in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword for individual you want to log in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone_number","full_name":"phone_number","description":"\n\u003cp\u003ePhone number of user if logging in from sms link\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"web_token","full_name":"web_token","description":"\n\u003cp\u003eWeb token used to authenticate automatically\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"giver_id","full_name":"giver_id","description":"\n\u003cp\u003eID of individual user is administering their giving\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token","full_name":"token","description":"\n\u003cp\u003eHashed login token\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"mock_acps":{"doc_url":"/apipie/v2/mock_acps","id":"mock_acps","api_url":"/api/v2","name":"Mock acps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/mock_acps/index","name":"index","apis":[{"api_url":"/api/v2Mocked return of access control policy","http_method":"/mock_acps","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"roles","full_name":"roles","description":"\n\u003cp\u003eArray of roles to return policies for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/mock_acps/show","name":"show","apis":[{"api_url":"/api/v2Mocked return of a specific resource access control policy","http_method":"/mock_acps/:id","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"roles","full_name":"roles","description":"\n\u003cp\u003eArray of roles to return policies for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSpecific resource of access control policy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"mock_preferences":{"doc_url":"/apipie/v2/mock_preferences","id":"mock_preferences","api_url":"/api/v2","name":"Mock preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/mock_preferences/index","name":"index","apis":[{"api_url":"/api/v2Mocked return of all resources from fieldmanager","http_method":"/mock_preferences","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"roles","full_name":"roles","description":"\n\u003cp\u003eArray of roles\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/mock_preferences/show","name":"show","apis":[{"api_url":"/api/v2Mocked return of a specific resource from fieldmanager","http_method":"/mock_preferences/:id","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eSpecific resource from fieldmanager\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"roles","full_name":"roles","description":"\n\u003cp\u003eArray of roles\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"request_update_suf_data":{"doc_url":"/apipie/v2/request_update_suf_data","id":"request_update_suf_data","api_url":"/api/v2","name":"Request update suf data","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/request_update_suf_data/suf_data","name":"suf_data","apis":[{"api_url":"/api/v2/suf_data","http_method":"GET","short_description":"Get suf data to create a ticket with upon update request from CDM","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"hosting_id","full_name":"hosting_id","description":"\n\u003cp\u003efuuser id to grab data from\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"send_error_report":{"doc_url":"/apipie/v2/send_error_report","id":"send_error_report","api_url":"/api/v2","name":"Send error report","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/send_error_report/create","name":"create","apis":[{"api_url":"/api/v2/send_error_report","http_method":"POST","short_description":"Send error report","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"subject","full_name":"subject","description":"\n\u003cp\u003eSubject for the error report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"\n\u003cp\u003eMessage for the error report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"sessions":{"doc_url":"/apipie/v2/sessions","id":"sessions","api_url":"/api/v2","name":"Sessions","short_description":"Retrieve information on the current Session, or logout","full_description":"\n\u003cp\u003eHolds information about the current Session, and provides the ability to logout.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/sessions/show","name":"show","apis":[{"api_url":"/api/v2/sessions","http_method":"GET","short_description":"Get logged-in individual","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/sessions/refresh","name":"refresh","apis":[{"api_url":"/api/v2/refresh_session","http_method":"GET","short_description":"Refresh expiring session cookies","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":["GET /api/v2/session/refresh\n204\n{}"],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/sessions/session_status","name":"session_status","apis":[{"api_url":"/api/v2/status","http_method":"GET","short_description":"Get expiration status of session cookie","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/sessions/destroy","name":"destroy","apis":[{"api_url":"/api/v2/logout","http_method":"DELETE","short_description":"Logout, ending a Session","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":204,"description":"Successfully logged out","is_array":false,"returns_object":[],"additional_properties":false}],"examples":["DELETE /api/v2/session\n{}\n204\n{}"],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":true},{"doc_url":"/apipie/v2/sessions/description","name":"description","apis":[{"api_url":"/api/v2/description","http_method":"GET","short_description":"Engage Description","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"phone_number","full_name":"phone_number","description":"\n\u003cp\u003ePhone number for individual\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"subscriptions":{"doc_url":"/apipie/v2/subscriptions","id":"subscriptions","api_url":"/api/v2","name":"Subscriptions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/subscriptions/subscription_expiring_soon","name":"subscription_expiring_soon","apis":[{"api_url":"/api/v2/subscription_expiring_soon/:subscription_id","http_method":"GET","short_description":"Send subscription expiring soon email to individual","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/subscriptions/subscription_expired","name":"subscription_expired","apis":[{"api_url":"/api/v2/subscription_expired/:subscription_id","http_method":"GET","short_description":"Send subscription expired email to individual","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"tax_exemption_tracker":{"doc_url":"/apipie/v2/tax_exemption_tracker","id":"tax_exemption_tracker","api_url":"/api/v2","name":"Tax exemption tracker","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/tax_exemption_tracker/save_log","name":"save_log","apis":[{"api_url":"/api/v2/gte_log","http_method":"POST","short_description":"Save record to regional.tax_exemtion_tracker","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"ip_address","full_name":"ip_address","description":"\n\u003cp\u003eIP address of the client saving pdf\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"individual_id","full_name":"individual_id","description":"\n\u003cp\u003eIndividual ID of the client saving pdf\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"church_id","full_name":"church_id","description":"\n\u003cp\u003eChurch ID the pdf is about\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"time_off_payrolls":{"doc_url":"/apipie/v2/time_off_payrolls","id":"time_off_payrolls","api_url":"/api/v2","name":"Time off payrolls","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/time_off_payrolls/index","name":"index","apis":[{"api_url":"/api/v2/time_off_payrolls","http_method":"GET","short_description":"Get time off payrolls for year","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"year","full_name":"year","description":"\n\u003cp\u003eYear of payroll to get time off totals for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Returns time off balance for employee","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eSingle plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of the resources\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes off the time of plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_off_plan_id","full_name":"data[attributes][time_off_plan_id]","description":"\n\u003cp\u003eTime off plan ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"fapayrollmaster_id","full_name":"data[attributes][fapayrollmaster_id]","description":"\n\u003cp\u003ePayroll Master ID of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"total_accrued_hours","full_name":"data[attributes][total_accrued_hours]","description":"\n\u003cp\u003eTotal accrued hours of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"total_used_hours","full_name":"data[attributes][total_used_hours]","description":"\n\u003cp\u003eTotal used hours of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"balance","full_name":"data[attributes][balance]","description":"\n\u003cp\u003eBalance of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"data[attributes][description]","description":"\n\u003cp\u003eDescription of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/time_off_payrolls/show","name":"show","apis":[{"api_url":"/api/v2/time_off_payrolls/:id","http_method":"GET","short_description":"Get current payroll time off balance","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of payroll to get time off balance for\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Returns time off balance for employee","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eSingle plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of the resources\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes off the time of plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_off_plan_id","full_name":"data[attributes][time_off_plan_id]","description":"\n\u003cp\u003eTime off plan ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"fapayrollmaster_id","full_name":"data[attributes][fapayrollmaster_id]","description":"\n\u003cp\u003ePayroll Master ID of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"total_accrued_hours","full_name":"data[attributes][total_accrued_hours]","description":"\n\u003cp\u003eTotal accrued hours of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"total_used_hours","full_name":"data[attributes][total_used_hours]","description":"\n\u003cp\u003eTotal used hours of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"balance","full_name":"data[attributes][balance]","description":"\n\u003cp\u003eBalance of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"data[attributes][description]","description":"\n\u003cp\u003eDescription of time off plan balance\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"time_off_totals":{"doc_url":"/apipie/v2/time_off_totals","id":"time_off_totals","api_url":"/api/v2","name":"Time off totals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/time_off_totals/index","name":"index","apis":[{"api_url":"/api/v2/time_off_totals","http_method":"GET","short_description":"Get current time off totals","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Returns time off totals for employee","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eSingle time off\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the time off\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of the resources\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the time of plan totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_off_plan_id","full_name":"data[attributes][time_off_plan_id]","description":"\n\u003cp\u003eTime off plan ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"faemployee_id","full_name":"data[attributes][faemployee_id]","description":"\n\u003cp\u003eEmployee ID of time off plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"total_accrued_hours","full_name":"data[attributes][total_accrued_hours]","description":"\n\u003cp\u003eTotal accrued hours of time off plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"total_used_hours","full_name":"data[attributes][total_used_hours]","description":"\n\u003cp\u003eTotal used hours of time off plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"balance","full_name":"data[attributes][balance]","description":"\n\u003cp\u003eBalance of time off plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"data[attributes][description]","description":"\n\u003cp\u003eDescription of time off plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":false,"session":true,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"ucc_churches_tax_purpose":{"doc_url":"/apipie/v2/ucc_churches_tax_purpose","id":"ucc_churches_tax_purpose","api_url":"/api/v2","name":"Ucc churches tax purpose","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/ucc_churches_tax_purpose/gte_churches","name":"gte_churches","apis":[{"api_url":"/api/v2/gte_churches","http_method":"GET","short_description":"Get church records for GTE purpose","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"search_word","full_name":"search_word","description":"\n\u003cp\u003eSearch word to filter churches\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":[],"deprecated":false},"log":{"doc_url":"/apipie/v2/log","id":"log","api_url":"/api/v2","name":"Log","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/log/fraudulent_transaction_attempt","name":"fraudulent_transaction_attempt","apis":[{"api_url":"/api/v2/log/fraudulent_transaction_attempt","http_method":"POST","short_description":"Log a fraudulent transaction attempt from Engage","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"entryTime","full_name":"entryTime","description":"\n\u003cp\u003eTime in which the form to make the request was entered\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submitTime","full_name":"submitTime","description":"\n\u003cp\u003eTime in which the transaction request was submitted\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"userAgent","full_name":"userAgent","description":"\n\u003cp\u003eUser agent information\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"language","full_name":"language","description":"\n\u003cp\u003eLanguage setting of the browser\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"country_state_selects":{"doc_url":"/apipie/v2/country_state_selects","id":"country_state_selects","api_url":"/api/v2","name":"Country state selects","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/country_state_selects/index","name":"index","apis":[{"api_url":"/api/v2/general/country_state_selects","http_method":"GET","short_description":"Get all states for country","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"country_state_selects","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003estate select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the state select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the state select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"country","full_name":"data[attributes][country]","description":"\n\u003cp\u003eName of the country\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_code","full_name":"data[attributes][country_code]","description":"\n\u003cp\u003eCode of the country\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"states","full_name":"data[attributes][states]","description":"\n\u003cp\u003eStates for the crountry\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"statename","full_name":"data[attributes][states][statename]","description":"\n\u003cp\u003eName of the state\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"statecode","full_name":"data[attributes][states][statecode]","description":"\n\u003cp\u003eCode of the state\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country_code","full_name":"data[attributes][states][country_code]","description":"\n\u003cp\u003eCode of the country\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"failed_clerk_report_transaction":{"doc_url":"/apipie/v2/failed_clerk_report_transaction","id":"failed_clerk_report_transaction","api_url":"/api/v2","name":"Failed clerk report transaction","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/failed_clerk_report_transaction/index","name":"index","apis":[{"api_url":"/api/v2/notifications/failed_clerk_report_transaction","http_method":"GET","short_description":"Sends failed clerk report transaction notices","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"transaction_id","full_name":"transaction_id","description":"\n\u003cp\u003eTransaction ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"resend_gift_notifications":{"doc_url":"/apipie/v2/resend_gift_notifications","id":"resend_gift_notifications","api_url":"/api/v2","name":"Resend gift notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/resend_gift_notifications/index","name":"index","apis":[{"api_url":"/api/v2/notifications/resend_gift_notifications","http_method":"GET","short_description":"Sends incomplete transaction email","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"transaction_id","full_name":"transaction_id","description":"\n\u003cp\u003eTransaction ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"send_to_donor","full_name":"send_to_donor","description":"\n\u003cp\u003eThis notification will be sent to the donor. Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"send_to_staff","full_name":"send_to_staff","description":"\n\u003cp\u003eThis notification will be sent to the staff. Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"is_guest","full_name":"is_guest","description":"\n\u003cp\u003eThis notification is for a guest gift. Only needed if payload on transaction is incomplete or null, otherwise it will be determined automatically.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"create_links","full_name":"create_links","description":"\n\u003cp\u003ePass in true if you want to create sent notice links\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"account_fraud_check":{"doc_url":"/apipie/v2/account_fraud_check","id":"account_fraud_check","api_url":"/api/v2","name":"Account fraud check","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/account_fraud_check/index","name":"index","apis":[{"api_url":"/api/v2/pay/account_fraud_check","http_method":"GET","short_description":"Check for payment method fraud","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"account_holder_id","full_name":"account_holder_id","description":"\n\u003cp\u003eID of account holder\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operation","full_name":"operation","description":"\n\u003cp\u003eOperation being performed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_id","full_name":"account_id","description":"\n\u003cp\u003eID of account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"account_schedules":{"doc_url":"/apipie/v2/account_schedules","id":"account_schedules","api_url":"/api/v2","name":"Account schedules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/account_schedules/index","name":"index","apis":[{"api_url":"/api/v2/pay/account_schedules","http_method":"GET","short_description":"Get all account schedules within a date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"The start date or end date is invalid","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003elower bound for created date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eupper bound for created date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"account schedule","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eaccount schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"AccountScheduleGUID","full_name":"data[attributes][AccountScheduleGUID]","description":"\n\u003cp\u003eGUID of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eguid of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FirstName","full_name":"data[attributes][FirstName]","description":"\n\u003cp\u003eguid of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"LastName","full_name":"data[attributes][LastName]","description":"\n\u003cp\u003eguid of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountGUID","full_name":"data[attributes][AccountGUID]","description":"\n\u003cp\u003eguid of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RecurringType","full_name":"data[attributes][RecurringType]","description":"\n\u003cp\u003etype of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RecurringName","full_name":"data[attributes][RecurringName]","description":"\n\u003cp\u003etype name of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ScheduledDate","full_name":"data[attributes][ScheduledDate]","description":"\n\u003cp\u003enext recurring date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Quantity","full_name":"data[attributes][Quantity]","description":"\n\u003cp\u003enumber of recurring setups\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TotalAmount","full_name":"data[attributes][TotalAmount]","description":"\n\u003cp\u003etotal giving of recurring setups\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NumberOfDesignations","full_name":"data[attributes][NumberOfDesignations]","description":"\n\u003cp\u003enumber of designation_information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[attributes][Status]","description":"\n\u003cp\u003estatus of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StatusName","full_name":"data[attributes][StatusName]","description":"\n\u003cp\u003estatus of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Memo","full_name":"data[attributes][Memo]","description":"\n\u003cp\u003erecurring setup memo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CreateDateTime","full_name":"data[attributes][CreateDateTime]","description":"\n\u003cp\u003edate entered of recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designation_information","full_name":"data[attributes][designation_information]","description":"\n\u003cp\u003eAttributes of the designation_information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DesignationID","full_name":"data[attributes][designation_information][DesignationID]","description":"\n\u003cp\u003edesignation id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationGUID","full_name":"data[attributes][designation_information][DesignationGUID]","description":"\n\u003cp\u003edesignation guid\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][designation_information][DesignationName]","description":"\n\u003cp\u003edesignation name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAmount","full_name":"data[attributes][designation_information][DesignationAmount]","description":"\n\u003cp\u003edesignation amount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designationmemo","full_name":"data[attributes][designation_information][designationmemo]","description":"\n\u003cp\u003edesignation memo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"bank_holidays":{"doc_url":"/apipie/v2/bank_holidays","id":"bank_holidays","api_url":"/api/v2","name":"Bank holidays","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/bank_holidays/bank_holidays","name":"bank_holidays","apis":[{"api_url":"/api/v2/bank_holidays","http_method":"GET","short_description":"Get Banking Holidays for a given year","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"year","full_name":"year","description":"\n\u003cp\u003eCurrent year or greater\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"calculate_fee":{"doc_url":"/apipie/v2/calculate_fee","id":"calculate_fee","api_url":"/api/v2","name":"Calculate fee","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/calculate_fee/index","name":"index","apis":[{"api_url":"/api/v2/pay/calculate_fee","http_method":"GET","short_description":"Create and link fgstewardshiptechnologiesdonor to account holder","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"account_type","full_name":"account_type","description":"\n\u003cp\u003eType of account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"amount","full_name":"amount","description":"\n\u003cp\u003eTransaction Amount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"round","full_name":"round","description":"\n\u003cp\u003eShould the fee be rounded?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"check_gift_reports":{"doc_url":"/apipie/v2/check_gift_reports","id":"check_gift_reports","api_url":"/api/v2","name":"Check gift reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/check_gift_reports/index","name":"index","apis":[{"api_url":"/api/v2/pay/check_gift_reports","http_method":"GET","short_description":"Report gifts within date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"The start date or end date is invalid","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eLower bound for entry date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eUpper bound for entry date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Gift Reports","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003echeck gift report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the giving detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the check gift report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"CheckNumber","full_name":"data[attributes][CheckNumber]","description":"\n\u003cp\u003egiving detail check number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"GiftDate","full_name":"data[attributes][GiftDate]","description":"\n\u003cp\u003egiving detail gift date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositDate","full_name":"data[attributes][DepositDate]","description":"\n\u003cp\u003edeposit date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationID","full_name":"data[attributes][DesignationID]","description":"\n\u003cp\u003egiving fund id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"Designation","full_name":"data[attributes][Designation]","description":"\n\u003cp\u003egiving fund designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionID","full_name":"data[attributes][TransactionID]","description":"\n\u003cp\u003egiving detail contreference\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"EmailAddress","full_name":"data[attributes][EmailAddress]","description":"\n\u003cp\u003egiving unit email address\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Name","full_name":"data[attributes][Name]","description":"\n\u003cp\u003egiving unit name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[attributes][DonorID]","description":"\n\u003cp\u003egiving unit id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"EntryDate","full_name":"data[attributes][EntryDate]","description":"\n\u003cp\u003egiving detail offering date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003egiving detail fundamount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Memo","full_name":"data[attributes][Memo]","description":"\n\u003cp\u003egiving detail givingnote\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"BatchID","full_name":"data[attributes][BatchID]","description":"\n\u003cp\u003egiving detail depositid\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"GiftType","full_name":"data[attributes][GiftType]","description":"\n\u003cp\u003egift type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PostalCode","full_name":"data[attributes][PostalCode]","description":"\n\u003cp\u003ezip code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"country_selects":{"doc_url":"/apipie/v2/country_selects","id":"country_selects","api_url":"/api/v2","name":"Country selects","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/country_selects/index","name":"index","apis":[{"api_url":"/api/v2/pay/country_selects","http_method":"GET","short_description":"Get all countries","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Countries","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003ecountry select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the country select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the country select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"CountryCode","full_name":"data[attributes][CountryCode]","description":"\n\u003cp\u003eCode of the country\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CountryName","full_name":"data[attributes][CountryName]","description":"\n\u003cp\u003eName of the country\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"deposit_designation_detail_by_deposit_dates":{"doc_url":"/apipie/v2/deposit_designation_detail_by_deposit_dates","id":"deposit_designation_detail_by_deposit_dates","api_url":"/api/v2","name":"Deposit designation detail by deposit dates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/deposit_designation_detail_by_deposit_dates/index","name":"index","apis":[{"api_url":"/api/v2/pay/deposit_designation_detail_by_deposit_date","http_method":"GET","short_description":"Get all deposit designation details","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"A date parameter was invalid or the start_date parameter was greater than the end_date parameter","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eLower bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eUpper bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Deposit Designation Details","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edeposit designation detail by deposit date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of the charge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"data[attributes][id]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DepositID","full_name":"data[attributes][DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositDate","full_name":"data[attributes][DepositDate]","description":"\n\u003cp\u003eDate of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"SettlementDate","full_name":"data[attributes][SettlementDate]","description":"\n\u003cp\u003eDate of the settlement\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionID","full_name":"data[attributes][TransactionID]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"TransactionGUID","full_name":"data[attributes][TransactionGUID]","description":"\n\u003cp\u003eGUID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[attributes][DonorID]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eGUID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Donor","full_name":"data[attributes][Donor]","description":"\n\u003cp\u003eThe transaction donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003eAmount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FeeAmount","full_name":"data[attributes][FeeAmount]","description":"\n\u003cp\u003eFee amount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NetAmount","full_name":"data[attributes][NetAmount]","description":"\n\u003cp\u003eNet amount of the transaction.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[attributes][Status]","description":"\n\u003cp\u003eStatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationID","full_name":"data[attributes][DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationGUID","full_name":"data[attributes][DesignationGUID]","description":"\n\u003cp\u003eGUID of the designation. (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][DesignationName]","description":"\n\u003cp\u003eName of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationMemo","full_name":"data[attributes][DesignationMemo]","description":"\n\u003cp\u003eMemo of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAnonymous","full_name":"data[attributes][DesignationAnonymous]","description":"\n\u003cp\u003eIs the deposit designation detail anonymous? (We do not currently support anonymous transactions. This will always be false.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"MainMemo","full_name":"data[attributes][MainMemo]","description":"\n\u003cp\u003eMain memo of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Memo","full_name":"data[attributes][Memo]","description":"\n\u003cp\u003eMemo of the deposit designation detail. (This has been depreciated, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"IsAnonymous","full_name":"data[attributes][IsAnonymous]","description":"\n\u003cp\u003eIs the deposit designation detail anonymous? (We do not currently support anonymous transactions. This will always be false.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"deposit_designation_details":{"doc_url":"/apipie/v2/deposit_designation_details","id":"deposit_designation_details","api_url":"/api/v2","name":"Deposit designation details","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/deposit_designation_details/index","name":"index","apis":[{"api_url":"/api/v2/pay/deposit_designation_details","http_method":"GET","short_description":"Get all deposit designation details within date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eLower bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eUpper bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Deposit Designation Details","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edeposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of the charge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"data[attributes][id]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DepositID","full_name":"data[attributes][DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositDate","full_name":"data[attributes][DepositDate]","description":"\n\u003cp\u003eDate of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionID","full_name":"data[attributes][TransactionID]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"TransactionGUID","full_name":"data[attributes][TransactionGUID]","description":"\n\u003cp\u003eGUID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[attributes][DonorID]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eGUID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Donor","full_name":"data[attributes][Donor]","description":"\n\u003cp\u003eThe transaction donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003eAmount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FeeAmount","full_name":"data[attributes][FeeAmount]","description":"\n\u003cp\u003eFee amount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NetAmount","full_name":"data[attributes][NetAmount]","description":"\n\u003cp\u003eNet amount of the transaction.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[attributes][Status]","description":"\n\u003cp\u003eStatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationID","full_name":"data[attributes][DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationGUID","full_name":"data[attributes][DesignationGUID]","description":"\n\u003cp\u003eGUID of the designation. (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][DesignationName]","description":"\n\u003cp\u003eName of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationMemo","full_name":"data[attributes][DesignationMemo]","description":"\n\u003cp\u003eMemo of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"MainMemo","full_name":"data[attributes][MainMemo]","description":"\n\u003cp\u003eMain memo of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Memo","full_name":"data[attributes][Memo]","description":"\n\u003cp\u003eMemo of the deposit designation detail. (This has been depreciated, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"IsAnonymous","full_name":"data[attributes][IsAnonymous]","description":"\n\u003cp\u003eIs the deposit designation detail anonymous? (We do not currently support anonymous transactions. This will always be false.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"deposit_summaries":{"doc_url":"/apipie/v2/deposit_summaries","id":"deposit_summaries","api_url":"/api/v2","name":"Deposit summaries","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/deposit_summaries/index","name":"index","apis":[{"api_url":"/api/v2/pay/deposit_summaries","http_method":"GET","short_description":"Get summaries for deposits within a date range.","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"The start date or end date is invalid","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003elower bound for deposit date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eupper bound for deposit date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"All deposit summaries","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edeposit summary\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of the charge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the deposit summary\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"data[attributes][id]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DepositID","full_name":"data[attributes][DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CreditID","full_name":"data[attributes][CreditID]","description":"\n\u003cp\u003eID of the credit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DepositDate","full_name":"data[attributes][DepositDate]","description":"\n\u003cp\u003edate of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"From","full_name":"data[attributes][From]","description":"\n\u003cp\u003eempty string\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Description","full_name":"data[attributes][Description]","description":"\n\u003cp\u003edescription of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"GrossAmount","full_name":"data[attributes][GrossAmount]","description":"\n\u003cp\u003eamount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NetAmount","full_name":"data[attributes][NetAmount]","description":"\n\u003cp\u003enet amount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"designation_detail_with_contact_info":{"doc_url":"/apipie/v2/designation_detail_with_contact_info","id":"designation_detail_with_contact_info","api_url":"/api/v2","name":"Designation detail with contact info","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/designation_detail_with_contact_info/index","name":"index","apis":[{"api_url":"/api/v2/pay/designation_detail_with_contact_info","http_method":"GET","short_description":"Get all designation details with contact info within a date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null},{"code":422,"description":"invalid date parameter or start_date \u003e end_date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eLower bound for TransactionDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eUpper bound for TransactionDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_pending","full_name":"include_pending","description":"\n\u003cp\u003etrue / false to include pending guest transactions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"designation details with conact info","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edesignation detail with contact info\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"TransactionDate","full_name":"data[TransactionDate]","description":"\n\u003cp\u003eDate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositID","full_name":"data[DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositDate","full_name":"data[DepositDate]","description":"\n\u003cp\u003eDate of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionID","full_name":"data[TransactionID]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[DonorID]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorFName","full_name":"data[DonorFName]","description":"\n\u003cp\u003eThe transaction donor first name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorLName","full_name":"data[DonorLName]","description":"\n\u003cp\u003eThe transaction donor last name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address1","full_name":"data[Address1]","description":"\n\u003cp\u003eAddress line 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address2","full_name":"data[Address2]","description":"\n\u003cp\u003eAddress line 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"City","full_name":"data[City]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"State","full_name":"data[State]","description":"\n\u003cp\u003eState\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Zip","full_name":"data[Zip]","description":"\n\u003cp\u003eZip code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[Amount]","description":"\n\u003cp\u003eAmount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FeeAmount","full_name":"data[FeeAmount]","description":"\n\u003cp\u003eFee amount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NetAmount","full_name":"data[NetAmount]","description":"\n\u003cp\u003eNet amount of the transaction.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[Status]","description":"\n\u003cp\u003eStatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountType","full_name":"data[AccountType]","description":"\n\u003cp\u003eType of account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationID","full_name":"data[DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"Designation","full_name":"data[Designation]","description":"\n\u003cp\u003eDesignation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"MainMemo","full_name":"data[MainMemo]","description":"\n\u003cp\u003eMain memo of the designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PaymentType","full_name":"data[PaymentType]","description":"\n\u003cp\u003ePayment Type of the designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Response","full_name":"data[Response]","description":"\n\u003cp\u003eResponse of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ytdcontributions","full_name":"data[ytdcontributions]","description":"\n\u003cp\u003eYTD for current year of giving unit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"designations_select":{"doc_url":"/apipie/v2/designations_select","id":"designations_select","api_url":"/api/v2","name":"Designations select","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/designations_select/index","name":"index","apis":[{"api_url":"/api/v2/pay/designations_select","http_method":"GET","short_description":"Get all designations","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"designations","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edesignations select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DesignationGUID","full_name":"data[attributes][DesignationGUID]","description":"\n\u003cp\u003eGUID of the designation. (This is not tracked, expect null)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][DesignationName]","description":"\n\u003cp\u003eName of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationSummary","full_name":"data[attributes][DesignationSummary]","description":"\n\u003cp\u003eSummary of the designation. (This is not tracked, expect null)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationDescription","full_name":"data[attributes][DesignationDescription]","description":"\n\u003cp\u003eDescription of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"IsTaxDeductible","full_name":"data[attributes][IsTaxDeductible]","description":"\n\u003cp\u003eIs this tax deductible?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"IsACH","full_name":"data[attributes][IsACH]","description":"\n\u003cp\u003eWas the payment type ACH?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"IsVisa","full_name":"data[attributes][IsVisa]","description":"\n\u003cp\u003eWas the payment type Visa?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"IsMC","full_name":"data[attributes][IsMC]","description":"\n\u003cp\u003eWas the payment type Mastercard?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"IsAmex","full_name":"data[attributes][IsAmex]","description":"\n\u003cp\u003eWas the payment type Ameican Express?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"IsDis","full_name":"data[attributes][IsDis]","description":"\n\u003cp\u003eWas the payment type Discover?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"SuggestedAmt","full_name":"data[attributes][SuggestedAmt]","description":"\n\u003cp\u003eSuggested designation amount. (This is not tracked, expect null)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ExpirationDate","full_name":"data[attributes][ExpirationDate]","description":"\n\u003cp\u003eDate of expiration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FundsMaxLimit","full_name":"data[attributes][FundsMaxLimit]","description":"\n\u003cp\u003eMaximum limit of funds. (This is not tracked, expect null)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"IsCatalog","full_name":"data[attributes][IsCatalog]","description":"\n\u003cp\u003e(This is not tracked, expect null)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationID","full_name":"data[attributes][DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FolderID","full_name":"data[attributes][FolderID]","description":"\n\u003cp\u003e(This is not tracked, expect null)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"donor_information_one":{"doc_url":"/apipie/v2/donor_information_one","id":"donor_information_one","api_url":"/api/v2","name":"Donor information one","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/donor_information_one/index","name":"index","apis":[{"api_url":"/api/v2/pay/donor_information_one","http_method":"GET","short_description":"Get information for one donor","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"donor_guid","full_name":"donor_guid","description":"\n\u003cp\u003eguid of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"check gift reports with matching donorguid","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edonor information one\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the donor information one\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the donor information one\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[attributes][DonorID]","description":"\n\u003cp\u003eaccount holder id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorCode","full_name":"data[attributes][DonorCode]","description":"\n\u003cp\u003eDonor Code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Prefix","full_name":"data[attributes][Prefix]","description":"\n\u003cp\u003etitle of individual\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FirstName","full_name":"data[attributes][FirstName]","description":"\n\u003cp\u003eindividual first name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Middlename","full_name":"data[attributes][Middlename]","description":"\n\u003cp\u003eindividual middle name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"LastName","full_name":"data[attributes][LastName]","description":"\n\u003cp\u003eindividual last name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Suffix","full_name":"data[attributes][Suffix]","description":"\n\u003cp\u003eaddress suffix\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address1","full_name":"data[attributes][Address1]","description":"\n\u003cp\u003eaddress 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address2","full_name":"data[attributes][Address2]","description":"\n\u003cp\u003eaddress 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address1","full_name":"data[attributes][Address1]","description":"\n\u003cp\u003eaddress 3\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"City","full_name":"data[attributes][City]","description":"\n\u003cp\u003eaddress city\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StateCode","full_name":"data[attributes][StateCode]","description":"\n\u003cp\u003eaddress state code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StateProvince","full_name":"data[attributes][StateProvince]","description":"\n\u003cp\u003estate code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PostalCode","full_name":"data[attributes][PostalCode]","description":"\n\u003cp\u003epostal code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CountryCode","full_name":"data[attributes][CountryCode]","description":"\n\u003cp\u003ecountry code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CountryName","full_name":"data[attributes][CountryName]","description":"\n\u003cp\u003ecountry code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_information","full_name":"data[attributes][contact_information]","description":"\n\u003cp\u003eAttributes of the donor information one\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"contactnum","full_name":"data[attributes][contact_information][contactnum]","description":"\n\u003cp\u003econtact number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"extension","full_name":"data[attributes][contact_information][extension]","description":"\n\u003cp\u003econtact number extension\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"typecode_desc","full_name":"data[attributes][contact_information][typecode_desc]","description":"\n\u003cp\u003econtact type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"donor_information_report":{"doc_url":"/apipie/v2/donor_information_report","id":"donor_information_report","api_url":"/api/v2","name":"Donor information report","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/donor_information_report/index","name":"index","apis":[{"api_url":"/api/v2/pay/donor_information_report","http_method":"GET","short_description":"Get information for all pay donors","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Donor Information Report","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edonor information report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the donor information report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the donor information report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eGUID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[attributes][DonorID]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorCode","full_name":"data[attributes][DonorCode]","description":"\n\u003cp\u003eDonor Code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Prefix","full_name":"data[attributes][Prefix]","description":"\n\u003cp\u003etitle of individual\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FirstName","full_name":"data[attributes][FirstName]","description":"\n\u003cp\u003edonor first name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Middlename","full_name":"data[attributes][Middlename]","description":"\n\u003cp\u003edonor middle name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"LastName","full_name":"data[attributes][LastName]","description":"\n\u003cp\u003edonor last name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Suffix","full_name":"data[attributes][Suffix]","description":"\n\u003cp\u003esuffix\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address1","full_name":"data[attributes][Address1]","description":"\n\u003cp\u003eaddress 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address2","full_name":"data[attributes][Address2]","description":"\n\u003cp\u003eaddress 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address1","full_name":"data[attributes][Address1]","description":"\n\u003cp\u003eaddress 3\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"City","full_name":"data[attributes][City]","description":"\n\u003cp\u003ecity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StateCode","full_name":"data[attributes][StateCode]","description":"\n\u003cp\u003estate code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StateProvince","full_name":"data[attributes][StateProvince]","description":"\n\u003cp\u003estate province\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PostalCode","full_name":"data[attributes][PostalCode]","description":"\n\u003cp\u003epostal code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CountryCode","full_name":"data[attributes][CountryCode]","description":"\n\u003cp\u003ecountry code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CountryName","full_name":"data[attributes][CountryName]","description":"\n\u003cp\u003ecountry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_information","full_name":"data[attributes][contact_information]","description":"\n\u003cp\u003econtact information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"contactnum","full_name":"data[attributes][contact_information][contactnum]","description":"\n\u003cp\u003econtact number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"extension","full_name":"data[attributes][contact_information][extension]","description":"\n\u003cp\u003econtact extension\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"typecode_desc","full_name":"data[attributes][contact_information][typecode_desc]","description":"\n\u003cp\u003econtact type code description\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"donor_transaction_information":{"doc_url":"/apipie/v2/donor_transaction_information","id":"donor_transaction_information","api_url":"/api/v2","name":"Donor transaction information","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/donor_transaction_information/index","name":"index","apis":[{"api_url":"/api/v2/pay/donor_transaction_information","http_method":"GET","short_description":"Get online donor transaction information for a single donor within a date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"The start date or end date is invalid","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null}],"params":[{"name":"donor_guid","full_name":"donor_guid","description":"\n\u003cp\u003eguid of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003elower bound for transaction date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eupper bound for transaction date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"check gift reports with matching donorguid","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edonor transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the donor transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the donor transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eguid of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionGUID","full_name":"data[attributes][TransactionGUID]","description":"\n\u003cp\u003eguid of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionID","full_name":"data[attributes][TransactionID]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountScheduleGUID","full_name":"data[attributes][AccountScheduleGUID]","description":"\n\u003cp\u003eGUID of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountScheduleID","full_name":"data[attributes][AccountScheduleID]","description":"\n\u003cp\u003eID of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountScheduleStatus","full_name":"data[attributes][AccountScheduleStatus]","description":"\n\u003cp\u003estatus of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountScheduleStatusName","full_name":"data[attributes][AccountScheduleStatusName]","description":"\n\u003cp\u003estatus name of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RecurringType","full_name":"data[attributes][RecurringType]","description":"\n\u003cp\u003etype of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RecurringName","full_name":"data[attributes][RecurringName]","description":"\n\u003cp\u003etype name of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NextRecurringDT","full_name":"data[attributes][NextRecurringDT]","description":"\n\u003cp\u003enext recurring date time\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountGUID","full_name":"data[attributes][AccountGUID]","description":"\n\u003cp\u003eguid of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003etransaction income amount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionDate","full_name":"data[attributes][TransactionDate]","description":"\n\u003cp\u003edate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"SettlementDate","full_name":"data[attributes][SettlementDate]","description":"\n\u003cp\u003edate of the settlement\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[attributes][Status]","description":"\n\u003cp\u003estatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"IsRefundable","full_name":"data[attributes][IsRefundable]","description":"\n\u003cp\u003eif the transaction is refundable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RefundTransactionGUID","full_name":"data[attributes][RefundTransactionGUID]","description":"\n\u003cp\u003etransaction GUID of the refund\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCode","full_name":"data[attributes][ResponseCode]","description":"\n\u003cp\u003eresponse code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCodeAVS","full_name":"data[attributes][ResponseCodeAVS]","description":"\n\u003cp\u003eresponse code AVS\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"InvoiceNumber","full_name":"data[attributes][InvoiceNumber]","description":"\n\u003cp\u003einvoice number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CustomerTransactionID","full_name":"data[attributes][CustomerTransactionID]","description":"\n\u003cp\u003etransaction id of the customer\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData1","full_name":"data[attributes][UserDefinedData1]","description":"\n\u003cp\u003euser defined data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData2","full_name":"data[attributes][UserDefinedData2]","description":"\n\u003cp\u003euser defined data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData3","full_name":"data[attributes][UserDefinedData3]","description":"\n\u003cp\u003euser defined data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountNickName","full_name":"data[attributes][AccountNickName]","description":"\n\u003cp\u003enick name of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountType","full_name":"data[attributes][AccountType]","description":"\n\u003cp\u003etype of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"MaskedACHNum","full_name":"data[attributes][MaskedACHNum]","description":"\n\u003cp\u003emasked account number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"BankName","full_name":"data[attributes][BankName]","description":"\n\u003cp\u003ename of the bank\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CreditCardType","full_name":"data[attributes][CreditCardType]","description":"\n\u003cp\u003etype of the credit card\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"MaskedCCNum","full_name":"data[attributes][MaskedCCNum]","description":"\n\u003cp\u003emasked credit card number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designation_information","full_name":"data[attributes][designation_information]","description":"\n\u003cp\u003eAttributes of the designation_information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DesignationID","full_name":"data[attributes][designation_information][DesignationID]","description":"\n\u003cp\u003edesignation id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationGUID","full_name":"data[attributes][designation_information][DesignationGUID]","description":"\n\u003cp\u003edesignation guid\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][designation_information][DesignationName]","description":"\n\u003cp\u003edesignation name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAmount","full_name":"data[attributes][designation_information][DesignationAmount]","description":"\n\u003cp\u003edesignation amount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAllocationID","full_name":"data[attributes][designation_information][DesignationAllocationID]","description":"\n\u003cp\u003eid of the designation allocation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designationmemo","full_name":"data[attributes][designation_information][designationmemo]","description":"\n\u003cp\u003edesignation memo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"donors_transaction_information":{"doc_url":"/apipie/v2/donors_transaction_information","id":"donors_transaction_information","api_url":"/api/v2","name":"Donors transaction information","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/donors_transaction_information/index","name":"index","apis":[{"api_url":"/api/v2/pay/donors_transaction_information","http_method":"GET","short_description":"Get online transaction information for all donors within a date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"The start date or end date is invalid","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eUpper bound for Settlement Date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eLower bound for Settlement Date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Donors Transaction Information","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edonors transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the donors transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the donors transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"data[attributes][id]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eGUID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionGUID","full_name":"data[attributes][TransactionGUID]","description":"\n\u003cp\u003eGUID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountScheduleGUID","full_name":"data[attributes][AccountScheduleGUID]","description":"\n\u003cp\u003eGUID of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountGUID","full_name":"data[attributes][AccountGUID]","description":"\n\u003cp\u003eGUID of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003eamount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionDate","full_name":"data[attributes][TransactionDate]","description":"\n\u003cp\u003eDate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"SettlementDate","full_name":"data[attributes][SettlementDate]","description":"\n\u003cp\u003eDate of the settlement\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[attributes][Status]","description":"\n\u003cp\u003eStatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositID","full_name":"data[attributes][DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CreditID","full_name":"data[attributes][CreditID]","description":"\n\u003cp\u003eID of the credit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"IsRefundable","full_name":"data[attributes][IsRefundable]","description":"\n\u003cp\u003eIs the transaction refundable?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"RefundTransactionGUID","full_name":"data[attributes][RefundTransactionGUID]","description":"\n\u003cp\u003eGUID of the transaction refund (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCode","full_name":"data[attributes][ResponseCode]","description":"\n\u003cp\u003ecode of the response\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCodeAVS","full_name":"data[attributes][ResponseCodeAVS]","description":"\n\u003cp\u003ecode of the avs response (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"InvoiceNumber","full_name":"data[attributes][InvoiceNumber]","description":"\n\u003cp\u003enumber of the invoice (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CustomerTransactionID","full_name":"data[attributes][CustomerTransactionID]","description":"\n\u003cp\u003eID of the customer transaction (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData1","full_name":"data[attributes][UserDefinedData1]","description":"\n\u003cp\u003euser defined data 1 (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData2","full_name":"data[attributes][UserDefinedData2]","description":"\n\u003cp\u003euser defined data 2 (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData3","full_name":"data[attributes][UserDefinedData3]","description":"\n\u003cp\u003euser defined data 3 (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designation_information","full_name":"data[attributes][designation_information]","description":"\n\u003cp\u003edetails of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DesignationID","full_name":"data[attributes][designation_information][DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationGUID","full_name":"data[attributes][designation_information][DesignationGUID]","description":"\n\u003cp\u003eGUID of the designation. (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][designation_information][DesignationName]","description":"\n\u003cp\u003eName of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAmount","full_name":"data[attributes][designation_information][DesignationAmount]","description":"\n\u003cp\u003eAmount of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationAllocationID","full_name":"data[attributes][designation_information][DesignationAllocationID]","description":"\n\u003cp\u003eID of the designation allocation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationMemo","full_name":"data[attributes][designation_information][DesignationMemo]","description":"\n\u003cp\u003eMemo of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAnonymous","full_name":"data[attributes][designation_information][DesignationAnonymous]","description":"\n\u003cp\u003eIs the deposit designation detail anonymous? (We do not currently support anonymous transactions. This will always be false.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"donors_transaction_information_settlement_date":{"doc_url":"/apipie/v2/donors_transaction_information_settlement_date","id":"donors_transaction_information_settlement_date","api_url":"/api/v2","name":"Donors transaction information settlement date","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/donors_transaction_information_settlement_date/index","name":"index","apis":[{"api_url":"/api/v2/pay/donors_transaction_information_settlement_date","http_method":"GET","short_description":"Get online transaction information for all donors within a date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"The start date or end date is invalid","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eUpper bound for Settlement Date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eLower bound for Settlement Date. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Donors Transaction Information Settlement Date","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003edonors transaction information settlement date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the donors transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the donors transaction information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"data[attributes][id]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"TransactionGUID","full_name":"data[attributes][TransactionGUID]","description":"\n\u003cp\u003eGUID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eGUID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountScheduleGUID","full_name":"data[attributes][AccountScheduleGUID]","description":"\n\u003cp\u003eGUID of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountGUID","full_name":"data[attributes][AccountGUID]","description":"\n\u003cp\u003eGUID of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003eamount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionDate","full_name":"data[attributes][TransactionDate]","description":"\n\u003cp\u003eDate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"SettlementDate","full_name":"data[attributes][SettlementDate]","description":"\n\u003cp\u003eDate of the settlement\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[attributes][Status]","description":"\n\u003cp\u003eStatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositID","full_name":"data[attributes][DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CreditID","full_name":"data[attributes][CreditID]","description":"\n\u003cp\u003eID of the credit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"IsRefundable","full_name":"data[attributes][IsRefundable]","description":"\n\u003cp\u003eIs the transaction refundable?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"RefundTransactionGUID","full_name":"data[attributes][RefundTransactionGUID]","description":"\n\u003cp\u003eGUID of the transaction refund (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCode","full_name":"data[attributes][ResponseCode]","description":"\n\u003cp\u003ecode of the response\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCodeAVS","full_name":"data[attributes][ResponseCodeAVS]","description":"\n\u003cp\u003ecode of the avs response (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"InvoiceNumber","full_name":"data[attributes][InvoiceNumber]","description":"\n\u003cp\u003enumber of the invoice (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CustomerTransactionID","full_name":"data[attributes][CustomerTransactionID]","description":"\n\u003cp\u003eID of the customer transaction (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData1","full_name":"data[attributes][UserDefinedData1]","description":"\n\u003cp\u003euser defined data 1 (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData2","full_name":"data[attributes][UserDefinedData2]","description":"\n\u003cp\u003euser defined data 2 (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData3","full_name":"data[attributes][UserDefinedData3]","description":"\n\u003cp\u003euser defined data 3 (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountType","full_name":"data[attributes][AccountType]","description":"\n\u003cp\u003etype of account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CreditCardType","full_name":"data[attributes][CreditCardType]","description":"\n\u003cp\u003etype of credit card (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designation_information","full_name":"data[attributes][designation_information]","description":"\n\u003cp\u003edetails of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DesignationID","full_name":"data[attributes][designation_information][DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationGUID","full_name":"data[attributes][designation_information][DesignationGUID]","description":"\n\u003cp\u003eGUID of the designation. (This is currently untracked, and is expected to be NULL.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][designation_information][DesignationName]","description":"\n\u003cp\u003eName of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAmount","full_name":"data[attributes][designation_information][DesignationAmount]","description":"\n\u003cp\u003eAmount of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationAllocationID","full_name":"data[attributes][designation_information][DesignationAllocationID]","description":"\n\u003cp\u003eID of the designation allocation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DesignationMemo","full_name":"data[attributes][designation_information][DesignationMemo]","description":"\n\u003cp\u003eMemo of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAnonymous","full_name":"data[attributes][designation_information][DesignationAnonymous]","description":"\n\u003cp\u003eIs the deposit designation detail anonymous? (We do not currently support anonymous transactions. This will always be false.)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003et\u003c/code\u003e, \u003ccode\u003ef\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"pca_deposit_detail_designation_detail_with_contact_info":{"doc_url":"/apipie/v2/pca_deposit_detail_designation_detail_with_contact_info","id":"pca_deposit_detail_designation_detail_with_contact_info","api_url":"/api/v2","name":"Pca deposit detail designation detail with contact info","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/pca_deposit_detail_designation_detail_with_contact_info/index","name":"index","apis":[{"api_url":"/api/v2/pay/pca_deposit_detail_designation_detail_with_contact_info","http_method":"GET","short_description":"Get all pca deposit/designation details with contact info within a date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null},{"code":422,"description":"invalid date parameter or start_date \u003e end_date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eLower bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eUpper bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"pca event deposit and designation details with conact info","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003epca deposit detail designation detail with contact info\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the pca deposit detail designation detail with contact info\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of the charge\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the pca deposit detail designation detail with contact info\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"TransactionDate","full_name":"data[attributes][TransactionDate]","description":"\n\u003cp\u003eDate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositID","full_name":"data[attributes][DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DepositDate","full_name":"data[attributes][DepositDate]","description":"\n\u003cp\u003eDate of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionID","full_name":"data[attributes][TransactionID]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[attributes][DonorID]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DonorFName","full_name":"data[attributes][DonorFName]","description":"\n\u003cp\u003eThe transaction donor first name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorLName","full_name":"data[attributes][DonorLName]","description":"\n\u003cp\u003eThe transaction donor last name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address1","full_name":"data[attributes][Address1]","description":"\n\u003cp\u003eAddress line 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address2","full_name":"data[attributes][Address2]","description":"\n\u003cp\u003eAddress line 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"City","full_name":"data[attributes][City]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"State","full_name":"data[attributes][State]","description":"\n\u003cp\u003eState\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Zip","full_name":"data[attributes][Zip]","description":"\n\u003cp\u003eZip code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003eAmount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FeeAmount","full_name":"data[attributes][FeeAmount]","description":"\n\u003cp\u003eFee amount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NetAmount","full_name":"data[attributes][NetAmount]","description":"\n\u003cp\u003eNet amount of the transaction.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Status","full_name":"data[attributes][Status]","description":"\n\u003cp\u003eStatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountType","full_name":"data[attributes][AccountType]","description":"\n\u003cp\u003eType of account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationID","full_name":"data[attributes][DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"Designation","full_name":"data[attributes][Designation]","description":"\n\u003cp\u003eDesignation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"MainMemo","full_name":"data[attributes][MainMemo]","description":"\n\u003cp\u003eMain memo of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PaymentType","full_name":"data[attributes][PaymentType]","description":"\n\u003cp\u003ePayment Type of the deposit designation detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_information","full_name":"data[attributes][contact_information]","description":"\n\u003cp\u003econtact information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"extension","full_name":"data[attributes][contact_information][extension]","description":"\n\u003cp\u003eextension\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_num","full_name":"data[attributes][contact_information][contact_num]","description":"\n\u003cp\u003econtact number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"typecode_desc","full_name":"data[attributes][contact_information][typecode_desc]","description":"\n\u003cp\u003econtact type (Email, Mobile Phone, etc)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"pca_event_deposit_details":{"doc_url":"/apipie/v2/pca_event_deposit_details","id":"pca_event_deposit_details","api_url":"/api/v2","name":"Pca event deposit details","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/pca_event_deposit_details/index","name":"index","apis":[{"api_url":"/api/v2/pay/pca_event_deposit_details","http_method":"GET","short_description":"Get all pca event deposit details within a date range","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null},{"code":422,"description":"The start date or end date is invalid","metadata":null},{"code":422,"description":"Start date cannot be greater than the end date","metadata":null}],"params":[{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eLower bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eUpper bound for DepositDate. Expects format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"PCA Event Deposit Details","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003epca event deposit details\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the pca event deposit detail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the deposit detail designation detail with contact info\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DepositID","full_name":"data[attributes][DepositID]","description":"\n\u003cp\u003eID of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"DepositDate","full_name":"data[attributes][DepositDate]","description":"\n\u003cp\u003eDate of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionID","full_name":"data[attributes][TransactionID]","description":"\n\u003cp\u003eID of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"TransactionDate","full_name":"data[attributes][TransactionDate]","description":"\n\u003cp\u003eDate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorID","full_name":"data[attributes][DonorID]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"FirstName","full_name":"data[attributes][FirstName]","description":"\n\u003cp\u003eThe transaction donor first name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"LastName","full_name":"data[attributes][LastName]","description":"\n\u003cp\u003eThe transaction donor last name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address1","full_name":"data[attributes][Address1]","description":"\n\u003cp\u003eAddress line 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Address2","full_name":"data[attributes][Address2]","description":"\n\u003cp\u003eAddress line 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"City","full_name":"data[attributes][City]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"State","full_name":"data[attributes][State]","description":"\n\u003cp\u003eState\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Zip","full_name":"data[attributes][Zip]","description":"\n\u003cp\u003eZip code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Country","full_name":"data[attributes][Country]","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Email","full_name":"data[attributes][Email]","description":"\n\u003cp\u003eEmail\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PhoneNumber","full_name":"data[attributes][PhoneNumber]","description":"\n\u003cp\u003ePhone number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Church","full_name":"data[attributes][Church]","description":"\n\u003cp\u003eChurch\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeDonorID","full_name":"data[attributes][PayeeDonorID]","description":"\n\u003cp\u003eID of the Payee donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"PayeeFirstName","full_name":"data[attributes][PayeeFirstName]","description":"\n\u003cp\u003eThe Payee first name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeLastName","full_name":"data[attributes][PayeeLastName]","description":"\n\u003cp\u003eThe Payee last name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeAddr1","full_name":"data[attributes][PayeeAddr1]","description":"\n\u003cp\u003ePayee Address line 1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeAddr2","full_name":"data[attributes][PayeeAddr2]","description":"\n\u003cp\u003ePayee Address line 2\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeCity","full_name":"data[attributes][PayeeCity]","description":"\n\u003cp\u003ePayee City\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeState","full_name":"data[attributes][PayeeState]","description":"\n\u003cp\u003ePayee State\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeZip","full_name":"data[attributes][PayeeZip]","description":"\n\u003cp\u003ePayee Zip code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeCountry","full_name":"data[attributes][PayeeCountry]","description":"\n\u003cp\u003ePayee Country\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeEmail","full_name":"data[attributes][PayeeEmail]","description":"\n\u003cp\u003ePayee Email\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeePhone","full_name":"data[attributes][PayeePhone]","description":"\n\u003cp\u003ePayee Phone number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"PayeeChurchID","full_name":"data[attributes][PayeeChurchID]","description":"\n\u003cp\u003ePayee Church\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RegAmount","full_name":"data[attributes][RegAmount]","description":"\n\u003cp\u003eAmount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ScholorshipAmount","full_name":"data[attributes][ScholorshipAmount]","description":"\n\u003cp\u003eScholorship amount of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TotalPaymentAmount","full_name":"data[attributes][TotalPaymentAmount]","description":"\n\u003cp\u003eTotal amount of the transaction.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FeeAmount","full_name":"data[attributes][FeeAmount]","description":"\n\u003cp\u003eFee amount of the transaction.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NetAmount","full_name":"data[attributes][NetAmount]","description":"\n\u003cp\u003eNet amount of the transaction.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationID","full_name":"data[attributes][DesignationID]","description":"\n\u003cp\u003eID of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"Designation","full_name":"data[attributes][Designation]","description":"\n\u003cp\u003eDesignation of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Memo","full_name":"data[attributes][Memo]","description":"\n\u003cp\u003eMemo of the deposit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"response_code_selects":{"doc_url":"/apipie/v2/response_code_selects","id":"response_code_selects","api_url":"/api/v2","name":"Response code selects","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/response_code_selects/index","name":"index","apis":[{"api_url":"/api/v2/pay/response_code_selects","http_method":"GET","short_description":"Get all response codes","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"response code selects","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eresponse code select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the response code select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the response code select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ResponseCodeValue","full_name":"data[attributes][ResponseCodeValue]","description":"\n\u003cp\u003eCode of the response\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCodeDescr","full_name":"data[attributes][ResponseCodeDescr]","description":"\n\u003cp\u003eDescription of the response\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ApplyTo","full_name":"data[attributes][ApplyTo]","description":"\n\u003cp\u003eWhat the response code applies to. (This is currently untracked)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"select_accounts":{"doc_url":"/apipie/v2/select_accounts","id":"select_accounts","api_url":"/api/v2","name":"Select accounts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/select_accounts/index","name":"index","apis":[{"api_url":"/api/v2/pay/select_accounts","http_method":"GET","short_description":"Get all accounts","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"DonorGUID","full_name":"DonorGUID","description":"\n\u003cp\u003eGUID of the Donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ShowAll","full_name":"ShowAll","description":"\n\u003cp\u003eShow all accounts? This value must be 1 or 0.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"accounts","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eselect accounts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of select\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the designation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"data[attributes][id]","description":"\n\u003cp\u003eID of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CreditCards","full_name":"data[attributes][CreditCards]","description":"\n\u003cp\u003eCredit Cards for account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"CreditCard","full_name":"data[attributes][CreditCards][CreditCard]","description":"\n\u003cp\u003eIndividual Credit Card for account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"AccountGUID","full_name":"data[attributes][CreditCards][CreditCard][AccountGUID]","description":"\n\u003cp\u003eGUID for credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NickName","full_name":"data[attributes][CreditCards][CreditCard][NickName]","description":"\n\u003cp\u003eNick name for credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ABARoutingNumber","full_name":"data[attributes][CreditCards][CreditCard][ABARoutingNumber]","description":"\n\u003cp\u003eABA routing number for credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"BankName","full_name":"data[attributes][CreditCards][CreditCard][BankName]","description":"\n\u003cp\u003eName of the bank for credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"MaskedAccountNumber","full_name":"data[attributes][CreditCards][CreditCard][MaskedAccountNumber]","description":"\n\u003cp\u003eMasked account number for credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Type","full_name":"data[attributes][CreditCards][CreditCard][Type]","description":"\n\u003cp\u003eType of credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StatusCode","full_name":"data[attributes][CreditCards][CreditCard][StatusCode]","description":"\n\u003cp\u003eStatus code of credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StatusName","full_name":"data[attributes][CreditCards][CreditCard][StatusName]","description":"\n\u003cp\u003eName/descriptor for status of credit card account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"IsNACHAValidated","full_name":"data[attributes][CreditCards][CreditCard][IsNACHAValidated]","description":"\n\u003cp\u003eIs the credit card account NACHA validated?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]},{"name":"BankAccounts","full_name":"data[attributes][BankAccounts]","description":"\n\u003cp\u003eBank Accounts for account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"BankAccount","full_name":"data[attributes][BankAccounts][BankAccount]","description":"\n\u003cp\u003eIndividual Bank Account for account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"AccountGUID","full_name":"data[attributes][BankAccounts][BankAccount][AccountGUID]","description":"\n\u003cp\u003eGUID for bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"NickName","full_name":"data[attributes][BankAccounts][BankAccount][NickName]","description":"\n\u003cp\u003eNick name for bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ABARoutingNumber","full_name":"data[attributes][BankAccounts][BankAccount][ABARoutingNumber]","description":"\n\u003cp\u003eABA routing number for bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"BankName","full_name":"data[attributes][BankAccounts][BankAccount][BankName]","description":"\n\u003cp\u003eName of the bank for bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"MaskedAccountNumber","full_name":"data[attributes][BankAccounts][BankAccount][MaskedAccountNumber]","description":"\n\u003cp\u003eMasked account number for bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Type","full_name":"data[attributes][BankAccounts][BankAccount][Type]","description":"\n\u003cp\u003eType of bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StatusCode","full_name":"data[attributes][BankAccounts][BankAccount][StatusCode]","description":"\n\u003cp\u003eStatus code of bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"StatusName","full_name":"data[attributes][BankAccounts][BankAccount][StatusName]","description":"\n\u003cp\u003eName/descriptor for status of bank account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"IsNACHAValidated","full_name":"data[attributes][BankAccounts][BankAccount][IsNACHAValidated]","description":"\n\u003cp\u003eIs the bank account NACHA validated? (Currently Untracked, expect null)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"verify_transactions":{"doc_url":"/apipie/v2/verify_transactions","id":"verify_transactions","api_url":"/api/v2","name":"Verify transactions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/verify_transactions/index","name":"index","apis":[{"api_url":"/api/v2/pay/verify_transactions","http_method":"GET","short_description":"Get all verify transactions","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null},{"code":422,"description":"Not logged in","metadata":null},{"code":422,"description":"Provision does not match logged in provision","metadata":null}],"params":[{"name":"donor_guid","full_name":"donor_guid","description":"\n\u003cp\u003eguid of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_schedule_guid","full_name":"account_schedule_guid","description":"\n\u003cp\u003eguid of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"verify transaction","is_array":true,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003everify transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eID of the verify transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eType of record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attributes","full_name":"data[attributes]","description":"\n\u003cp\u003eAttributes of the verify transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"AccountScheduleGUID","full_name":"data[attributes][AccountScheduleGUID]","description":"\n\u003cp\u003eGUID of the account schedule\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DonorGUID","full_name":"data[attributes][DonorGUID]","description":"\n\u003cp\u003eguid of the donor\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountGUID","full_name":"data[attributes][AccountGUID]","description":"\n\u003cp\u003eguid of the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"AccountScheduleStatus","full_name":"data[attributes][AccountScheduleStatus]","description":"\n\u003cp\u003estatus of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Amount","full_name":"data[attributes][Amount]","description":"\n\u003cp\u003eamount donated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ScheduledDate","full_name":"data[attributes][ScheduledDate]","description":"\n\u003cp\u003enext recurring date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RecurringType","full_name":"data[attributes][RecurringType]","description":"\n\u003cp\u003etype of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Quantity","full_name":"data[attributes][Quantity]","description":"\n\u003cp\u003enumber of recurring setups\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"RecurringName","full_name":"data[attributes][RecurringName]","description":"\n\u003cp\u003etype name of the recurring setup\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"Memo","full_name":"data[attributes][Memo]","description":"\n\u003cp\u003erecurring setup memo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"InvoiceNumber","full_name":"data[attributes][InvoiceNumber]","description":"\n\u003cp\u003eempty\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"CustomerTransactionID","full_name":"data[attributes][CustomerTransactionID]","description":"\n\u003cp\u003eempty\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData1","full_name":"data[attributes][UserDefinedData1]","description":"\n\u003cp\u003eempty\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData2","full_name":"data[attributes][UserDefinedData2]","description":"\n\u003cp\u003eempty\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"UserDefinedData3","full_name":"data[attributes][UserDefinedData3]","description":"\n\u003cp\u003eempty\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionGUID","full_name":"data[attributes][TransactionGUID]","description":"\n\u003cp\u003eguid of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionDate","full_name":"data[attributes][TransactionDate]","description":"\n\u003cp\u003edate of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"SettlementDate","full_name":"data[attributes][SettlementDate]","description":"\n\u003cp\u003edeposit date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"TransactionStatus","full_name":"data[attributes][TransactionStatus]","description":"\n\u003cp\u003estatus of the transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCode","full_name":"data[attributes][ResponseCode]","description":"\n\u003cp\u003etransaction response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCodeDescr","full_name":"data[attributes][ResponseCodeDescr]","description":"\n\u003cp\u003etransaction id of the customer\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ResponseCodeAVS","full_name":"data[attributes][ResponseCodeAVS]","description":"\n\u003cp\u003euser defined data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"FileID","full_name":"data[attributes][FileID]","description":"\n\u003cp\u003euser defined data\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designation_information","full_name":"data[attributes][designation_information]","description":"\n\u003cp\u003eAttributes of the designation_information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"DesignationID","full_name":"data[attributes][designation_information][DesignationID]","description":"\n\u003cp\u003edesignation id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationGUID","full_name":"data[attributes][designation_information][DesignationGUID]","description":"\n\u003cp\u003edesignation guid\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationName","full_name":"data[attributes][designation_information][DesignationName]","description":"\n\u003cp\u003edesignation name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAmount","full_name":"data[attributes][designation_information][DesignationAmount]","description":"\n\u003cp\u003edesignation amount\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"DesignationAllocationID","full_name":"data[attributes][designation_information][DesignationAllocationID]","description":"\n\u003cp\u003eid of the designation allocation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"designationmemo","full_name":"data[attributes][designation_information][designationmemo]","description":"\n\u003cp\u003edesignation memo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"additional_properties":false}],"examples":[],"metadata":{},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}},{"name":"Cookie","description":"Login session cookie","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"benefit_administrator_accounts":{"doc_url":"/apipie/v2/benefit_administrator_accounts","id":"benefit_administrator_accounts","api_url":"/api/v2","name":"Benefit administrator accounts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/benefit_administrator_accounts/index","name":"index","apis":[{"api_url":"/api/v2cog/benefit_administrator_accounts","http_method":"GET","short_description":"Request an account for UCC Engage","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eFirst name of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eLast name of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"title","full_name":"title","description":"\n\u003cp\u003eEmail address of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"churches","full_name":"churches","description":"\n\u003cp\u003eArray of church needs to be added\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"church_name","full_name":"churches[church_name]","description":"\n\u003cp\u003eChurch name of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_phone","full_name":"churches[church_phone]","description":"\n\u003cp\u003eChurch phone of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_address1","full_name":"churches[church_address1]","description":"\n\u003cp\u003eChurch address 1 of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_address2","full_name":"churches[church_address2]","description":"\n\u003cp\u003eChurch address 2 of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_city","full_name":"churches[church_city]","description":"\n\u003cp\u003eChurch city of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_state","full_name":"churches[church_state]","description":"\n\u003cp\u003eChurch state of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_zip","full_name":"churches[church_zip]","description":"\n\u003cp\u003eChurch zip of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_country","full_name":"churches[church_country]","description":"\n\u003cp\u003eChurch country of the church that the individual is requesting an account for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"existing_user_id","full_name":"existing_user_id","description":"\n\u003cp\u003eIndividual ID of a person requesting\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":204,"description":"Email sent","is_array":false,"returns_object":[],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"staff_account":{"doc_url":"/apipie/v2/staff_account","id":"staff_account","api_url":"/api/v2","name":"Staff account","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/staff_account/index","name":"index","apis":[{"api_url":"/api/v2ucc/staff_account","http_method":"GET","short_description":"Request an account for UCC Engage","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eFirst name of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eLast name of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_desc","full_name":"role_desc","description":"\n\u003cp\u003eRole description of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_title","full_name":"position_title","description":"\n\u003cp\u003ePosition title of individual requesting the account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_type","full_name":"organization_type","description":"\n\u003cp\u003eConference or Association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"conference_id","full_name":"conference_id","description":"\n\u003cp\u003eConference ID of individual requesting the account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"association_id","full_name":"association_id","description":"\n\u003cp\u003eAssociation ID of individual requesting the account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"existing_user_id","full_name":"existing_user_id","description":"\n\u003cp\u003eIndividual ID of a person requesting\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":204,"description":"Email sent","is_array":false,"returns_object":[],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"yearbook_account":{"doc_url":"/apipie/v2/yearbook_account","id":"yearbook_account","api_url":"/api/v2","name":"Yearbook account","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/yearbook_account/index","name":"index","apis":[{"api_url":"/api/v2/yearbook_account","http_method":"GET","short_description":"Get list of churches","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"individual_id","full_name":"individual_id","description":"\n\u003cp\u003eChurch staffs ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Get churches for yearbook reporter","is_array":false,"returns_object":[],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/yearbook_account/update","name":"update","apis":[{"api_url":"/api/v2/yearbook_account/:id","http_method":"PUT","short_description":"For existing person, add yearbook","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"church_role","full_name":"church_role","description":"\n\u003cp\u003eChurch role of a person creating account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_title","full_name":"position_title","description":"\n\u003cp\u003eTitle of a person creating account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_code","full_name":"church_code","description":"\n\u003cp\u003eChurch code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_code","full_name":"access_code","description":"\n\u003cp\u003eAccess code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":204,"description":"Created specialized ministry covenant","is_array":false,"returns_object":[],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false},{"doc_url":"/apipie/v2/yearbook_account/create","name":"create","apis":[{"api_url":"/api/v2/yearbook_account","http_method":"POST","short_description":"create a yearbook account","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"yearbook_account_create_param","full_name":"yearbook_account_create_param","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"first_name","full_name":"yearbook_account_create_param[first_name]","description":"\n\u003cp\u003eFirst name of a person creating account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"yearbook_account_create_param[last_name]","description":"\n\u003cp\u003eLast name of a person creating account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email_address","full_name":"yearbook_account_create_param[email_address]","description":"\n\u003cp\u003eEmail address of a person creating account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_role","full_name":"yearbook_account_create_param[church_role]","description":"\n\u003cp\u003eChurch role of a person creating account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_title","full_name":"yearbook_account_create_param[position_title]","description":"\n\u003cp\u003eTitle of a person creating account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"church_code","full_name":"yearbook_account_create_param[church_code]","description":"\n\u003cp\u003eChurch code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_code","full_name":"yearbook_account_create_param[access_code]","description":"\n\u003cp\u003eAccess code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":200,"description":"Created specialized ministry covenant","is_array":false,"returns_object":[],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null},"transactions":{"doc_url":"/apipie/v2/transactions","id":"transactions","api_url":"/api/v2","name":"Transactions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"/apipie/v2/transactions/create","name":"create","apis":[{"api_url":"/api/v2/cdmplus/cog/clerk_reports/:clerk_report_id/transactions","http_method":"POST","short_description":"Create a transaction for a clerk report","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":404,"description":"Data source query failed","metadata":null},{"code":422,"description":"Invalid parameter(s)","metadata":null},{"code":500,"description":"No connection to data source","metadata":null},{"code":422,"description":"Provision header missing","metadata":null},{"code":422,"description":"Invalid provision","metadata":null},{"code":422,"description":"Under maintenance","metadata":null},{"code":422,"description":"Incorrect host for provision","metadata":null},{"code":422,"description":"Establishing session failed","metadata":null},{"code":422,"description":"Privilege to perform the action was not found","metadata":null}],"params":[{"name":"clerk_report_id","full_name":"clerk_report_id","description":"\n\u003cp\u003eID of the clerk report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[{"code":401,"description":"Unauthorized","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":404,"description":"Not Found","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":500,"description":"Internal Server Error","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"\n\u003cp\u003eErrors returned by request\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"error","full_name":"errors[error]","description":"\n\u003cp\u003eWhy the request failed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"errors[status]","description":"\n\u003cp\u003eHTTP response code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":{"system":true,"session":false,"deprecated":false,"internal":true},"see":[],"headers":[{"name":"Provision","description":"Web/Mobile/API Provision UUID","options":{"required":true}}],"show":false}],"headers":null,"deprecated":null}}}}