The Manage API allows developers to interact programmatically with its services, facilitating operations like searching, managing organizational data, and more. This document details the endpoints available, their required inputs, and the responses they generate.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8801152","collectionId":"01b19c04-3865-4c4b-83ba-54db834eb1cd","publishedId":"2sA3e2gpdm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-24T19:55:46.000Z"},"item":[{"name":"Login","id":"f9b784e1-c668-4f71-9599-207ce7eea100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"{{username}}\",\n \"password\": \"{{password}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.momentpath.com/api/v2/login","description":"Description: The login endpoint facilitates the authentication process by accepting user credentials (username and password) and returning a session token upon successful authentication. This token is essential for maintaining a secure session, allowing the user to access protected resources within the API without needing to re-enter credentials for each request.
\nUsage:
This endpoint is typically the first point of interaction for users when they access an application requiring authentication. It is used to:
• Authenticate users by verifying their credentials against the database.
• Issue a session token that is required for accessing other secured endpoints within the API.
Example Request -
\nExample Response -
\nDescription:
The refresh token endpoint is designed to extend the validity of an existing session by issuing a new access token. This process uses a refresh token that is typically provided to the user alongside the access token at the initial login.
Usage:
This endpoint is used to:
• Obtain a new access token when the current token is about to expire without requiring the user to manually re-authenticate.
• Maintain user sessions over extended periods of activity, ensuring users do not have to frequently log in to the application.
Example Request -
\nExample Response-
\nDescription:
The endpoint is used to retrieve a list of all organizations managed within the system. This endpoint is particularly useful for administrators and managers who need to oversee multiple organizations or need a comprehensive view of all the organizations under their organization.
It allows users to access essential details about each organization, such as their names, IDs, and locations.
\nExample Request -
\nExample Response-
\nDescription:
\nThe Discounts endpoint provides access to a comprehensive list of discount currently active or available within an organization. It can include details about the discount rate, applicable conditions, duration, and the specific services or products they apply to.
\nUsage:
This endpoint is utilized to:
• Provide administrators with the ability to view, verify, and manage discounts being offered to ensure they align with the organization’s financial and marketing goals.
• Enable customer service representatives and sales teams to inform potential customers about available discounts and promotions.
Utilizing the Discounts endpoint provides users with a comprehensive overview of all available discounts within the organization.
\n","urlObject":{"path":["api","v2","discounts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2375e2d6-307c-4f6e-8ce4-81dad77fb822","name":"Discounts","originalRequest":{"method":"GET","header":[],"url":"{{url}}/api/v2/discounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"x-total-count","value":"28"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"date","value":"Thu, 16 Nov 2023 17:04:25 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n [\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"advancedTuition\",\n \"description\": \"Advanced Tuition\",\n \"ledger_code\": \"1234\",\n \"override_single_discount_rule\": true,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"customerSpecific\",\n \"description\": \"Customer-Specific\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"DepositApplication\",\n \"description\": \"DepositApplication\",\n \"ledger_code\": \"2081\",\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 350,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"multipleFamily\",\n \"description\": \"Multiple Family \",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"other\",\n \"description\": \"Other\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"parishionerRate\",\n \"description\": \"Parishioner Rate\",\n \"ledger_code\": \"1111\",\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 50,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": true\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"scholarship\",\n \"description\": \"Scholarship\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"siblingDiscount\",\n \"description\": \"Sibling Discount\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 15,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"staffDiscount\",\n \"description\": \"Staff Discount\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 75,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"142-Mariposa Southside\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"zoneDiscount\",\n \"description\": \"ZoneDiscount\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 1,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"advancedTuition\",\n \"description\": \"Advanced Tuition\",\n \"ledger_code\": \"1234\",\n \"override_single_discount_rule\": true,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": true,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"DepositApplication\",\n \"description\": \"DepositApplication\",\n \"ledger_code\": \"2081\",\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 350,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"districtDiscount\",\n \"description\": \"District Employee Discount\",\n \"ledger_code\": \"5555\",\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 50,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"multipleFamily\",\n \"description\": \"Multiple Family \",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"other\",\n \"description\": \"Other\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"parishionerRate\",\n \"description\": \"Parishioner Rate\",\n \"ledger_code\": \"1111\",\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 50,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": true\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"scholarship\",\n \"description\": \"Scholarship\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"staffDiscount\",\n \"description\": \"Staff Discount\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 75,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"321-Mariposa Local\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"zoneDiscount\",\n \"description\": \"ZoneDiscount\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 1,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"advancedTuition\",\n \"description\": \"Advanced Tuition\",\n \"ledger_code\": \"1234\",\n \"override_single_discount_rule\": true,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"blah\",\n \"description\": \"blah blah\",\n \"ledger_code\": \"875\",\n \"override_single_discount_rule\": true,\n \"expires_with_grace_period\": true,\n \"amount\": 100,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": true\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"DepositApplication\",\n \"description\": \"DepositApplication\",\n \"ledger_code\": \"2081\",\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 350,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"multipleFamily\",\n \"description\": \"Multiple Family \",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"other\",\n \"description\": \"Other\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"parishionerRate\",\n \"description\": \"Parishioner Rate\",\n \"ledger_code\": \"1111\",\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 50,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": true\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"scholarship\",\n \"description\": \"Scholarship\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": null,\n \"is_archived\": false,\n \"is_dollar_amount\": false,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"staffDiscount\",\n \"description\": \"Staff Discount\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 75,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n },\n {\n \"org\": {\n \"id\": \"GtAoTHqGeLk9BR8iw\",\n \"values\": {\n \"name\": \"Mariposa Corporate\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/GtAoTHqGeLk9BR8iw\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"code\": \"zoneDiscount\",\n \"description\": \"ZoneDiscount\",\n \"ledger_code\": null,\n \"override_single_discount_rule\": false,\n \"expires_with_grace_period\": false,\n \"amount\": 1,\n \"is_archived\": false,\n \"is_dollar_amount\": true,\n \"is_percentage_amount\": false\n }\n ]\n]"}],"_postman_id":"664c4162-90d9-4336-9ac3-f787434097b7"},{"name":"Invoices","id":"c6573f72-f9f4-409d-a7f5-2c4bdc36ee1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{url}}/api/v2/invoices","description":"Description:
\nThe Invoices endpoint allows users to access detailed information about invoices generated for services rendered or goods sold by the organization. It supports extensive filtering options, such as date ranges, invoice status, or specific client identifiers, to help users efficiently manage and track financial transactions.
\nUsage:
\nThis endpoint is primarily used to:
• Retrieve detailed lists of invoices for accounting and auditing purposes, helping ensure financial compliance and transparency.
• Support financial analysis and forecasting by providing access to comprehensive historical data on receivables.
Properties:
- id (string): Unique identifier for the invoice.
- orgId (string): Identifier for the organization to which the invoice belongs.
- amount (number): Total amount billed in the invoice.
- dueDate (date): The date by which the invoice should be paid.
- issuedDate (date): The date on which the invoice was issued.
- status (string): Current status of the invoice (e.g., \"paid\", \"unpaid\", \"overdue\").
Example Request -
\nExample Response -
\nDescription:
\nThe Moments endpoint allows users to access records of specific events or activities logged in the system. This endpoint typically supports various query parameters that can refine the results based on, type, involved individuals, or other relevant criteria.
\nUsage:
This endpoint is utilized to:
• Document and retrieve key activities or interactions, providing a historical record of important events.
• Enhance communication and coordination within the organization by keeping relevant personnel informed about significant occurrences.
• Support compliance and reporting needs by providing detailed logs of activities that can be reviewed and audited.
Retrive moments from mongo collection Moments.
\nDefault it will provide max 100 items with provided parameters.
\nParameters -
\norg_id
moment_date_start
moment_date_end
moment_type
Requirements -
\nYou need access to an org to make this API call.
\nExample Request -
\nExample Response -
\nUser orgId | default - orgId from user profile
\n","type":"text/plain"},"key":"org_id","value":"NpC5WCFSP6tbxpo4t"},{"disabled":true,"description":{"content":"moment date in MM/DD/YYYY format
\n","type":"text/plain"},"key":"moment_date_start","value":"3/31/2022"},{"disabled":true,"description":{"content":"moment date in MM/DD/YYYY format
\n","type":"text/plain"},"key":"moment_date_end","value":"3/31/2022"},{"disabled":true,"key":"moment_type","value":"checkin"},{"disabled":true,"description":{"content":"min 0 to max 100 | default - 100
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"min 0 | default - 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"if provided limit and offset will not be considered
\n","type":"text/plain"},"key":"no_pagination","value":"true"}],"variable":[]}},"response":[],"_postman_id":"88114d88-e35c-4ece-8195-af93dcbd646e"},{"name":"People","id":"6bde3b6f-ef26-41a8-83bd-40fa4631ecc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{url}}/api/v2/people/XQecPMyaMEwQmwRdc","description":"The People endpoint facilitates the retrieval of comprehensive details about people registered within the system. This can include information such as personal details, contact information, roles, and affiliations with specific departments or functions within the organization. The endpoint supports various filtering and sorting options to efficiently manage large datasets and retrieve specific subsets of data based on given criteria.
\nUsage:
\nThis endpoint is used to:
• Access and display detailed lists of individuals for administrative purposes.
• Support search and reporting functionalities by allowing queries based on attributes.
• Enhance operational processes by providing easy access to contact details and critical personal information necessary for communication and coordination.
Example Request -
\nExample Response -
\nmin 0 to max 100 | default - 100
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"min 0 | default - 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"if provided limit and offset will not be considered
\n","type":"text/plain"},"key":"no_pagination","value":"true"}],"variable":[]}},"response":[],"_postman_id":"6bde3b6f-ef26-41a8-83bd-40fa4631ecc2"},{"name":"Payouts","id":"cac542ec-e7dc-4f96-aed7-6e21148e7f8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{url}}/api/v2/payouts","description":"Description: Accesses payout records, typically used in contexts where financial transactions or compensations need to be tracked and managed effectively.
\nThis response provides details about each payout processed within the specified date range. Each payout record includes an identifier, the payout amount, the recipient's name, the date of the transaction, the current status of the payout, and the method used for the payment. This information is crucial for managing the financial operations of the organization and ensuring that all transactions are properly accounted for and audited.
\nRetrive payouts from mongo collection AdyenPayouts.
\nDefault it will provide max 100 items with provided parameters.
\nParameters -
\norg_id
date_start
date_end
Requirements -
\nYou need access to an org to make this API call.
\nExample Request -
\nExample Response -
\nResponse Header:
\nx-total-count: 2
\nResponse Body:
\nUser orgId | default - orgId from user profile
\n","type":"text/plain"},"key":"org_id","value":"NpC5WCFSP6tbxpo4t"},{"disabled":true,"description":{"content":"payout date in MM/DD/YYYY format
\n","type":"text/plain"},"key":"date_start","value":"3/05/2023"},{"disabled":true,"description":{"content":"payout date in MM/DD/YYYY format
\n","type":"text/plain"},"key":"date_end","value":"3/31/2023"},{"disabled":true,"description":{"content":"min 0 to max 100 | default - 100
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"min 0 | default - 0
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"if provided limit and offset will not be considered
\n","type":"text/plain"},"key":"no_pagination","value":"true"}],"variable":[]}},"response":[],"_postman_id":"cac542ec-e7dc-4f96-aed7-6e21148e7f8c"},{"name":"Schedules","event":[{"listen":"prerequest","script":{"id":"45245024-e535-4a79-a5e9-39b79e2a4101","exec":[""],"type":"text/javascript","packages":{}}}],"id":"47458458-c67e-4c93-b05c-5b26595e6ceb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{url}}/api/v2/person/gqiQJY4cyfv6fszNH/schedules","description":"Description:
The \"Schedule\" endpoint is designed to manage and retrieve detailed information about a child's schedule.
Features:
Flexible Querying: Supports various query parameters to fetch schedules by date, type, entity involved, and other relevant filters.
Usage:
Retrieve schedules for available resources over a specified period.
Example Request-
\nExample Response -
\nThe \"Transactions\" endpoint is designed to retrieve financial transaction records within an organization. It offers comprehensive details about each transaction, including amounts, dates, involved parties, and descriptions. This endpoint is vital for financial management and auditing purposes, allowing users to track and analyze all monetary movements in the system.
\nFeatures:
Comprehensive Data Retrieval: Provides detailed information about each transaction, including the transaction ID, amount, date,and associated account details.
Usage:
Obtain a historical record of all financial transactions for accounting and auditing.
Monitor incoming and outgoing payments to manage cash flow effectively.
Example Request -
\nExample Response -
\nProperties:
\nid (string): A unique identifier for the user.
username (string): The user's login name.
email (string): The user's email address.
firstName (string): User's first name.
lastName (string): User's last name.
role (string): The role or permission level assigned to the user.
createdAt (date): Timestamp when the user was created.
updatedAt (date): Timestamp when the user was last updated.
Example Request -
\nExample Response -
\nDescription:
The endpoint is designed to retrieve a list of user accounts within the system. This endpoint is primarily used for administrative purposes, allowing authorized personnel to access and manage user profiles, including their roles, permissions, and status within the organization.
This endpoint can be crucial for operations such as user audits, access control adjustments, and general user management tasks.
\nThe GET method on this endpoint usually supports various query parameters to filter, sort, and paginate through the list of users, making it adaptable for different administrative needs. For example, it may allow filtering users by status (active, inactive), roles (admin, user), or specific attributes like department or last login date.
\nThis request would typically return a list of active users, limited to 10 users per page, starting from the first record.
\nThis endpoint is essential for maintaining an effective user management system, ensuring that only authorized personnel can view and manage sensitive user information.
\n","urlObject":{"path":["api","v2","users"],"host":["{{url}}"],"query":[{"disabled":true,"key":"org_id","value":""}],"variable":[]}},"response":[{"id":"618bb156-3800-4a88-8888-75e6fff884f7","name":"Users","originalRequest":{"method":"GET","header":[],"url":"{{url}}/api/v2/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"x-total-count","value":"31"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"date","value":"Mon, 06 Nov 2023 22:27:26 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"h35ejdSwb5Z7Nzack\",\n \"email\": \"user1@testemail.com\",\n \"person\": {\n \"id\": \"RYetWpMJhsC3BcPjE\",\n \"values\": {\n \"name\": \"FirstName LastName\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/people/RYetWpMJhsC3BcPjE\",\n \"rel\": \"person\",\n \"type\": \"GET\"\n }\n ]\n },\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"Organization Name\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n },\n \"created_at\": \"2022-09-23T15:29:34.378Z\",\n \"is_pending\": false,\n \"memberships\": [\n {\n \"person\": {\n \"id\": \"RYetWpMJhsC3BcPjE\",\n \"values\": {\n \"name\": \"FirstName LastName\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/people/RYetWpMJhsC3BcPjE\",\n \"rel\": \"person\",\n \"type\": \"GET\"\n }\n ]\n },\n \"org\": {\n \"id\": \"nTvbx24M2dbM9w6tu\",\n \"values\": {\n \"name\": \"Organization Name\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/nTvbx24M2dbM9w6tu\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n }\n },\n {\n \"person\": {\n \"id\": \"aQBJrWaqYqxMBWrrB\",\n \"values\": {\n \"name\": \"Member Name\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/people/aQBJrWaqYqxMBWrrB\",\n \"rel\": \"person\",\n \"type\": \"GET\"\n }\n ]\n },\n \"org\": {\n \"id\": \"AsfEDAaFTAeCCJMLy\",\n \"values\": {\n \"name\": \"Organization 2 Name\"\n },\n \"links\": [\n {\n \"href\": \"/api/v2/orgs/AsfEDAaFTAeCCJMLy\",\n \"rel\": \"org\",\n \"type\": \"GET\"\n }\n ]\n }\n }\n ]\n }\n]"}],"_postman_id":"6bd59aea-1351-4652-8f5a-1cffd33e18a1"},{"name":"Billing Plan for org","id":"da1930e1-c03f-4d88-961a-bb3bd32111b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{URL}}//api/v2/orgs/:org_id/billing/plans/:id","description":"Retrive moments from mongo collection Moments.
\nDefault it will provide max 100 items with provided parameters.
\nThe endpoint is designed to retrieve the billing plan details associated with a specific organization, identified by the orgId. This endpoint is crucial for administrators and financial officers within the organization who need to access detailed information regarding their billing status, plan details, and payment history.
This endpoint provides insights into the type of billing plan the organization is enrolled in, the features included in the plan, the cost, payment methods, and the history of payments made under this plan. It's an essential tool for managing financial aspects of the organization, ensuring transparency, and aiding in financial planning and budgeting.
This request would typically return detailed billing information for the organization with the entered ID, helping administrators understand and manage their financial obligations effectively.
\nExample Request -
\nExample Response -
\nDescription:
The Classrooms endpoint provides comprehensive data about classrooms, which can include details like classroom names, capacities, associated teachers, and the age groups they serve. This endpoint is crucial for administrators and educators who need to manage or reference classroom-specific information efficiently.
Usage:
This endpoint is utilized to:
• Retrieve a list of all classrooms within a specified organization, or filter to specific classrooms based on given criteria such as location, capacity, or active status.
• Support administrative tasks such as scheduling, resource allocation, and classroom assignments.
• Enhance educational planning by providing quick access to classroom details necessary for decision-making processes.
Parameters:
• org_id: A mandatory parameter that specifies the organization ID to retrieve classrooms for. This helps in fetching relevant classroom information tailored to the user’s organizational context.
Example Request -
\nExample Response -
\nThe \"Child Billing Plan\" endpoint retrieves detailed information regarding the billing arrangements for a specific child, identified by child Id. This includes the type of plan the child is enrolled in, the cost, any applicable discounts, features of the plan, payment history, and upcoming payment details.
\nFeatures:
Detailed Billing Information: Provides comprehensive details on the child’s current billing plan.
Usage:
Assist administrators in providing detailed billing information to clients, ensuring transparency and accountability.
Support financial operations within institutions by streamlining access to billing data.
Retrive child billing plan.
\nDefault it will provide max 100 items with provided parameters.
\nParameters -
\nid (personId)
\nExample Request -
\nExample Response -
\nResponse Header:
\nx-total-count: 1
\nSample Response Body:
\n