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

Adds the app_description property to the Zybrary resource's metadata

Added

The property app_description is now returned in the Zybrary responses.

This update includes new operations to the "Custom Fields" resource.

Added

Custom Fields

Get Custom Fields

  • Retrieve a list of all custom fields.

Get Custom Field by ID

  • Retrieve a single Custom Field by the ID.

Create a Custom Field

  • Create a custom field.

Update a Custom Field

  • Update a custom field.

Delete a Custom Field

  • Delete a custom field.

Fixes to documentation.

Fixed

Payments

  • Fixed the Pre-requisites example on how to get the Payment Upload Source Types.

Fix and clarifies the zybrary_supplier_id and supplier_id field on resources.

Added

Zybrary

  • Added zybrary_supplier_idto the Zybrary resource.

Applications

  • Added supplier_id to the Application resource.

Fixed

Payments

  • Changed supplier_id to zybrary_supplier_id to correct issue when joining between Suppliers and Payments resources. Payments should join to the Zybrary resource.

There is now a process to upload Payment data via CSV files. The details for importing the payment data can be found in the Payment Upload documentation.

Added

Payments

Get Payment Imports

  • Retrieve a list of all Payment Imports.

Get Payment Upload Source Types

  • Retrieve a list of all valid source types to be used for Payment Uploads.

Create Payment Upload Job

  • Create a Payment Upload Job and get the required parameters to import a CSV for the job.

Adds three new endpoints to the API; create, update, and delete Savings Events.

Added

Savings Events

Create a Savings Event

  • Savings Events can now be created. These will always show as custom in the application.

Update a Savings Event

  • Savings Events metadata can now be updated.

Delete a Savings Event

  • Savings Events can now be deleted. Non-custom Savings Events will not be able to be deleted.

Various improvements and fixes for Contracts resource.

Added

Contracts

  • Added better documentation around billing_frequency to the Contracts resource to indicate what values are valid.

Fixed

Contract Line Items

  • Moving forward application_id is no longer able to be set to null.

Removed

Contracts

  • The external_source_link is no longer able to be modified.

This update includes new operations to the "Application Budgets" resource.

Added

Application Budgets

Get Application Budgets

  • Retrieve a list of all application budgets.

Get Application Budget Stats

  • Retrieve aggregates stats for the budgets related to each application.

Create an Application Budget

  • Create an application budget by year.

Update an Application Budget

  • Update an application budget by year.

Delete an Application Budget

  • Delete an application budget by year.

Adds two new endpoints to the API; get a list of Savings Events and get a Savings Event by Id.

Added

Savings Events

Get list of Savings Events

  • An endpoint to get a list of Savings Events from your Zylo instance. This includes the metadata for the Savings Events.

Get A Savings Event by Id

  • An endpoint to get a single Savings Event from your Zylo instance by its id. This includes the metadata for the Savings Events.

Various improvements and fixes for Contracts resource.

Added

Contracts

  • Added can_have_contract_lines to the Contracts resource to indicate if the contract can have contract line items added.
  • Contracts that have can_have_contract_lines as false will have an application_id associated to it on the Contract resource.
  • Contracts that have can_have_contract_lines as true will not have an application_id associated to it on the Contract resource, but will have Contract Line Items attached.

Fixed

Contracts

  • An end_date is now required when month_to_month is false.
  • The field native_currency is now required.