DOCSEARCHbyAlgolia
Submit Docs

Zinancial API

website·Indexed 29 days ago

https://zinancial-api-doc.vercel.app

API documentation for Zinancial, providing a consistent interface to query account data and create transactions. The API includes custom module capabilities for managing global templates, sections, and fields, as well as endpoints for fetching dynamic dropdown values.

Tokens
4.8K
Snippets
28
Records
41
Agent score
74%

What's inside Zinancial

  2. Retrieve detailed information about a template

    Use the GET /v2/global/template-details/{template_id} endpoint to fetch comprehensive details about a specific template. This includes the template ID, a list of sections, and the specific input fields (including their IDs, names, and types) within each section. This API requires a valid JWT token for authentication via the Authorization header.
    curl --location 'https://prodnode.unizooks.com/v2/global/template-details/505c631b-826c-11f0-b592-bc2411f4d589' \
--header 'Authorization: Bearer <JWT_TOKEN>'

  3. Limit blog post preview size using truncate comments

    To limit the amount of content displayed for a blog post in the list view, insert a <!-- truncate --> comment within the post content. Content following this comment will be hidden in the summary view.
    This text will appear in the list view summary.

<!-- truncate -->

This text will only be visible on the full blog post page.

  5. Configure Field API request parameters

    The Field API uses the following parameters in the request body. Note that requirements differ between creation and updates.
    {
  "id": "string",               // Required for update; UUID of the field
  "field_label": "string",      // Required; Display name of the field
  "field_type": "string",       // Required for create; e.g., 'text', 'number', 'dropdown'
  "description": "string",      // Optional; Field description
  "section_id": "string",       // Required for create; Section UUID where field belongs
  "dropdown_options": "array",  // Required for create; List of {value, color} objects
  "meta": "object"               // Optional; Flexible storage for custom data (no validation)
}

  6. Manage blog posts in Docusaurus

    Docusaurus blogging features are powered by the @docusaurus/plugin-content-blog plugin. To create blog posts, add Markdown files or folders to the blog directory. Post dates can be automatically extracted from filenames using the format YYYY-MM-DD-title.md or by placing an index.md inside a folder named YYYY-MM-DD-title. Using a folder for each post is recommended for co-locating images with the post content. Authors can be managed globally in the authors.yml file.
    # Example filename for date extraction
2019-05-30-welcome.md

  7. Create interactive blog posts using MDX in Docusaurus

    Docusaurus blog posts support MDX, allowing the use of React components and JSX directly within markdown files to create interactive content.
    <button onClick={() => alert('button clicked!')}>Click me!</button>

  8. Disable the blog in Docusaurus

    To completely remove the blog functionality from a Docusaurus site, delete the blog directory and set the blog configuration option to false in the Docusaurus config file.
    // docusaurus.config.js
module.exports = {
  // ...
  blog: false,
};

  9. Configure the Deploy Template API request

    The Deploy Template API requires the following configuration:

    Endpoint: POST https://prodnode.unizooks.com/v2/global/deploy-template

    Required Headers:

    • Content-Type: application/json
    • Authorization: Bearer <JWT_TOKEN>

    Request Body Parameters:

    • id (string, Required): The unique identifier (UUID) of the template to deploy.

    Expected Responses:

    • 200 OK: Template deployed successfully ({"status": true, "message": "Template deployed successfully"}).
    • 400 Bad Request: Invalid request body, typically missing the id field.
    • 401 Unauthorized: Invalid or expired authentication token.

  10. Create a new input field

    Use the POST /v2/global/field?key=u2_core endpoint to create a new input field within a specific section. You must provide the section_id and the field's basic configuration. The meta object allows for flexible, unvalidated custom data storage.
    curl --location 'https://prodnode.unizooks.com/v2/global/field?key=u2_core' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_TOKEN>' \
--data '{
  "field_label":"field 3",
  "field_type":"number",
  "description":"qwerty",
  "section_id":"8498a26d-8323-11f0-b592-bc2411f4d589",
  "dropdown_options":[{"value":"test12","color":"567473"},{"value":"test22","color":"#bebebe"}],
  "meta":{"placeholder":"Enter number","is_required":true}
}'

  11. Retrieve all reusable global templates

    Use the GET /v2/global/template endpoint to fetch a list of all reusable global templates available in the system. This request requires a valid JWT token passed in the Authorization header.
    curl --location 'https://prodnode.unizooks.com/v2/global/template' \
--header 'Authorization: Bearer <JWT_TOKEN>'

  12. Understand the response for Get All Sections of a Template

    The API returns a JSON response indicating the status and a list of section objects.

    Success (200 OK): Returns a status: true and a data array containing section objects with the following properties:

    • id: UUID of the section
    • section_name: Name of the section
    • template_id: UUID of the parent template
    • meta: Metadata object (e.g., containing order)
    • is_active: Integer indicating active status
    • created_at: ISO 8601 timestamp

    Error (401 Unauthorized): Returns success: false and a message if the token is invalid or expired.

    {
  "status": true,
  "data": [
    {
      "id": "965f2707-8323-11f0-b592-bc2411f4d589",
      "section_name": "Section 1",
      "template_id": "505c631b-826c-11f0-b592-bc2411f4d589",
      "meta": {},
      "is_active": 1,
      "created_at": "2025-09-09T12:34:56Z"
    }
  ]
}