These docs are for v1.0. Click to read the latest docs for v2.0.

The Test Enterprise API now supports OAuth2 server-to-server authentication, enabling secure communication using the Client Credentials and JWT Bearer flows.

Added

The Zylo Enterprise API now supports OAuth2 authentication via Client Credentials and JWT Bearer flows.

Client Credentials

Use the Client Credentials flow for server-to-server authentication without user involvement. Learn how to implement it in our Client Credentials Guide.

JWT Bearer

For communication requiring assertion-based authentication, the JWT Bearer flow is now available. See the JWT Bearer Guide for details.

The Integration and Usage Connect resources were added to the Enterprise API. Users can now get a list of their integrations, usage connect import jobs, and upload data via Usage Connect.

Added

Integration

Get Integrations

  • An endpoint to get "Integrations" from your Zylo instance. This only includes the metadata for the Integrations (does not include user data, see "Application Users").

Get Integration by Id

  • An endpoint to retrieve a single "Integration" by its id. This only includes the metadata for the Integration (does not include user data, see "Application Users").

Usage Connect

Get Import Jobs

  • An endpoint to retrieve all "Usage Connect" import jobs for your Zylo instance.

Create an Import Job

  • An endpoint to retrieve the required credentials needed to upload application data via "Usage Connect".
  • For a detailed explanation on how this endpoint functions, check out the "Import App Data" guide.

Adds GET endpoints for Zylo Users, Views, and Zylo Users / Applications related to a View.

Added

Zylo Users

  • Handles GET requests to retrieve Zylo Users associated with a Zylo instance.

Views

  • Handles GET requests to retrieve all Views.
  • Handles retrieving individual Zylo Users associated to a View.
  • Handles retrieving individual Applications associated to a View.

Enhancements have been made to the Payments resource to make it easier to associate suppliers to their payments.

Improved

Payments

  • Two new fields, supplier_id and supplier_name have been added to the GET response.

There has been an update to the zylo_modified_at field which is on every resource.

Improved

The zylo_modified_at field will default to the zylo_created_at value if it is null.

This ensures that users can retrieve only new or updated resources by filtering with zylo_modified_at.

Additional functionality for GET requests filters involving arrays to specify matching on all of the values instead of any of the values.

Added

Entire array filtering and negative entire array filtering

Entire Array Filtering

By default when filtering an array field, the records will be returned that match any of the provided values. It is possible to specify a filter value that needs to match the entire array by wrapping the values in [ ]

Example

  • Filter applications where it has both marketing and sales tags
/v2/applications?tags=[marketing,sales]

Entire Array Filtering with Negation

Entire array filtering can be combined with negation filters.

Example

  • Filter applications where it does not have both marketing and sales tags
/v2/applications?tags=!,[marketing,sales]

A new resource "Purchase Order" was added in with basic GET operations. There was also a small update to the "User" resource in which you can now update a user's tags and notes.

Added

Purchase Order

Get Purchase Orders

  • An endpoint to get "Purchase Orders" from your Zylo instance.

Get Purchase Order by Id

  • An endpoint to retrieve a single "Purchase Order" by it's id.

User

Update User By Id

  • Update the notes and tags on an individual "User".

Improved

General

Two auditing fields, zylo_created_at and zylo_modified_at, have been added to all existing and new resources.

These fields indicate when a resource was created or last modified in the Zylo system. They do not reflect when the resource was created outside of Zylo (if applicable).

PO Line Items

Get PO Line Items

  • order_line_number is now filterable.

Get PO Line Item by Id

  • order_line_number is now filterable.