Team Data API (v1)

Retrieve a single instance of model with the given uuid or external_id+team_uuid.

• model: The name of the model to search for the instance.
• uuid: The UUID of the instance to retrieve. Optional if external_id is provided.
• external_id: The External ID of the instance to retrieve. Not used if uuid is provided.
• fetch_details: Fetch detail records if true. Defaults to false.
• detail_models: Deprecated. Use include_models instead.
• include_models: Comma separated related model names to fetch, or empty string to fetch all. Only used if fetch_details is true.
• exclude_models: Optional comma separated related model names to exclude.
• team_uuid: The team_uuid of the instance to retrieve. Required if external_id is specified.
• active_only: Retrieve active (i.e. not soft-deleted) instances only. Defaults to True.
• include_nulls: If False, strips null and empty values from the response. Defaults to True.

Deletes a list of UUIDs of a given model.

Retrieve multiple instances of multiple models as defined in the payload. Works like a batch version of the GET /resources endpoint.

• payload: A list of dicts with the keys model, uuid, external_id, and team_uuid.
• active_only: Only return active (i.e. not soft-deleted) instances. Defaults to True.
• include_nulls: If False, strips null and empty values from the response. Defaults to True.
• simplified: If True, returns a simplified (flat) response. Defaults to False.

Retrieve multiple instances of multiple models as defined in the payload. Works like a batch version of the GET /resources endpoint.

• payload: A search query as described by SearchQuerySchema.
• active_only: Only return active (i.e. not soft-deleted) instances. Defaults to True.
• team_agnostic: If True, ignores the x-team header and returns instances from all teams.
• flat: If True, returns a list of flat (not nested) dicts.

Attempt to find records based on a uuid or external_id+team_uuid and update them if found, or create new records if not. This endpoint can be used to update/create multiple objects of multiple, unrelated models.

• payload.data: A list of dicts with the keys model, uuid, external_id, team_uuid, and data.
• payload.batch: If True then the operation may be queued by the endpoint. :return: Either a list of the updated/created objects, or a task_id if the operation was queued.

Check for existing duplicates of the resource list passed in the payload. This endpoint uses the same payload format as the update_or_create endpoint, but it doesn't actually create any records. :return: A list of lists, where the inner list is the duplicates found (if any).

Check for existing duplicates of the resource list passed in the payload. This endpoint uses the same payload format as the update_or_create endpoint, but it doesn't actually create any records. :return: A list of lists, where the inner list is the duplicates found (if any).

Finds a model instance using a uuid or external_id, and makes copy of it for each item in the payload.

• payload.data: A list of dicts with the keys model and data. :return: The list of duplicated instances.

Finds model instances using a uuid or external_id, and converts them to a different module and/or submodule.

• payload.data: A list of dicts with the keys model and data. :return: The list of converted instances.

Transform models between module/submodules with specific rules

Move transactions between teams

Gets a list of model UUIDs and fires "button" events for all. :return: The list of succeeded and failed UUIDs.

For a given Transaction and date_issued string (YYYY-MM-DD), return the due_date calculated, based on the Customer's or Supplier's payment terms - based on the transaction's module and submodule.

It is assumed that conversion to the Team Data UUID that encodes the model has been done by the caller, for sake of implementation simplicity at this time.

Attach a file to a specific model and uuid.

Find a file by its SHA1 digest and the team that owns it. Note that this endpoint only concerns itself with files that: for extraction, - are set for_extraction=True - Belong to the Team specified in the x-team header

have a status not set to "DELETED" and have no value for deleted_at, as we want to detect and prevent duplicates.

Request the full S3 path for a file, when supplied with the File's UUID.

Request the full, signed S3 path for a file, when supplied with the File's UUID.

Request the full, signed S3 path for a file, when supplied with the File's UUID. Redirects to the signed S3 URL to initiate the download.

Create a new Inbox for the specified Team.

Send an email from an Inbox. The email sending API requires a valid Inbox UUID to be used.

Trigger the logic to query Postmark for the verification status of all custom send domains and update the CustomSendDomain objects in the database, as appropriate.