Use Templates for Data Import & Export

Comprehensive guide to interact with data from a subscription document

What is a template?

A template includes the list of all fields available to import and export investor data in the Anduin Fund Subscription workflow. Anduin is equipped to assist each customer in seamlessly utilizing their templates across both applications and API calls.

Template components

  • id: each template has a unique ID assigned by the system
  • name: template name assigned by Anduin admin
  • type: import for importing data and export for exporting data
  • field: list of fields
  • fileID: a system-generated ID for the template file

Import data using a template

API clients can get the list of available templates through GraphQL. They can include the templateId and raw data in JSON format [key, value] when they call the 2 following API endpoints to create new orders with pre-filled data for an investor:

  • To create a single order: api/v1/fundsub/{fund-Id}/orders
  • To create multiple orders: api/v1/fundsub/{fund-Id}/async/bulk/orders

Users can also specify whether they want to create either a Normal or an Offline order.

Note:

  • Keys have to match one of the data field names in the template.
  • A call can only contain a maximum of 200 orders.
  • The API call to create and import data can either be synchronous or asynchronous.

Export data using a template

API clients retrieve the list of available templates and the list of orders to export using GraphQL. They must include the templateId and orderID when they call the API endpoint to export form data GET /api/v1/fundsub/{fund-id}/orders/formData. The output will be in JSON format including [key, value].