{ "swagger": "2.0", "info": { "title": "PreciseFP Api", "version": "0.0.1" }, "host": "pfp.app:8000", "schemes": [ "http", "https" ], "basePath": "/api", "produces": [ "application/json" ], "definitions": { "Address": { "type": "object", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" } } }, "DriversLicense": { "type": "object", "properties": { "number": { "type": "string" }, "issue_date": { "type": "string" }, "expire_date": { "type": "string" }, "jurisdiction": { "$ref": "#/definitions/Address" }, "document": { "$ref": "#/definitions/Document" } } }, "Entity": { "type": "object", "properties": { "type": { "type": "string" } } }, "Member": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string" }, "phone": { "type": "string" } } }, "Relation": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "client", "coclient", "familyMember", "joint", "children", "grandchildren", "Employment", "FamilyMember", "Insurance", "Plan", "Cash", "Taxable", "Annuity", "Asset", "Liability", "ExenseVariable", "Goal", "Contact", "Document", "Note" ] }, "id": { "type": "string" } } }, "Currency": { "type": "object", "properties": { "value": { "type": "integer" }, "frequency": { "type": "string", "enum": [ "one-time", "monthly", "yearly" ] } } }, "File": { "type": "object", "description": "Representation of file. Binary", "properties": { "url": { "type": "string" }, "content": { "type": "string", "description": "If requested file content is endocoded with base64" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "image", "document" ] } } }, "Account": { "type": "object", "description": "Account object description. Blah blah blah.", "required": [ "client", "type" ], "properties": { "id": { "type": "integer", "description": "Unique id representing an account" }, "client": { "type":"object", "properties": { "first_name": { "type": "string", "description": "The client's first name.", "example": "John" }, "last_name": { "type": "string", "description": "The client's last name.", "example": "Doe" }, "email": { "type": "string", "description": "The client's email.", "example": "john@doe.com" } } }, "coclient": { "$ref": "#/definitions/Member", "default": null }, "type": { "type": "string", "description": "Type of Account.", "enum": [ "clients", "prospects" ], "example": "clients" }, "created_at": { "type": "string", "description": "Creation Timestamp", "example": "2017-01-01 12:00:00" }, "updated_at": { "type": "string", "description": "Last Update Timestamp", "example": "2017-01-01 12:00:00" } } }, "AccountMember": { "allOf": [ { "$ref": "#/definitions/Member" }, { "type": "object", "properties": { "id": { "type": "integer" }, "middle_initial": { "type": "string" }, "gender": { "type": "string" }, "birth_date": { "type": "string" }, "citizenship": { "type": "string" }, "home_phone": { "type": "string" }, "work_phone": { "type": "string" }, "address": { "$ref": "#/definitions/Address" }, "comments": { "type": "string" }, "marital_status": { "type": "string", "enum": [ "single", "married", "divorced", "widowed", "other", "partner" ] }, "previous_marriages": { "type": "integer" }, "photo": { "$ref": "#/definitions/File" }, "risk_score": { "type": "integer" }, "driver_license": { "$ref": "#/definitions/DriversLicense" } } } ] }, "FamilyMember": { "allOf": [ { "$ref": "#/definitions/Member" }, { "type": "object", "properties": { "id": { "type": "string" }, "relationship": { "type": "string", "enum": [ "child", "grandchild", "other" ] }, "college_type": { "type": "string" }, "college_start": { "type": "integer" }, "college_end": { "type": "integer" }, "dependant": { "type": "boolean" } }, "required": [ "relationship" ] } ] }, "Employment": { "type": "object", "properties": { "id": { "type": "string" }, "employer": { "type": "string" }, "position": { "type": "string" }, "duration": { "type": "integer" }, "address": { "$ref": "#/definitions/Address" }, "salary": { "$ref": "#/definitions/Currency" }, "comissions": { "$ref": "#/definitions/Currency" }, "document": { "$ref": "#/definitions/File" } } }, "Income": { "type": "object", "properties": { "employment": { "$ref": "#/definitions/Currency" }, "self_employment": { "$ref": "#/definitions/Currency" }, "annuities": { "$ref": "#/definitions/Currency" }, "social_security": { "$ref": "#/definitions/Currency" }, "dividends": { "$ref": "#/definitions/Currency" }, "interest": { "$ref": "#/definitions/Currency" }, "other": { "$ref": "#/definitions/Currency" }, "comments": { "type": "string" } } }, "Insurance": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "term", "whole", "universal", "variable", "variable-universal", "employer-term", "health", "disability", "employer-disability", "long-term-care", "homeowner", "auto", "umbrella", "eo-mailpractice", "other" ] }, "name": { "type": "string" }, "provider": { "type": "string" }, "owner": { "$ref": "#/definitions/Relation" }, "insured": { "$ref": "#/definitions/Relation" }, "primary_beneficiary": { "$ref": "#/definitions/Relation" }, "secondary_beneficiary": { "$ref": "#/definitions/Relation" }, "premium_value": { "$ref": "#/definitions/Currency" }, "coverage_value": { "$ref": "#/definitions/Currency" }, "cash_value": { "$ref": "#/definitions/Currency" } }, "required": [ "id", "name", "type", "owner" ] }, "Plan": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "401k", "roth401k", "403b", "457b", "ira", "roth-ira", "simple-ira", "sep-ira", "college, other" ] }, "owner": { "$ref": "#/definitions/Relation" }, "provider": { "type": "string" }, "contribution_value": { "$ref": "#/definitions/Currency" }, "employer_contribution_value": { "$ref": "#/definitions/Currency" }, "current_value": { "$ref": "#/definitions/Currency" }, "primary_beneficiary": { "$ref": "#/definitions/Relation" }, "secondary_beneficiary": { "$ref": "#/definitions/Relation" } }, "required": [ "id", "name", "type", "owner", "current_value" ] }, "Document": { "type": "object", "properties": { "id": { "type": "string" }, "file": { "$ref": "#/definitions/File" }, "relation": { "$ref": "#/definitions/Relation" } } }, "Asset": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "primary-residence", "secondary-residence", "vehicle", "collectible", "other" ] }, "owner": { "$ref": "#/definitions/Relation" }, "current_value": { "$ref": "#/definitions/Currency" }, "original_value": { "$ref": "#/definitions/Currency" } } }, "Cash": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "cash", "checking", "savings", "money-market", "cd", "other" ] }, "provider": { "type": "string" }, "owner": { "$ref": "#/definitions/Relation" }, "current_value": { "$ref": "#/definitions/Currency" }, "interest": { "type": "integer" }, "end_date": { "type": "string" } } }, "Taxable": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "owner": { "$ref": "#/definitions/Relation" }, "cost_value": { "$ref": "#/definitions/Currency" }, "current_value": { "$ref": "#/definitions/Currency" } } }, "Annuity": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "$ref": "#/definitions/Relation" }, "primary_beneficiary": { "$ref": "#/definitions/Relation" }, "secondary_beneficiary": { "$ref": "#/definitions/Relation" }, "type": { "type": "string", "enum": [ "fixed", "variable", "indexed", "pension" ] }, "contribution_value": { "$ref": "#/definitions/Currency" }, "current_value": { "$ref": "#/definitions/Currency" }, "distribution_type": { "type": "string", "enum": [ "series-of-distributions", "lump-sum" ] }, "distribution_value": { "$ref": "#/definitions/Currency" }, "distribution_start_year": { "type": "integer" } } }, "Liability": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "$ref": "#/definitions/Relation" }, "provider": { "type": "string" }, "type": { "type": "string", "enum": [ "arm", "fixed", "int-only", "auto", "business", "credit-line", "personal", "school", "credit-card", "other" ] }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "interest": { "type": "integer" }, "original_value": { "$ref": "#/definitions/Currency" }, "current_value": { "$ref": "#/definitions/Currency" }, "cost_value": { "$ref": "#/definitions/Currency" } } }, "ExpenseFixed": { "type": "object", "properties": { "rent": { "$ref": "#/definitions/Currency" }, "alimony": { "$ref": "#/definitions/Currency" }, "child_support": { "$ref": "#/definitions/Currency" }, "college": { "$ref": "#/definitions/Currency" }, "other_insurance": { "$ref": "#/definitions/Currency" }, "life_insurance": { "$ref": "#/definitions/Currency" }, "health_insurance": { "$ref": "#/definitions/Currency" }, "disability_insurance": { "$ref": "#/definitions/Currency" }, "long_term_care_insurance": { "$ref": "#/definitions/Currency" }, "homeowner_insurance": { "$ref": "#/definitions/Currency" }, "auto_insurance": { "$ref": "#/definitions/Currency" }, "umbrella_insurance": { "$ref": "#/definitions/Currency" }, "eo_malpractice_insurance": { "$ref": "#/definitions/Currency" }, "college_plan": { "$ref": "#/definitions/Currency" }, "annuity": { "$ref": "#/definitions/Currency" }, "retirement_plan": { "$ref": "#/definitions/Currency" }, "credit_card": { "$ref": "#/definitions/Currency" }, "mortgage": { "$ref": "#/definitions/Currency" }, "loan": { "$ref": "#/definitions/Currency" }, "other": { "$ref": "#/definitions/Currency" } } }, "ExpenseVariable": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "$ref": "#/definitions/Currency" }, "type": { "type": "string", "enum": [ "groceries", "supplies", "gas-electric", "water-trash", "cable-internet", "phone-mobile", "domestic-help", "clothing", "laundry-dry-cleaning", "property-improvements", "home-furnishings", "pet-expenses", "school-expenses", "lunch-money", "special-events", "babysitting-day-care", "gas-oil", "repair-maintenance", "parking-tolls", "public-transport", "personal-care", "medica-dental", "gym-membership", "eating-out", "entertainment", "books-subscriptions", "hobbies", "vacations", "gifts", "charity", "other" ] } } }, "ExpenseTax": { "type": "object", "properties": { "federal_income": { "$ref": "#/definitions/Currency" }, "state_income": { "$ref": "#/definitions/Currency" }, "fica": { "$ref": "#/definitions/Currency" }, "real_estate": { "$ref": "#/definitions/Currency" }, "other": { "$ref": "#/definitions/Currency" } } }, "Goal": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "travel", "wedding", "celebration", "college", "private-school", "business", "home", "home-improvement", "purchase", "care", "donation", "bequest", "other" ] }, "name": { "type": "string" }, "owner": { "$ref": "#/definitions/Relation" }, "beneficiary": { "$ref": "#/definitions/Relation" }, "priority": { "type": "string", "enum": [ "low", "medium", "high" ] }, "frequency": { "type": "string", "enum": [ "one-time", "monthly", "quarterly", "annually" ] }, "target": { "$ref": "#/definitions/Target" } } }, "Target": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "$ref": "#/definitions/Currency" }, "start": { "type": "string" }, "end": { "type": "string" } } }, "Contact": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "accountant", "attorney", "broker", "insurance-agent", "tax-preparer", "other" ] }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "AuthenticatedUser": { "type": "object", "properties": { "profile": { "$ref": "#/definitions/Profile" }, "company": { "$ref": "#/definitions/Company" }, "team": { "$ref": "#/definitions/Team" } } }, "Company": { "type": "object", "properties": { "name": { "type": "string" } } }, "Team": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "logo": { "$ref": "#/definitions/File" } } }, "Profile": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "photo": { "$ref": "#/definitions/File" } } }, "Token": { "type": "object", "properties": { "token": { "type": "string", "description": "Token string" } } }, "ResponseList": { "type": "object", "required": [ "total", "limit", "offset" ], "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } }, "ErrorResponse": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "parameter": { "type": "string" } } }, "ValidationError": { "type": "object", "properties": { "status": { "type": "string" }, "code": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } } } }, "securityDefinitions": { "Oauth": { "type": "oauth2", "flow": "password", "scopes": { "login": "SSO", "accounts": "Clients data", "users": "Users data" }, "tokenUrl": "http://pfpl5.app/oauth/token" } }, "paths": { "/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List of accounts", "description": "List all Accounts available for the current user.", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "type", "description": "Filtering results by account type clients|prospects", "in": "query", "type": "string", "enum": [ "clients", "prospects" ] }, { "name": "limit", "description": "Limiting results for pagination purposes", "in": "query", "type": "integer" }, { "name": "offset", "description": "Result offset for pagination purposes", "in": "query", "type": "integer" } ], "responses": { "200": { "description": "List of accounts", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Account" } } } }, "example": { "items": [ { "id": "4", "client": { "first_name": "Peter", "last_name": "Parker", "email": "peterparker@precisefp.com", "phone": null, "photo": null, "status": "NEW", "type": "CLIENT" }, "coclient": { "first_name": "Ella", "last_name": "Parker", "email": "ellaparker@precisefp.com", "phone": null, "photo": null, "status": "NEW", "type": "COCLIENT" }, "type": "clients", "created_at": "2017-04-10 09:04:11", "updated_at": "2017-04-10 14:09:02" }, { "id": "5", "client": { "first_name": "Richmond", "last_name": "Hertz", "email": "ritchmondhertz@precisefp.com", "phone": "+1 1234124534", "photo": { "type": "image", "url": "http://pfp.app:8000/api/accounts/5/client/details/photo/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9kOTAyZTgwYy1lYmI4LTQwNDQtOTc0Zi0xYjc5ZTdhOTI5NTciLCJuYW1lIjoibWlrZS5qcGciLCJzaXplIjoyNDUzOH0", "filetype": "image/jpeg", "filesize": 24538, "filename": "mike.jpg" }, "status": "NEW", "type": "CLIENT" }, "coclient": { "first_name": "Daphne", "last_name": "Hertz", "email": "daphnehertz@precisefp.com", "phone": "+1 4124531241", "photo": { "type": "image", "url": "http://pfp.app:8000/api/accounts/5/coclient/details/photo/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8yNjgyNWRmNS0wZjg3LTRiYjAtYWEzOS1hY2NjYzljMjVlNmIiLCJuYW1lIjoibWpzLWJpZ2JlYXIwNmYuanBnIiwic2l6ZSI6MzQ0MDUzfQ", "filetype": "image/jpeg", "filesize": 344053, "filename": "mjs-bigbear06f.jpg" }, "status": "NEW", "type": "COCLIENT" }, "type": "clients", "created_at": "2017-04-10 10:42:50", "updated_at": "2017-04-10 11:47:59" } ], "limit": 100, "offset": 0, "total": 2 } } } }, "post": { "tags": [ "POST", "Accounts" ], "summary": "Create account", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Account", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Account" } } ], "responses": { "201": { "schema": { "$ref": "#/definitions/Account" }, "description": "Item created successfuly" }, "422": { "description": "Validation Failed", "schema": { "allOf": [ { "$ref": "#/definitions/ErrorResponse" } ] } } } } }, "/accounts/{accountId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Accounts" ], "summary": "Get account item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Account" }, "examples": { "application/json": { "id": "5", "client": { "first_name": "Richmond", "last_name": "Hertz", "email": "ritchmondhertz@precisefp.com", "phone": "+1 1234124534", "photo": { "type": "image", "url": "http://pfp.app:8000/api/accounts/5/client/details/photo/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9kOTAyZTgwYy1lYmI4LTQwNDQtOTc0Zi0xYjc5ZTdhOTI5NTcifQ", "filetype": "image/jpeg", "filesize": 24538, "filename": "mike.jpg" }, "status": "NEW" }, "coclient": { "first_name": "Daphne", "last_name": "Hertz", "email": "daphnehertz@precisefp.com", "phone": "+1 4124531241", "photo": { "type": "image", "url": "http://pfp.app:8000/api/accounts/5/coclient/details/photo/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8yNjgyNWRmNS0wZjg3LTRiYjAtYWEzOS1hY2NjYzljMjVlNmIifQ", "filetype": "image/jpeg", "filesize": 344053, "filename": "mjs-bigbear06f.jpg" }, "status": "NEW" }, "type": "clients", "created_at": "2017-04-10 10:42:50", "updated_at": "2017-04-10 11:13:38" } } } } }, "put": { "tags": [ "PUT", "Accounts" ], "summary": "Update account", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "account", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Account" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Account" }, "examples": { "application/json": { "id": "2", "client": { "first_name": "Jackson", "last_name": "Smith", "email": "sacksonjmith@precisefp.com", "phone": null, "photo": { "type": "image", "url": "http://pfp.app:8000/api/accounts/2/client/details/photo/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC0yXC9kYWIwMDc4NC03MTMyLTRjMTMtYWYyYS03YzdjOWU4MWU0OTgifQ", "filetype": "image/jpeg", "filesize": 24538, "filename": "mike.jpg" }, "status": "NEW" }, "coclient": { "first_name": "Jill", "last_name": "Smith", "email": "jillsmith@precisefp.com", "phone": null, "photo": { "type": "image", "url": "http://pfp.app:8000/api/accounts/2/coclient/details/photo/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC0yXC80ZWY2NjUxNC0yMTNkLTQ4NzktYmEzZS02MjJiYWVhMTFiNGMifQ", "filetype": "image/jpeg", "filesize": 344053, "filename": "mjs-bigbear06f.jpg" }, "status": "NEW" }, "type": "clients", "created_at": "2017-04-05 10:09:11", "updated_at": "2017-04-05 14:11:34" } } } } }, "delete": { "tags": [ "DELETE", "Accounts" ], "summary": "Delete account", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/{client}/details": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "client", "type": "string", "enum": [ "client", "coclient" ], "in": "path", "required": true } ], "get": { "tags": [ "GET", "Details" ], "summary": "Get client details", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/AccountMember" }, "examples": { "application/json": { "first_name": "Richmond", "middle_initial": null, "last_name": "Hertz", "gender": "male", "birth_date": "1974-10-28 00:00:00", "marital_status": "married", "previous_marriages": null, "citizenship": null, "email": "ritchmondhertz@precisefp.com", "phone": "+1 1234124534", "home_phone": null, "work_phone": null, "address": { "address1": "Baker Street", "city": "Little Rock", "state": "GA", "zip": "21212", "country": "US" }, "photo": { "type": "image", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9kOTAyZTgwYy1lYmI4LTQwNDQtOTc0Zi0xYjc5ZTdhOTI5NTciLCJuYW1lIjoibWlrZS5qcGciLCJzaXplIjoyNDUzOH0", "filetype": "image/jpeg", "filesize": 24538, "filename": "mike.jpg" }, "risk_score": null, "comments": "This is our best client.", "drivers_license": { "number": "124124123", "issue_date": "2009-05-18 00:00:00", "expire_date": "2020-11-25 00:00:00", "jurisdiction": { "state": "GA", "country": "US" }, "document": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8wMTliMGNlYS00ZGU4LTQ4ZTgtYjY3NS0yMmM4ZDVkOGY2NGEiLCJuYW1lIjoiYWJjZGVmXzAyLTIzLTIwMTdfMTEtMTMueGxzIiwic2l6ZSI6NDYwOH0", "filetype": "application/octet-stream", "filesize": 4608, "filename": "abcdef_02-23-2017_11-13.xls" } } } } } } }, "put": { "tags": [ "PUT", "Details" ], "description": "Update client details", "consumes": [ "application/json" ], "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Client", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AccountMember" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Member" }, "examples": { "application/json": { "first_name": "Bernard", "middle_initial": "B", "last_name": "Barker", "gender": "male", "birth_date": "1981-09-12 00:00:00", "marital_status": "widowed", "previous_marriages": 4, "citizenship": null, "email": "bernardbarker@precisefp.com", "phone": "+1 234624543", "home_phone": "+2 451232789", "work_phone": "+3 997524768", "address": { "city": "Warsaw", "state": "NY", "zip": "74142", "country": "US" }, "photo": null, "risk_score": 56, "comments": "This is our first client", "drivers_license": { "number": "2436225725", "issue_date": "2013-05-20 00:00:00", "expire_date": "2020-07-01 00:00:00", "jurisdiction": { "state": "CO", "country": "US" }, "document": null } } } }, "422": { "description": "Validatiton Error", "schema": { "$ref": "#/definitions/ValidationError" }, "examples": { "application/json": { "status": "error", "code": 0, "messages": { "last_name": [ "The last name field is required." ] } } } } } } }, "/accounts/{accountId}/{client}/employment": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "client", "type": "string", "enum": [ "client", "coclient" ], "in": "path", "required": true } ], "get": { "tags": [ "GET", "Employment" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Employment" } } } }, "examples": { "application/json": { "items": [ { "id": "cc428cbc-400b-4022-9e1b-eec86ec11479|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "employer": "Pepco", "position": "Engineer", "duration": 9, "address": { "address1": "Lincoln Street 211", "city": "Little Rock", "state": "GA", "zip": "21231", "country": "US" }, "salary": { "value": 134212, "frequency": "yearly" }, "commissions": { "value": 2220, "frequency": "yearly" }, "document": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC80OTM4YmM5YS1lNTY1LTRhMzMtODhkMy1lODcyZDQ2MmM5NWYiLCJuYW1lIjoiY29udGFjdC1pbmZvcm1hdGlvbl8wMi0yMC0yMDE3XzEyLTQ1LmNzdiIsInNpemUiOjE4NDJ9", "filetype": "application/octet-stream", "filesize": 1842, "filename": "contact-information_02-20-2017_12-45.csv" } } ] } } } } }, "post": { "tags": [ "POST", "Employment" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Employment", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Employment" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Employment" } } } } }, "/accounts/{accountId}/{client}/employment/{employmentId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "client", "type": "string", "enum": [ "client", "coclient" ], "in": "path", "required": true }, { "name": "employmentId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Employment" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Employment" }, "examples": { "application/json": { "id": "cc428cbc-400b-4022-9e1b-eec86ec11479|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "employer": "Pepco", "position": "Engineer", "duration": 9, "address": { "address1": "Lincoln Street 211", "city": "Little Rock", "state": "GA", "zip": "21231", "country": "US" }, "salary": { "value": 134212, "frequency": "yearly" }, "commissions": { "value": 2220, "frequency": "yearly" }, "document": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC80OTM4YmM5YS1lNTY1LTRhMzMtODhkMy1lODcyZDQ2MmM5NWYiLCJuYW1lIjoiY29udGFjdC1pbmZvcm1hdGlvbl8wMi0yMC0yMDE3XzEyLTQ1LmNzdiIsInNpemUiOjE4NDJ9", "filetype": "application/octet-stream", "filesize": 1842, "filename": "contact-information_02-20-2017_12-45.csv" } } } } } }, "put": { "tags": [ "PUT", "Employment" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Employment", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Employment" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Employment" }, "examples": { "application/json": { "id": "cc428cbc-400b-4022-9e1b-eec86ec11479|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "employer": "Walmart ", "position": "Manager", "duration": 9, "address": { "city": "Krakow", "state": "NY", "zip": "51412", "country": "US" }, "salary": { "value": 18600, "frequency": "yearly" }, "commissions": null, "document": null } } } } }, "delete": { "tags": [ "DELETE", "Employment" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/{client}/income": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "client", "type": "string", "enum": [ "client", "coclient" ], "in": "path", "required": true } ], "get": { "tags": [ "GET", "Income" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Income" } } } }, "examples": { "application/json": { "employment": { "value": 136432, "frequency": "one-time" }, "self_employment": { "value": 0, "frequency": "yearly" }, "annuities": { "value": 26556, "frequency": "one-time" }, "social_security": { "value": 230, "frequency": "yearly" }, "dividends": { "value": 0, "frequency": "yearly" }, "interest": { "value": 0, "frequency": "yearly" }, "other": { "value": 0, "frequency": "yearly" }, "comments": null } } } } }, "put": { "tags": [ "PUT", "Income" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Income", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Income" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Income" }, "examples": { "application/json": { "employment": { "value": 1, "frequency": "one-time" }, "self_employment": { "value": 4000, "frequency": "yearly" }, "annuities": { "value": 1, "frequency": "one-time" }, "social_security": { "value": 30, "frequency": "yearly" }, "dividends": { "value": 99, "frequency": "yearly" }, "interest": { "value": 55, "frequency": "yearly" }, "other": { "value": 800, "frequency": "yearly" }, "comments": null } } } } } }, "/accounts/{accountId}/family": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Family" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FamilyMember" } } } }, "examples": { "application/json": { "items": [ { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "relationship": "child", "first_name": "Jason", "middle_initial": null, "last_name": "Hertz", "gender": "male", "birth_date": "1999-11-25 00:00:00", "dependant": true, "email": "jasonhertz@precisefp.com", "phone": "+1 214124123", "address": { "address1": "Baker Street", "city": "Little Rock", "state": "GA", "zip": "21212", "country": "US" }, "college_type": "private", "college_start_year": null, "college_end_year": null } ] } } } } }, "post": { "tags": [ "POST", "Family" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "FamilyMember", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FamilyMember" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/FamilyMember" } } } } }, "/accounts/{accountId}/family/{familyMemberId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "familyMemberId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Family" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/FamilyMember" }, "examples": { "application/json": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "relationship": "child", "first_name": "Jason", "middle_initial": null, "last_name": "Hertz", "gender": "male", "birth_date": "1999-11-25 00:00:00", "dependant": true, "email": "jasonhertz@precisefp.com", "phone": "+1 214124123", "address": { "address1": "Baker Street", "city": "Little Rock", "state": "GA", "zip": "21212", "country": "US" }, "college_type": "private", "college_start_year": null, "college_end_year": null } } } } }, "put": { "tags": [ "PUT", "Family" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "FamilyMember", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FamilyMember" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/FamilyMember" }, "examples": { "application/json": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bb", "relationship": "child", "first_name": "Chris", "middle_initial": null, "last_name": "Bacon", "gender": null, "birth_date": null, "dependant": null, "email": "chrisbacon@precisefp.com", "phone": "+1 959352343", "address": null, "college_type": "public", "college_start_year": null, "college_end_year": null } } } } }, "delete": { "tags": [ "DELETE", "Family" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/insurance": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Insurance" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Insurance" } } } }, "examples": { "application/json": { "items": [ { "id": "438464cd-07da-480e-9385-c6f2e9389caa|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "term", "name": "Richmond's Metlife Term Life", "provider": "MetLife", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "coclient", "label": "Daphne Hertz" }, "secondary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "premium_value": { "value": 1230, "frequency": "yearly" }, "coverage_value": { "value": 1200000, "frequency": "one-time" }, "cash_value": { "value": 53123, "frequency": "one-time" } }, { "id": "115aca7a-9431-4450-89a2-297591f5208b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "health", "name": "Basic Health Insurance", "provider": "WBK", "owner": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "insured": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "primary_beneficiary": null, "secondary_beneficiary": null, "premium_value": { "value": 2853, "frequency": "yearly" }, "coverage_value": null, "cash_value": null }, { "id": "606fa6c4-b22a-4d3b-a690-c5944ebe40d1|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "disability", "name": "Daphne Disability Insurance", "provider": "InsuranceCompaniesUnited", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": null, "secondary_beneficiary": null, "premium_value": { "value": 8900, "frequency": "yearly" }, "coverage_value": { "value": 600000, "frequency": "one-time" }, "cash_value": null }, { "id": "01a9453b-0717-4966-9dc1-cf1b706c3556|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "long-term-care", "name": "Richmond Long Term Care", "provider": "Bank of America", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": null, "secondary_beneficiary": null, "premium_value": { "value": 890, "frequency": "yearly" }, "coverage_value": null, "cash_value": null }, { "id": "c4812415-354b-4319-baf9-d96767fafdf0|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "homeowner", "name": "Florida Homeowner's Insurance", "provider": "Florida Insurers", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": null, "primary_beneficiary": null, "secondary_beneficiary": null, "premium_value": { "value": 1250, "frequency": "yearly" }, "coverage_value": { "value": 1200000, "frequency": "one-time" }, "cash_value": null }, { "id": "c1399433-86f8-49de-a1f0-91a4e37f0e2b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "auto", "name": "Richmond Porsche Insurance", "provider": "PKO", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": null, "primary_beneficiary": null, "secondary_beneficiary": null, "premium_value": { "value": 599, "frequency": "yearly" }, "coverage_value": { "value": 800000, "frequency": "one-time" }, "cash_value": null }, { "id": "9d744475-f348-4d44-83da-b599ee761b08|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "umbrella", "name": "Richmond's Umbrella", "provider": "InsurancesAmerica", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": null, "secondary_beneficiary": null, "premium_value": { "value": 750, "frequency": "yearly" }, "coverage_value": { "value": 650000, "frequency": "one-time" }, "cash_value": null }, { "id": "f98dbcf6-d34b-48d7-a7f0-11b27b41e3ce|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "eo-malpractice", "name": "Richmond's Malpractice Insurance", "provider": "PKO", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": null, "secondary_beneficiary": null, "premium_value": { "value": 490, "frequency": "yearly" }, "coverage_value": null, "cash_value": null }, { "id": "7787d69b-1053-4a70-a7aa-19073f9c7d99|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "other", "name": "Richmond's Marina Insurance", "provider": "WBK of America", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "premium_value": { "value": 755, "frequency": "yearly" }, "coverage_value": { "value": 500000, "frequency": "one-time" }, "cash_value": { "value": 18500, "frequency": "one-time" } } ] } } } } }, "post": { "tags": [ "POST", "Insurance" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Insurance", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Insurance" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Insurance" } } } } }, "/accounts/{accountId}/insurance/{insuranceId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "insuranceId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Insurance" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Insurance" }, "examples": { "application/json": { "id": "438464cd-07da-480e-9385-c6f2e9389caa|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "term", "name": "Richmond's Metlife Term Life", "provider": "MetLife", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "insured": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "coclient", "label": "Daphne Hertz" }, "secondary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "premium_value": { "value": 1230, "frequency": "yearly" }, "coverage_value": { "value": 1200000, "frequency": "one-time" }, "cash_value": { "value": 53123, "frequency": "one-time" } } } } } }, "put": { "tags": [ "PUT", "Insurance" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Insurance", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Insurance" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Insurance" }, "examples": { "application/json": { "id": "438464cd-07da-480e-9385-c6f2e9389caa|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "term", "name": "20 year term insurance", "provider": "AmericaInsurances", "owner": { "id": "4", "type": "client", "label": null }, "insured": { "id": null, "type": "Insurance", "label": null }, "primary_beneficiary": { "id": null, "type": "coclient", "label": null }, "secondary_beneficiary": { "id": null, "type": "children", "label": null }, "premium_value": { "value": 2000, "frequency": "yearly" }, "coverage_value": { "value": 600000, "frequency": "yearly" }, "cash_value": { "value": 57050, "frequency": "yearly" } } } } } }, "delete": { "tags": [ "DELETE", "Insurance" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/plans": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Plans" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Plan" } } } }, "examples": { "application/json": { "items": [ { "id": "ddbbf2c5-0d98-4988-9924-91fe98e1537a|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "401k", "name": "Jason's 401(k)", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "contribution_value": { "value": 350, "frequency": "monthly" }, "employer_contribution_value": { "value": 350, "frequency": "monthly" }, "current_value": { "value": 21534, "frequency": "one-time" } }, { "id": "7834b56f-78fa-45b6-9587-71153f45fc21|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "roth-401k", "name": "Richmond's Roth 401", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "contribution_value": { "value": 200, "frequency": "monthly" }, "employer_contribution_value": { "value": 200, "frequency": "monthly" }, "current_value": { "value": 4250, "frequency": "one-time" } }, { "id": "38f0c728-dc2f-4ba9-afde-3ab3d02b70c5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "403b", "name": "Richmond's 403b", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": null, "type": "coclient", "label": "Daphne Hertz" }, "contribution_value": { "value": 170, "frequency": "monthly" }, "employer_contribution_value": { "value": 170, "frequency": "monthly" }, "current_value": { "value": 4321, "frequency": "one-time" } }, { "id": "c53d8dd9-11f6-4249-99d2-cdabcabc6c59|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "457b", "name": "Daphne's 457b", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": null, "type": "coclient", "label": "Daphne Hertz" }, "contribution_value": { "value": 22, "frequency": "monthly" }, "employer_contribution_value": { "value": 220, "frequency": "monthly" }, "current_value": { "value": 4350, "frequency": "one-time" } }, { "id": "ea1e8707-a57c-40b2-98b4-7d9eeace3441|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "ira", "name": "Richmond's IRA plan", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": null, "type": "coclient", "label": "Daphne Hertz" }, "contribution_value": { "value": 90, "frequency": "monthly" }, "employer_contribution_value": null, "current_value": { "value": 2200, "frequency": "one-time" } }, { "id": "4ed3d624-843c-49df-95bc-e5eba4f194b2|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "roth-ira", "name": "Richmond's Roth", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": null, "type": "coclient", "label": "Daphne Hertz" }, "contribution_value": { "value": 100, "frequency": "monthly" }, "employer_contribution_value": null, "current_value": { "value": 4300, "frequency": "one-time" } }, { "id": "f665537a-e774-4a41-aa97-28568edbb77a|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "simple-ira", "name": "Richmond's Simple IRA", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": null, "type": "coclient", "label": "Daphne Hertz" }, "contribution_value": { "value": 50, "frequency": "monthly" }, "employer_contribution_value": { "value": 50, "frequency": "monthly" }, "current_value": { "value": 1250, "frequency": "one-time" } }, { "id": "1f404cf7-ed5e-4ae7-90e5-705769aec2f5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "sep-ira", "name": "Richmond Sep ira", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "contribution_value": { "value": 30, "frequency": "monthly" }, "employer_contribution_value": { "value": 30, "frequency": "monthly" }, "current_value": { "value": 9000, "frequency": "one-time" } }, { "id": "715adfb1-3b04-4729-b0d8-96a74a8cd355|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "college", "name": "College funds for Jason", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "secondary_beneficiary": null, "contribution_value": { "value": 70, "frequency": "monthly" }, "employer_contribution_value": null, "current_value": { "value": 3400, "frequency": "one-time" } } ] } } } } }, "post": { "tags": [ "POST", "Plans" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Employment", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Plan" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Plan" } } } } }, "/accounts/{accountId}/plans/{planId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "planId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Plans" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Plan" }, "examples": { "application/json": { "id": "ddbbf2c5-0d98-4988-9924-91fe98e1537a|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "401k", "name": "Jason's 401(k)", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "secondary_beneficiary": { "id": "f5086bc5-80ee-414e-add8-e7df1e1a63de|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "FamilyMember", "label": "Jason Hertz" }, "contribution_value": { "value": 350, "frequency": "monthly" }, "employer_contribution_value": { "value": 350, "frequency": "monthly" }, "current_value": { "value": 21534, "frequency": "one-time" } } } } } }, "put": { "tags": [ "PUT", "Plans" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Plan", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Plan" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Plan" }, "examples": { "application/json": { "id": "ddbbf2c5-0d98-4988-9924-91fe98e1537a|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "401k", "name": "Retirement plan 401k", "provider": "ZUS", "owner": { "id": "4", "type": "client", "label": null }, "primary_beneficiary": { "id": null, "type": "client", "label": null }, "secondary_beneficiary": { "id": null, "type": "coclient", "label": null }, "contribution_value": { "value": 320, "frequency": "yearly" }, "employer_contribution_value": { "value": 320, "frequency": "yearly" }, "current_value": { "value": 5000, "frequency": "one-time" } } } } } }, "delete": { "tags": [ "DELETE", "Plans" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/annuities": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Annuities", "Pensions" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Annuity" } } } }, "examples": { "application/json": { "items": [ { "id": "8aec83f8-7c54-41a8-a564-df253e2c07e5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "fixed", "name": "Richmond Annuities 2015", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": null, "secondary_beneficiary": null, "contribution_value": { "value": 70, "frequency": "monthly" }, "current_value": { "value": 2460, "frequency": "one-time" }, "distribution_type": null, "distribution_start_year": 2019, "distribution_value": { "value": 3400, "frequency": "one-time" } } ] } } } } }, "post": { "tags": [ "POST", "Annuities", "Pensions" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Annuity", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Annuity" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Annuity" } } } } }, "/accounts/{accountId}/annuities/{pensionId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "pensionId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Annuities", "Pensions" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Annuity" }, "examples": { "application/json": { "id": "8aec83f8-7c54-41a8-a564-df253e2c07e5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "fixed", "name": "Richmond Annuities 2015", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "primary_beneficiary": null, "secondary_beneficiary": null, "contribution_value": { "value": 70, "frequency": "monthly" }, "current_value": { "value": 2460, "frequency": "one-time" }, "distribution_type": null, "distribution_start_year": 2019, "distribution_value": { "value": 3400, "frequency": "one-time" } } } } } }, "put": { "tags": [ "PUT", "Annuities", "Pensions" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Annuity", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Annuity" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Annuity" }, "examples": { "application/json": { "id": "8aec83f8-7c54-41a8-a564-df253e2c07e5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bb", "type": "variable", "name": "New Annuity ", "provider": null, "owner": { "id": null, "type": "client", "label": null }, "primary_beneficiary": { "id": null, "type": "coclient", "label": null }, "secondary_beneficiary": { "id": null, "type": "coclient", "label": null }, "contribution_value": { "value": 150, "frequency": "yearly" }, "current_value": { "value": 4000, "frequency": "yearly" }, "distribution_type": "lump-sum", "distribution_start_year": 2015, "distribution_value": { "value": 5000, "frequency": "monthly" } } } } } }, "delete": { "tags": [ "DELETE", "Annuities", "Pensions" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/assets": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Assets" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Asset" } } } }, "examples": { "application/json": { "items": [ { "id": "365f7627-10f2-4183-a724-eade147ac9fe|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "Richmond's Porsche", "type": "vehicle", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 35000, "frequency": "one-time" }, "original_value": { "value": 29000, "frequency": "one-time" } }, { "id": "776e5585-f910-45ca-baad-28c452a147f0|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "Pepco shares", "type": "business", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 7900, "frequency": "one-time" }, "original_value": null }, { "id": "35508092-2b36-4344-bce6-0f74d0219b1f|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "Richmond's Yacht", "type": "other", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 32050, "frequency": "one-time" }, "original_value": null } ] } } } } }, "post": { "tags": [ "POST", "Assets" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Asset", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Asset" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Asset" } } } } }, "/accounts/{accountId}/assets/{assetId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "assetId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Assets" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Asset" }, "examples": { "application/json": { "id": "365f7627-10f2-4183-a724-eade147ac9fe|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "Richmond's Porsche", "type": "vehicle", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 35000, "frequency": "one-time" }, "original_value": { "value": 29000, "frequency": "one-time" } } } } } }, "put": { "tags": [ "PUT", "Assets" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Asset", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Asset" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Asset" }, "examples": { "application/json": { "id": "365f7627-10f2-4183-a724-eade147ac9fe|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "New Yacht", "type": "vehicle", "owner": { "id": "2", "type": "client", "label": null }, "current_value": { "value": 95000, "frequency": "one-time" }, "original_value": { "value": 87000, "frequency": "one-time" } } } } } }, "delete": { "tags": [ "DELETE", "Assets" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/cash": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Cash" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Cash" } } } }, "examples": { "application/json": { "items": [ { "id": "5076bdae-1af1-4a9a-8827-64106f44c80b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "checking", "name": "ING Richmond's Primary", "provider": "ING", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 23123, "frequency": "one-time" }, "interest": null, "end_date": null }, { "id": "50b6d456-7745-4cac-8f5e-58a416a54dea|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "cd", "name": "Richmond's Certificate of Deposit", "provider": "Bank of America", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 19340, "frequency": "one-time" }, "interest": 6, "end_date": "2018-11-29 00:00:00" } ] } } } } }, "post": { "tags": [ "POST", "Cash" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Cash", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Cash" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Cash" } } } } }, "/accounts/{accountId}/cash/{cashId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "cashId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Cash" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Cash" }, "examples": { "application/json": { "id": "5076bdae-1af1-4a9a-8827-64106f44c80b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "checking", "name": "ING Richmond's Primary", "provider": "ING", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 23123, "frequency": "one-time" }, "interest": null, "end_date": null } } } } }, "put": { "tags": [ "PUT", "Cash" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Cash", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Cash" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Cash" }, "examples": { "application/json": { "id": "5076bdae-1af1-4a9a-8827-64106f44c80b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "savings", "name": "Bank of America account", "provider": "Bank of America", "owner": { "id": "2", "type": "client", "label": null }, "current_value": { "value": 300000, "frequency": "one-time" }, "interest": 7, "end_date": "2018-05-05 00:00:00" } } } } }, "delete": { "tags": [ "DELETE", "Cash" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/taxable": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Taxable" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Taxable" } } } }, "examples": { "application/json": { "items": [ { "id": "d9ed7030-d766-41e2-bcd2-de0f507a128b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "Richmond's Taxable Investment Acc", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 3567, "frequency": "one-time" }, "cost_value": { "value": 50, "frequency": "one-time" } } ] } } } } }, "post": { "tags": [ "POST", "Taxable" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Taxable", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Taxable" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Taxable" } } } } }, "/accounts/{accountId}/taxable/{taxableId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "taxableId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Taxable" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Taxable" }, "examples": { "application/json": { "id": "d9ed7030-d766-41e2-bcd2-de0f507a128b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "Richmond's Taxable Investment Acc", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 3567, "frequency": "one-time" }, "cost_value": { "value": 50, "frequency": "one-time" } } } } } }, "put": { "tags": [ "PUT", "Taxable" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Taxable", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Taxable" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Taxable" }, "examples": { "application/json": { "id": "d9ed7030-d766-41e2-bcd2-de0f507a128b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "name": "Inv Account 2018", "provider": "ING", "owner": { "id": "2", "type": "client", "label": null }, "current_value": { "value": 300, "frequency": "one-time" }, "cost_value": { "value": 6000, "frequency": "one-time" } } } } } }, "delete": { "tags": [ "DELETE", "Taxable" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/liabilities": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Liability" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Liability" } } } }, "examples": { "application/json": { "items": [ { "id": "6c775488-6285-4fa5-80cf-3fc19e517a05|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "credit-card", "name": "Richmond Golden Credit", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 31210, "frequency": "one-time" }, "original_value": null, "cost_value": { "value": 10, "frequency": "monthly" }, "interest": 6, "start_date": null, "end_date": null }, { "id": "70c8d880-62ed-45ac-9f3a-1a2551e271f9|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "fixed", "name": "Florida Beach House Mortgage", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 18643, "frequency": "one-time" }, "original_value": { "value": 85000, "frequency": "one-time" }, "cost_value": { "value": 312, "frequency": "monthly" }, "interest": 4, "start_date": "2011-12-20 00:00:00", "end_date": "2020-07-28 00:00:00" }, { "id": "d6597da8-ffcd-4f08-ad33-74b9abbf047b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "auto", "name": "Yacht Loan ", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 42000, "frequency": "one-time" }, "original_value": { "value": 90000, "frequency": "one-time" }, "cost_value": { "value": 90, "frequency": "monthly" }, "interest": 6, "start_date": "2009-05-20 00:00:00", "end_date": "2021-07-21 00:00:00" } ] } } } } }, "post": { "tags": [ "POST", "Liability" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Liability", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Liability" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Liability" } } } } }, "/accounts/{accountId}/liabilities/{liabilityId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "liabilityId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Liability" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Liability" }, "examples": { "application/json": { "id": "6c775488-6285-4fa5-80cf-3fc19e517a05|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "credit-card", "name": "Richmond Golden Credit", "provider": null, "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "current_value": { "value": 31210, "frequency": "one-time" }, "original_value": null, "cost_value": { "value": 10, "frequency": "monthly" }, "interest": 6, "start_date": null, "end_date": null } } } } }, "put": { "tags": [ "PUT", "Liability" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Liability", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Liability" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Liability" }, "examples": { "application/json": { "id": "6c775488-6285-4fa5-80cf-3fc19e517a05|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "credit-card", "name": "Platinum credit card", "provider": "Bank of America", "owner": { "id": "2", "type": "client", "label": null }, "current_value": { "value": 2400, "frequency": "yearly" }, "original_value": { "value": 35000, "frequency": "yearly" }, "cost_value": { "value": 340, "frequency": "yearly" }, "interest": 6, "start_date": "2012-07-18 00:00:00", "end_date": "2017-03-11 00:00:00" } } } } }, "delete": { "tags": [ "DELETE", "Liability" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/expenses-fixed": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Expenses" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/ExpenseFixed" }, "examples": { "application/json": { "alimony": { "value": 110, "frequency": "monthly" }, "child_support": { "value": 0, "frequency": "monthly" }, "college": { "value": 0, "frequency": "monthly" }, "rent": { "value": 320, "frequency": "monthly" }, "auto_insurance": { "value": 49.9167, "frequency": "one-time" }, "disability_insurance": { "value": 741.6667, "frequency": "one-time" }, "eo_malpractice_insurance": { "value": 502, "frequency": "one-time" }, "health_insurance": { "value": 237.75, "frequency": "one-time" }, "homeowner_insurance": { "value": 104.1667, "frequency": "one-time" }, "life_insurance": { "value": 102.5, "frequency": "one-time" }, "long_term_care_insurance": { "value": 74.1667, "frequency": "one-time" }, "umbrella_insurance": { "value": 762, "frequency": "one-time" }, "other_insurance": { "value": 62.9167, "frequency": "one-time" }, "college_plan": { "value": 70, "frequency": "one-time" }, "retirement_plan": { "value": 1012, "frequency": "one-time" }, "annuity": { "value": 70, "frequency": "one-time" }, "credit_card": { "value": 10, "frequency": "one-time" }, "mortgage": { "value": 312, "frequency": "one-time" }, "loan": { "value": 90, "frequency": "one-time" }, "other": { "value": 0, "frequency": "monthly" } } } } } }, "put": { "tags": [ "PUT", "Expenses" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "ExpenseFixed", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseFixed" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/ExpenseFixed" }, "examples": { "application/json": { "alimony": { "value": 123, "frequency": "monthly" }, "child_support": { "value": 987, "frequency": "monthly" }, "college": { "value": 15, "frequency": "monthly" }, "rent": { "value": 110, "frequency": "monthly" }, "auto_insurance": { "value": 1, "frequency": "one-time" }, "disability_insurance": { "value": 1, "frequency": "one-time" }, "eo_malpractice_insurance": { "value": 1, "frequency": "one-time" }, "health_insurance": { "value": 1, "frequency": "one-time" }, "homeowner_insurance": { "value": 1, "frequency": "one-time" }, "life_insurance": { "value": 1, "frequency": "one-time" }, "long_term_care_insurance": { "value": 1, "frequency": "one-time" }, "umbrella_insurance": { "value": 1, "frequency": "one-time" }, "other_insurance": { "value": 1, "frequency": "one-time" }, "college_plan": { "value": 1, "frequency": "one-time" }, "retirement_plan": { "value": 1, "frequency": "one-time" }, "annuity": { "value": 1, "frequency": "one-time" }, "credit_card": { "value": 1, "frequency": "one-time" }, "mortgage": { "value": 1, "frequency": "one-time" }, "loan": { "value": 1, "frequency": "one-time" }, "other": { "value": 99, "frequency": "monthly" } } } } } } }, "/accounts/{accountId}/expenses-tax": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Expenses" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/ExpenseTax" }, "examples": { "application/json": { "federal_income": { "value": 5320, "frequency": "yearly" }, "state_income": { "value": 25000, "frequency": "yearly" }, "fica": { "value": 600, "frequency": "yearly" }, "real_estate": { "value": 480, "frequency": "yearly" }, "other": { "value": 0, "frequency": "yearly" } } } } } }, "put": { "tags": [ "PUT", "Expenses" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "ExpenseTax", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseTax" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/ExpenseTax" }, "examples": { "application/json": { "federal_income": { "value": 3360, "frequency": "yearly" }, "state_income": { "value": 31200, "frequency": "yearly" }, "fica": { "value": 4800, "frequency": "yearly" }, "real_estate": { "value": 10800, "frequency": "yearly" }, "other": { "value": 14400, "frequency": "yearly" } } } } } } }, "/accounts/{accountId}/expenses-variable": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Expenses" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ExpenseVariable" } } } }, "examples": { "application/json": { "items": [ { "id": "3e0a2045-6c9e-453f-b463-3e0158ec5370|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "value": { "value": 270, "frequency": "monthly" }, "type": "groceries" } ] } } } } }, "post": { "tags": [ "POST", "Expenses" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "ExpenseVariable", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseVariable" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/ExpenseVariable" } } } } }, "/accounts/{accountId}/expenses-variable/{expenseId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "expenseId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Expenses" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/ExpenseVariable" }, "examples": { "application/json": { "id": "3e0a2045-6c9e-453f-b463-3e0158ec5370|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "value": { "value": 270, "frequency": "monthly" }, "type": "groceries" } } } } }, "put": { "tags": [ "PUT", "Expenses" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "ExpenseVariable", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseVariable" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/ExpenseVariable" }, "examples": { "application/json": { "id": "3e0a2045-6c9e-453f-b463-3e0158ec5370|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "value": { "value": 590, "frequency": "monthly" }, "type": "pet-expenses" } } } } }, "delete": { "tags": [ "DELETE", "Expenses" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/goals": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Goals" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Goal" } } } }, "examples": { "application/json": { "items": [ { "id": "bd7511b8-0bd1-4280-8cd9-d1a53f7ee51c|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "full-time-retirement", "name": "Retirement", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": null, "frequency": null, "target": { "type": "age", "value": { "value": 32123, "frequency": "one-time" }, "start": "61.0000", "end": null } }, { "id": "4a891add-c03a-40ca-8b51-51f87101358d|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "travel", "name": "New Zealand Trip", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "low", "frequency": "one-time", "target": { "type": "year", "value": { "value": 250, "frequency": "yearly" }, "start": "2020", "end": null } }, { "id": "5411d299-b742-4717-8dcd-b21cf82745df|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "wedding", "name": "Wedding", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "medium", "frequency": null, "target": { "type": "year", "value": { "value": 4000, "frequency": "one-time" }, "start": "2029", "end": null } }, { "id": "b71a3204-a1ac-4f1b-913d-d51e2798145e|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "celebration", "name": "Wedding celebration", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "medium", "frequency": null, "target": { "type": "year", "value": { "value": 900, "frequency": "one-time" }, "start": "2029", "end": null } }, { "id": "7410ecd0-9ce3-4f5a-addb-4c1932a7dd65|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "college", "name": "College", "owner": null, "beneficiary": null, "priority": "medium", "frequency": null, "target": { "type": "year", "value": { "value": 4000, "frequency": "yearly" }, "start": "2020", "end": "2025" } }, { "id": "4952090f-a7ba-411e-a04c-eec098e8d627|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "private-school", "name": "Private School", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "medium", "frequency": null, "target": { "type": "year", "value": { "value": 500, "frequency": "yearly" }, "start": "2018", "end": "2022" } }, { "id": "3e21e9cf-e588-4146-8f5a-b6c1a9e20385|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "business", "name": "Richmond's workshop", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "medium", "frequency": null, "target": { "type": "year", "value": { "value": 8000, "frequency": "one-time" }, "start": "2026", "end": null } }, { "id": "830cfe35-6eee-4081-8329-0091c2f17f88|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "home", "name": "Jason's house", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "medium", "frequency": null, "target": { "type": "year", "value": { "value": 60000, "frequency": "one-time" }, "start": "2028", "end": null } }, { "id": "b6a9f2c0-3294-4a68-8fcf-a81244876b56|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "home-improvement", "name": "Florida Makeover", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "high", "frequency": null, "target": { "type": "year", "value": { "value": 1500, "frequency": "one-time" }, "start": "2018", "end": null } }, { "id": "8e3f130b-51d1-4c3a-8ee8-206a24039f69|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "purchase", "name": "Second Yacht ", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "low", "frequency": null, "target": { "type": "year", "value": { "value": 15000, "frequency": "one-time" }, "start": "2026", "end": null } }, { "id": "0c38c7f4-0d81-4d3f-849a-9b4ef499f021|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "care", "name": "Daphne's Care", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "medium", "frequency": null, "target": { "type": "year", "value": { "value": 190, "frequency": "yearly" }, "start": "2031", "end": "2036" } }, { "id": "55a5bb3e-45a6-45ef-827d-e486424e5bc7|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "donation", "name": "Church Donation", "owner": null, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": "high", "frequency": "monthly", "target": { "type": "year", "value": { "value": 50, "frequency": "yearly" }, "start": "2017", "end": null } }, { "id": "5ae6a723-9d1a-43e8-aa00-9cd18ef2b730|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "bequest", "name": "Richmond Bequest", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "beneficiary": null, "priority": null, "frequency": null, "target": { "type": "death", "value": { "value": 7000, "frequency": "one-time" }, "start": null, "end": null } } ] } } } } }, "post": { "tags": [ "POST", "Goals" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Goal", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Goal" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Goal" } } } } }, "/accounts/{accountId}/goals/{goalId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "goalId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Goals" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Goal" }, "examples": { "application/json": { "id": "bd7511b8-0bd1-4280-8cd9-d1a53f7ee51c|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "full-time-retirement", "name": "Retirement", "owner": { "id": null, "type": "client", "label": "Richmond Hertz" }, "beneficiary": { "id": null, "type": "client", "label": "Richmond Hertz" }, "priority": null, "frequency": null, "target": { "type": "age", "value": { "value": 32123, "frequency": "one-time" }, "start": "61.0000", "end": null } } } } } }, "put": { "tags": [ "PUT", "Goals" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Goal", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Goal" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Goal" } } } }, "delete": { "tags": [ "DELETE", "Goals" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/contacts": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Contacts" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Contact" } } } }, "examples": { "application/json": { "items": [ { "id": "010eb904-f196-4b0e-b936-dd5038fa1397|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "accountant", "first_name": "John", "last_name": "Accountant", "email": "johnaccount@precisefp.com", "phone": "+1 412451213", "company": "Accountants.us" }, { "id": "dcd12680-78a4-4e3a-b096-724c8564aaed|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "attorney", "first_name": "Tim", "last_name": "Torrney", "email": "timtorrney@precisefp.com", "phone": "+1 4124124123", "company": "Attorneysunited" }, { "id": "f93cea7f-41b0-4613-9490-d5710f8e6eef|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "broker", "first_name": "Ben", "last_name": "Broker", "email": "brokerben@precisefp.com", "phone": "+1 231262343", "company": "BestBroker.co" }, { "id": "0481622d-46b6-46dc-8f19-6df9ff7f67d2|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "insurance-agent", "first_name": "Artur", "last_name": "Agent", "email": "agentarthur@precisefp.com", "phone": "+1 414092312", "company": "PKO Insurances" }, { "id": "9bdd9869-5a49-4110-915f-1c9fcfecb8fd|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "tax-preparer", "first_name": "Peter", "last_name": "Preparer", "email": "peterpreparer@precisefp.com", "phone": "+1 231412123", "company": "TaxPreparersCalifornia" }, { "id": "ea482eac-e86c-4c5a-a3c1-29ec65904ace|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "other", "first_name": "Matt", "last_name": "Profal", "email": "mattprofal@precisefp.com", "phone": "+1 2412412312", "company": "Professionasforeveryone" } ] } } } } }, "post": { "tags": [ "POST", "Contacts" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Contact", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Contact" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Contact" } } } } }, "/accounts/{accountId}/contacts/{contactId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "contactId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Contacts" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Contact" } } } }, "put": { "tags": [ "PUT", "Contacts" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Contact", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Contact" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Contact" }, "examples": { "application/json": { "id": "010eb904-f196-4b0e-b936-dd5038fa1397|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "accountant", "first_name": "Janet", "last_name": "Jackson", "email": "jjacson@precisefp.com", "phone": "+1 4127445886", "company": "The Michaels" } } } } }, "delete": { "tags": [ "DELETE", "Contacts" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/accounts/{accountId}/documents": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Documents" ], "summary": "Get items", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "List of items", "schema": { "allOf": [ { "$ref": "#/definitions/ResponseList" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Document" } } } }, "examples": { "application/json": { "items": [ { "id": "7823bb87-3918-45af-ae69-87cfaa0e0e9c|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8wYWQ5OGQzNC1mZjMxLTQ1ODgtYWU2NC1hNjJiZjkwZGM2NTgiLCJuYW1lIjoiY29udGFjdC1pbmZvcm1hdGlvbl8wMi0yMC0yMDE3XzEyLTQ1LnhscyIsInNpemUiOjkyMTZ9", "filetype": "application/octet-stream", "filesize": 9216, "filename": "contact-information_02-20-2017_12-45.xls" }, "relation": null }, { "id": "be9e1ed9-cdba-4031-a6a1-ecdaee5d779a|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC84MjUwZWQzMy1jNzgxLTQ2OTAtODIyNi1mMWFjMTczZTVjYmIiLCJuYW1lIjoiQ2xpZW50dF9hZGRhc2RfMDItMjAtMjAxN18xMi00Ni00MC54bHMiLCJzaXplIjo0NjA4MH0", "filetype": "application/octet-stream", "filesize": 46080, "filename": "Clientt_addasd_02-20-2017_12-46-40.xls" }, "relation": { "id": "438464cd-07da-480e-9385-c6f2e9389caa|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "4abb03c6-e741-4e0a-9572-08a359826a68|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC82NmJkZDkyOC1mYmM5LTQ4ODctODAxYy1mZmIzNDQxZGRhMWUiLCJuYW1lIjoiYXJ0aWNsZXMuZG9jeCIsInNpemUiOjEwNDQwMTB9", "filetype": "application/octet-stream", "filesize": 1044010, "filename": "articles.docx" }, "relation": { "id": "115aca7a-9431-4450-89a2-297591f5208b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "d82b5293-bf8b-433d-9adb-cd6e04901b50|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC80NTQ1NjcwYi0xMjNiLTQ3MmEtYWYzOC03MDQ5MDQ5NjViN2UiLCJuYW1lIjoiYXJ0aWNsZXMuZG9jeCIsInNpemUiOjEwNDQwMTB9", "filetype": "application/octet-stream", "filesize": 1044010, "filename": "articles.docx" }, "relation": { "id": "606fa6c4-b22a-4d3b-a690-c5944ebe40d1|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "f39360b1-dc88-4ed8-9ba5-a3d9a1fdda0d|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC82NmE5MzRmZS0yYTFjLTQ3NjktYTBlNS1kYmE5ZWQ5NjcyYmEiLCJuYW1lIjoiYWJjZGVmXzAyLTIzLTIwMTdfMTEtMTMucGRmIiwic2l6ZSI6NDY0MzJ9", "filetype": "application/pdf", "filesize": 46432, "filename": "abcdef_02-23-2017_11-13.pdf" }, "relation": { "id": "01a9453b-0717-4966-9dc1-cf1b706c3556|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "e32382f2-42b2-4d56-8d41-af6e29a46cdc|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC85ZTcwMzBkYS02OWRiLTRiZTEtOWVmNy00MTAwMDRkZDkzMWQiLCJuYW1lIjoiRW50ZXJwcmlzZV8yMC0wMi0yMDE3LnhscyIsInNpemUiOjYwOTI4fQ", "filetype": "application/octet-stream", "filesize": 60928, "filename": "Enterprise_20-02-2017.xls" }, "relation": { "id": "c4812415-354b-4319-baf9-d96767fafdf0|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "4b3bd4a7-79f6-41d4-b6d8-6287c80585a5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC83OWVlOWRiOC0xYmRjLTQ4MzMtOWU0Yi0wNjBhMDA5YmI0MWMiLCJuYW1lIjoiYWJjZGVmXzAyLTIzLTIwMTdfMTEtMTMueGxzIiwic2l6ZSI6NDYwOH0", "filetype": "application/octet-stream", "filesize": 4608, "filename": "abcdef_02-23-2017_11-13.xls" }, "relation": { "id": "c1399433-86f8-49de-a1f0-91a4e37f0e2b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "81d47d18-582d-4770-bd9a-6ecd80559003|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC80OTU3YjIwMy1kNjU3LTRiZDAtOWQ1Yy0yNGU5YTc4ZTczZDciLCJuYW1lIjoiRW50ZXJwcmlzZV8yMC0wMi0yMDE3LnhscyIsInNpemUiOjYwOTI4fQ", "filetype": "application/octet-stream", "filesize": 60928, "filename": "Enterprise_20-02-2017.xls" }, "relation": { "id": "9d744475-f348-4d44-83da-b599ee761b08|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "3a16bc8e-f02c-4e7d-9dc9-be55601c647f|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC80ZmE0ZTlmMi1mZmRlLTQ5MTUtODA5My03N2JkZTI1YzAzMTMiLCJuYW1lIjoiUHJlY2lzZUZQXzIwLTAyLTIwMTcueGxzIiwic2l6ZSI6MjM2NTQ0fQ", "filetype": "application/octet-stream", "filesize": 236544, "filename": "PreciseFP_20-02-2017.xls" }, "relation": { "id": "f98dbcf6-d34b-48d7-a7f0-11b27b41e3ce|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "ba22b19d-19f7-4b5a-ae7b-1f779bbd8b06|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8yNTUyYzE2OC00YTQxLTQwYTItOTUyMS01NzQ3MjI1YzQwZmEiLCJuYW1lIjoidGVzdC1yZXBvcnQtbnIxXzAyLTE0LTIwMTdfMTItMDUgKDEpLnBkZiIsInNpemUiOjUzMzM5fQ", "filetype": "application/pdf", "filesize": 53339, "filename": "test-report-nr1_02-14-2017_12-05 (1).pdf" }, "relation": { "id": "7787d69b-1053-4a70-a7aa-19073f9c7d99|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Insurance", "label": null } }, { "id": "7478c3c8-024d-4671-bc1a-09952b8a2ea0|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC82ZjAwYzE0Zi0xMGFkLTQ5MzYtYjI0ZC01YWJhMWEzYjY1ODQiLCJuYW1lIjoiYWJjZGVmXzAyLTIzLTIwMTdfMTEtMTMuY3N2Iiwic2l6ZSI6MjI2fQ", "filetype": "application/octet-stream", "filesize": 226, "filename": "abcdef_02-23-2017_11-13.csv" }, "relation": { "id": "ddbbf2c5-0d98-4988-9924-91fe98e1537a|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "abd3a581-77bf-4780-83d0-6df4e7ad7f09|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9lOGU0MjBmOC1iMTliLTQ1YzktOGJkNy0wMjY3MjAxYWNmZTciLCJuYW1lIjoiQ2xpZW50dF9hZGRhc2RfMDItMjAtMjAxN18xMi00Ny00Ny54bHMiLCJzaXplIjo0NjA4MH0", "filetype": "application/octet-stream", "filesize": 46080, "filename": "Clientt_addasd_02-20-2017_12-47-47.xls" }, "relation": { "id": "7834b56f-78fa-45b6-9587-71153f45fc21|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "641f23ea-e45c-4561-9c4b-852235a55fbd|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8zOGM1ZWY5OS02YjgwLTRiNWEtYjNlZS04YmRhZjY1YzNiODciLCJuYW1lIjoidGVzdHRlc3RfcmF6ZHdhXzAzLTI5LTIwMTdfMDktMTEtNTcucGRmIiwic2l6ZSI6MTAxNDkyfQ", "filetype": "application/pdf", "filesize": 101492, "filename": "testtest_razdwa_03-29-2017_09-11-57.pdf" }, "relation": { "id": "c53d8dd9-11f6-4249-99d2-cdabcabc6c59|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "af24c67e-bac1-44b0-95eb-1eef9ff7113d|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9hMjg4Yzk3ZS02YjA0LTRkMzgtOWZiMi05NzY2NWRmOTQyN2EiLCJuYW1lIjoiYWJjX2RlZl8wNC0wNC0yMDE3XzEzLTQyLTAwLnhscyIsInNpemUiOjE5OTY4fQ", "filetype": "application/octet-stream", "filesize": 19968, "filename": "abc_def_04-04-2017_13-42-00.xls" }, "relation": { "id": "ea1e8707-a57c-40b2-98b4-7d9eeace3441|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "b784e5b7-94c3-4662-8562-842827a2a773|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8wYjBiZGNmOC01Y2ViLTQ0YjEtOTM1NS02NTRhOTYwZTEzMWEiLCJuYW1lIjoiQ2hyaXNfQ2hpY2tlbl8wMi0yMS0yMDE3XzE1LTIwLTIxLmNzdiIsInNpemUiOjMzMjAyfQ", "filetype": "application/octet-stream", "filesize": 33202, "filename": "Chris_Chicken_02-21-2017_15-20-21.csv" }, "relation": { "id": "4ed3d624-843c-49df-95bc-e5eba4f194b2|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "bf21d91e-317d-4d7b-9b22-3db840b70c2e|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC85ODkwMGI0OC0xMjIxLTRjYzMtYWVmNC1lZTM2MjlmM2IwMWQiLCJuYW1lIjoiQ2hyaXNfQ2hpY2tlbl8wMi0yMS0yMDE3XzE1LTIwLTMwLnhscyIsInNpemUiOjQ5NjY0fQ", "filetype": "application/octet-stream", "filesize": 49664, "filename": "Chris_Chicken_02-21-2017_15-20-30.xls" }, "relation": { "id": "f665537a-e774-4a41-aa97-28568edbb77a|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "3f39155d-359a-4c82-a1bd-8653d9d50d1f|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8wZDNmYWQ4NC1iYTYzLTRhZDgtODRkZC1kZGY1ODdlOGFjYzYiLCJuYW1lIjoiYXJ0aWNsZXMuZG9jeCIsInNpemUiOjEwNDQwMTB9", "filetype": "application/octet-stream", "filesize": 1044010, "filename": "articles.docx" }, "relation": { "id": "1f404cf7-ed5e-4ae7-90e5-705769aec2f5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "fb94af74-3fb2-4c60-8594-246c9f0c6f88|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8wYTQxZmRmYS04NzczLTRkZDMtOGVmNi01YjY5MmJlMjZiMGEiLCJuYW1lIjoiY29weS1vZi1jb3B5LW9mLWNvcHktb2YtYWFfMDItMjEtMjAxN18xNC00Ny5jc3YiLCJzaXplIjo0OTB9", "filetype": "application/octet-stream", "filesize": 490, "filename": "copy-of-copy-of-copy-of-aa_02-21-2017_14-47.csv" }, "relation": { "id": "d6449cd9-85cf-4b29-b720-bd3f8ff31492|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Annuity", "label": null } }, { "id": "08a186b2-fb47-46f8-b1d3-d4840799ca30|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC84NmFiNTczYS05Nzk4LTQwZDMtOTMzOC1lMzIyNzhkZmU2OTEiLCJuYW1lIjoiYWJjX2RlZl8wNC0wNC0yMDE3XzEzLTQyLTAwLnhscyIsInNpemUiOjE5OTY4fQ", "filetype": "application/octet-stream", "filesize": 19968, "filename": "abc_def_04-04-2017_13-42-00.xls" }, "relation": { "id": "d9ed7030-d766-41e2-bcd2-de0f507a128b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Taxable", "label": null } }, { "id": "3cd0e7b8-dd29-4359-8198-ffb0d584f8e6|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9hZTc1MWRlNi1hOTBmLTQyNmYtYjhmNC0yYTBmMjZmZWY5NzUiLCJuYW1lIjoiRW50ZXJwcmlzZV8yMC0wMi0yMDE3LnhscyIsInNpemUiOjYwOTI4fQ", "filetype": "application/octet-stream", "filesize": 60928, "filename": "Enterprise_20-02-2017.xls" }, "relation": { "id": "715adfb1-3b04-4729-b0d8-96a74a8cd355|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Plan", "label": null } }, { "id": "e63e7f67-5171-4f53-a563-c9b25f39cc0d|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9mYjlkYjAxNy0yY2Q0LTRiZmMtOGRiNy01YWZlOWEzYWNiMGYiLCJuYW1lIjoiY29udGFjdC1pbmZvcm1hdGlvbl8wMi0yMC0yMDE3XzEyLTQ3LnBkZiIsInNpemUiOjQ4ODc0fQ", "filetype": "application/pdf", "filesize": 48874, "filename": "contact-information_02-20-2017_12-47.pdf" }, "relation": { "id": "8aec83f8-7c54-41a8-a564-df253e2c07e5|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Annuity", "label": null } }, { "id": "f0f9e581-3711-49f3-927d-1025410423c3|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC84M2JlYTlmYi1jNGM2LTQ2ZmUtYTdjMC01OTI5ZDU0MTMxYTEiLCJuYW1lIjoiQ2xpZW50dF9hZGRhc2RfMDItMjAtMjAxN18xMi00Ni00MC54bHMiLCJzaXplIjo0NjA4MH0", "filetype": "application/octet-stream", "filesize": 46080, "filename": "Clientt_addasd_02-20-2017_12-46-40.xls" }, "relation": { "id": "70c8d880-62ed-45ac-9f3a-1a2551e271f9|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Liability", "label": null } }, { "id": "751973c9-e133-425b-88fe-eb4670c9f5d3|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9lOTM1YmMwYi00MGY3LTQxNDItYjIwYi1mODVkMzU2OGY2MmIiLCJuYW1lIjoiZmlsZSAoMSkueGxzIiwic2l6ZSI6MjM2NTQ0fQ", "filetype": "application/octet-stream", "filesize": 236544, "filename": "file (1).xls" }, "relation": { "id": "d6597da8-ffcd-4f08-ad33-74b9abbf047b|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "type": "Liability", "label": null } }, { "id": "a1eaa2e5-abd8-40f5-9733-7436b2be93cb|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC9jZTg2MzY4OS0wOTYwLTRjMzktYjI1Mi05MGMwODUzMTgxMmIiLCJuYW1lIjoiZmlsZSAoMSkueGxzIiwic2l6ZSI6MjM2NTQ0fQ", "filetype": "application/octet-stream", "filesize": 236544, "filename": "file (1).xls" }, "relation": { "id": null, "type": "ExpenseVariable", "label": null } } ] } } } } }, "post": { "tags": [ "POST", "Documents" ], "summary": "Create item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Document", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Document" } } ], "responses": { "200": { "description": "Item created", "schema": { "$ref": "#/definitions/Contact" } } } } }, "/accounts/{accountId}/documents/{documentId}": { "parameters": [ { "name": "accountId", "type": "integer", "in": "path", "required": true }, { "name": "documentId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Documents" ], "summary": "Get item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "200": { "description": "Item", "schema": { "$ref": "#/definitions/Document" }, "examples": { "application/json": { "id": "7823bb87-3918-45af-ae69-87cfaa0e0e9c|14fa1202-7cfc-461e-bf69-7a5a5b3b9bba", "file": { "type": "document", "url": "http://pfp.app:8000/api/accounts/5/files/eyJwYXRoIjoiY29tcGFueS0xXC9hY2NvdW50c1wvZGF0YVwvYWNjb3VudC01XC8wYWQ5OGQzNC1mZjMxLTQ1ODgtYWU2NC1hNjJiZjkwZGM2NTgiLCJuYW1lIjoiY29udGFjdC1pbmZvcm1hdGlvbl8wMi0yMC0yMDE3XzEyLTQ1LnhscyIsInNpemUiOjkyMTZ9", "filetype": "application/octet-stream", "filesize": 9216, "filename": "contact-information_02-20-2017_12-45.xls" }, "relation": null } } } } }, "put": { "tags": [ "PUT", "Documents" ], "summary": "Update item", "security": [ { "Oauth": [ "accounts" ] } ], "parameters": [ { "name": "Document", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Document" } } ], "responses": { "200": { "description": "Item updated", "schema": { "$ref": "#/definitions/Document" } } } }, "delete": { "tags": [ "DELETE", "Documents" ], "summary": "Remove item", "security": [ { "Oauth": [ "accounts" ] } ], "responses": { "204": { "description": "Item removed" } } } }, "/user": { "get": { "tags": [ "GET", "Users" ], "summary": "Returns basic information about user based on Authentication", "security": [ { "Oauth": [ "users" ] } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AuthenticatedUser" }, "examples": { "application/json": { "first_name": "Marcin", "last_name": "Limont", "email": "m.limont@precisefp.com", "phone": "+48 695813333 ", "photo": null, "company": "mlimont", "company_name": null, "company_email": "m.limont@precisefp.com", "company_phone": "+48 695813333", "company_logo": null } } } } } }, "/define/{entity}/{entityId}": { "parameters": [ { "name": "entity", "type": "string", "in": "path", "required": true }, { "name": "entityId", "type": "string", "in": "path", "required": true } ], "get": { "tags": [ "GET", "Entities" ], "summary": "Returns information about the entity", "security": [ { "Oauth": [ "users" ] } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Entity" }, "examples": { "application/json": null } } } } }, "/signin-token": { "get": { "summary": "Login token", "security": [ { "Oauth": [ "login" ] } ], "description": "Returns login token", "responses": { "200": { "description": "Status info", "schema": { "$ref": "#/definitions/Token" } } } } } } }