Zylo Data Dictionary

Complete reference of all fields available across Zylo resources for building queries and managing data.

Tenant-specific custom fields

The tables below list the custom_fields container, but they cannot enumerate its children because custom field definitions differ by company. Query the custom_fields resource to discover the fields for the relevant public, plural entity_type (applications, contracts, payments, or users), then use the field on its owning resource as custom_fields.<slug> in both fields[].name and filters. For entity_type: users, query the users resource. The slug is the field name lowercased, with spaces changed to underscores, hyphens preserved, and other special characters removed (for example, QA Choice P0-3 becomes custom_fields.qa_choice_p0-3). Use JSON true/false for boolean custom-field filters; Yes/No are also accepted.

Alerts

Resource name: alerts

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for the application this alert is associated with.	Yes	Yes	No
`contract_id`	Contract Id	UUID	Unique identifier for the contract this alert is associated with.	Yes	Yes	No
`id`	Id	UUID	Unique identifier for an alert.	No	No	No
`last_processed_date`	Last Processed Date	datetime	Date and time the alert was last processed by the system.	Yes	No	No
`memo`	Memo	string	The alert memo. This is additional information included in the alert notification.	Yes	Yes	Yes
`method`	Method	string	Alert delivery method. There are three methods for delivery; email, slack, and teams. Email is configured to work out of the box but the other two require additional setup. Allowed values: `email`, `slack`, `teams`.	Yes	No	No
`owner`	Owner	email	Email address of the Owner. The email must belong to a user in the Zylo system.	Yes	Yes	Yes
`settings`	Settings	object	Dynamic configuration for the alert, including recipients and type-specific settings.	Yes	Yes	Yes
`type`	Type	string	Type of alert. There are three types of alerts; contract-renewal, renewal, and transaction. Allowed values: `contract-renewal`, `renewal`, `transaction`.	Yes	Yes	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No
`zylo_user_id`	Zylo User Id	UUID	Unique identifier for the Zylo user who owns this alert.	Yes	No	No

Application Budget Stats

Resource name: application_budget_stats

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for an application.	No	No	No
`current_fiscal_year_budget`	Current FY Budget	currency	Budget for fiscal year aggregated from Financial integration or uploaded financial data.	Yes	No	No
`id`	Id	UUID	Unique identifier for an application budget.	No	No	No
`last_fiscal_year_budget`	Last FY Budget	currency	Budget for last fiscal year aggregated from Financial integration or uploaded financial data.	Yes	No	No
`next_fiscal_year_budget`	Next FY Budget	currency	Budget for next fiscal year aggregated from Financial integration or uploaded financial data.	Yes	No	No
`percent_budget_used_year_to_date`	% to Budget	percentage	Total percent of spend against the current fiscal year budgeted amount.	Yes	No	No
`two_years_ago_fiscal_year_budget`	2 Years Ago FY Budget	currency	Budget for 2 years ago fiscal year aggregated from Financial integration or uploaded financial data.	Yes	No	No
`yoy_budget_change`	YoY Budget	percentage	Budget change from last fiscal year to current fiscal year aggregated from Financial integration or uploaded financial data.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Application Budgets

Resource name: application_budgets

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for an application.	No	Yes	Yes
`budget_amount`	Budget Amount	number	The budget amount for the fiscal year.	Yes	Yes	Yes
`id`	Id	UUID	Unique identifier for an application budget.	No	No	No
`year`	Year	number	The fiscal year for the budget.	Yes	Yes	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Application Catalog

Resource name: application_catalog

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`app_description`	App Description	string	The description of the application, as shown to end users browsing the app catalog.	Yes	No	No
`app_domain`	App Domain	string	The domain of the application.	Yes	No	No
`app_label`	App Label	string	The label for the application this catalog entry describes.	Yes	No	No
`application_id`	Application Id	UUID	Unique identifier for the application this catalog entry describes. Joins to `applications.id`.	No	Yes	No
`catalog_status`	Catalog Status	string	Whether the app is published in the company's app catalog. `in` = visible to end users, `out` = explicitly excluded, `pending` = not yet reviewed. Allowed values: `in`, `out`, `pending`.	Yes	Yes	Yes
`category`	Category	string	Category of the application this catalog entry describes.	Yes	No	No
`contact_type`	Contact Type	string	Which contact is surfaced to end users for this app: the app owner, IT owner, business owner, or the company-wide default contact configured on the catalog. Allowed values: `app_owner`, `it_owner`, `business_owner`, `default_contact`.	Yes	Yes	Yes
`custom_routing_link`	Custom Routing Link	string	Overrides the default routing URL for this app when `is_custom_link_enabled` is true.	Yes	Yes	Yes
`id`	Id	UUID	Unique identifier for the application-catalog entry.	No	No	No
`is_custom_link_enabled`	Is Custom Link Enabled	boolean	When true, end users are routed to `custom_routing_link` instead of the company default.	Yes	Yes	Yes
`is_routing_link_enabled`	Is Routing Link Enabled	boolean	When true, the "request access" / launch link is shown to end users. When false, the app is visible in the catalog but not actionable.	Yes	Yes	Yes
`launch_url`	Launch Url	string	The URL end users are routed to when launching this app, unless overridden by `custom_routing_link`.	Yes	No	No
`subcategory`	Subcategory	string	Subcategory of the application this catalog entry describes.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Application Licenses

Resource name: application_licenses

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`active`	Active	boolean	Whether the license is currently active.	Yes	No	No
`application_id`	Application Id	UUID	The application this license is assigned to.	Yes	No	No
`external_user_id`	External User Id	string	The user identifier from the external integration.	Yes	No	No
`id`	Id	UUID	Unique identifier for an application license record.	No	No	No
`is_paid_license`	Is Paid License	boolean	Whether this is a paid license.	Yes	No	No
`last_activity_date`	Last Activity Date	datetime	The date of the last activity for this license assignment.	Yes	No	No
`license_type`	License Type	string	The type of license (e.g., user, feature, permission_set, custom).	Yes	No	No
`name`	Name	string	The name of the license.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No

Application Security

Resource name: application_security

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`c5_germany`	C 5 Germany	boolean	Whether the vendor holds the BSI C5 attestation (Germany).	Yes	No	No
`category_name`	Category Name	string	Application category from Netskope's catalog (e.g., Collaboration, CRM, HR).	Yes	No	No
`cci`	Cci	number	Cloud Confidence Index — a 0–100 score from Netskope. Higher is more trustworthy.	Yes	No	No
`ccl`	Ccl	string	Cloud Confidence Level — bucketed risk tier derived from CCI. One of Low, Medium, High, Excellent. Allowed values: `Low`, `Medium`, `High`, `Excellent`.	Yes	No	No
`ccpa`	CCPA	boolean	Whether the vendor complies with the California Consumer Privacy Act (CCPA).	Yes	No	No
`cobit`	Cobit	boolean	Whether the vendor is COBIT aligned.	Yes	No	No
`confirmed`	Confirmed	boolean	Whether the match between the application and the Netskope catalog entry has been confirmed.	Yes	No	No
`cyber_essentials_uk`	Cyber Essentials Uk	boolean	Whether the vendor holds Cyber Essentials / Cyber Essentials Plus (UK).	Yes	No	No
`fedramp`	Fedramp	boolean	Whether the vendor is FedRAMP authorized.	Yes	No	No
`fisma`	Fisma	boolean	Whether the vendor is FISMA compliant.	Yes	No	No
`gapp`	Gapp	boolean	Whether the vendor adheres to GAPP (Generally Accepted Privacy Principles).	Yes	No	No
`gdpr`	GDPR	boolean	Whether the vendor complies with the General Data Protection Regulation (GDPR).	Yes	No	No
`hipaa`	Hipaa	boolean	Whether the vendor is HIPAA compliant.	Yes	No	No
`hitrust`	Hitrust	boolean	Whether the vendor holds a HITRUST certification.	Yes	No	No
`id`	Id	UUID	Zybrary application id this security record describes. Join `applications.zybrary_id` against this field to attach security data to a company app.	No	No	No
`iso_27001`	Iso 27001	boolean	Whether the vendor is ISO/IEC 27001 certified.	Yes	No	No
`iso_iec27018`	Iso Iec 27018	boolean	Whether the vendor is ISO/IEC 27018 certified.	Yes	No	No
`manually_matched`	Manually Matched	boolean	Whether the Netskope catalog match was made manually (true) or by automated matching (false).	Yes	No	No
`netskope_application_domain`	Netskope Application Domain	string	Application domain as recorded in Netskope's catalog.	Yes	No	No
`netskope_application_name`	Netskope Application Name	string	Application name as recorded in Netskope's catalog. Useful for verifying the match.	Yes	No	No
`nist_sp80053`	Nist Sp 80053	boolean	Whether the vendor follows NIST SP 800-53 controls.	Yes	No	No
`pci_dss`	Pci Dss	boolean	Whether the vendor is PCI DSS compliant.	Yes	No	No
`privacy_mark_japan`	Privacy Mark Japan	boolean	Whether the vendor holds the Japan Privacy Mark.	Yes	No	No
`privacy_shield`	Privacy Shield	boolean	Whether the vendor is Privacy Shield certified (note: framework status varies by jurisdiction).	Yes	No	No
`sas70_ssae16_ssae18`	Sas 70 Ssae 16 Ssae 18	boolean	Whether the vendor has SAS 70 / SSAE 16 / SSAE 18 attestations.	Yes	No	No
`soc_1`	Soc 1	boolean	Whether the vendor holds a SOC 1 attestation.	Yes	No	No
`soc_2`	Soc 2	boolean	Whether the vendor holds a SOC 2 attestation.	Yes	No	No
`soc_3`	Soc 3	boolean	Whether the vendor holds a SOC 3 attestation.	Yes	No	No
`trustarc`	Trustarc	boolean	Whether the vendor is TrustArc certified.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the security record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the security record was last modified in Zylo.	Yes	No	No

Application Stats

Resource name: application_stats

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`active_functionalities`	Active Functionalities	array	Array of active functionality names configured for this application. Callers who want a count can take `array_length` client-side.	Yes	No	No
`active_po_count`	Active PO Count	number	Number of purchase orders with status = "approved" for this application.	Yes	No	No
`active_user_app_count`	Active Users	number	Number of provisioned users with tracked activity within the application's set activity threshold (90 days by default), aggregated from direct utilization integration (if connected), or SSO integration data (sum of all users from mapped apps).	Yes	No	No
`app_label`	App Label	string	The label for the application.	Yes	No	No
`bill_frequency`	Bill Frequency	string	Billing frequency of the primary contract associated with this application (Monthly, Quarterly, Annually, etc.).	Yes	No	No
`charge_count`	Charge Count	number	Total number of payment transactions (charges) associated with this application across all data sources.	Yes	No	No
`contract_notification_length`	Renewal Notice Length	number	Number of days before contract end date that renewal notice must be given, from the primary contract.	Yes	No	No
`contract_status`	Contract Status	string	Status of the contracts tied to an application. Active is set if any contract is not expired or inactive. Expired is set when any contract end date is in the past. Inactive is set when any contract start date is in the future. An empty value is populated if an application has no contract associated with it.	Yes	No	No
`contract_term_spend`	Contract Term Spend	currency	Total spend across the primary contract term (sum of contract line items).	Yes	No	No
`cost_per_user`	Cost Per User	currency	The cost per user value for the application.	Yes	No	No
`current_and_last_fiscal_year_spend`	Current + Last FY Spend	currency	Payments for the application in the current and last fiscal years, including AP, Reseller, and Expense payments. Aggregated from Financial integration or uploaded payment data. Null when the company has no fiscal year configured.	Yes	No	No
`current_fiscal_year_q_1_spend`	Current FY Q1 Spend	currency	Payments in the current fiscal year's Q1 window. Null when the company has no fiscal year configured.	Yes	No	No
`current_fiscal_year_q_2_spend`	Current FY Q2 Spend	currency	Payments in the current fiscal year's Q2 window. Null when the company has no fiscal year configured.	Yes	No	No
`current_fiscal_year_q_3_spend`	Current FY Q3 Spend	currency	Payments in the current fiscal year's Q3 window. Null when the company has no fiscal year configured.	Yes	No	No
`current_fiscal_year_q_4_spend`	Current FY Q4 Spend	currency	Payments in the current fiscal year's Q4 window. Null when the company has no fiscal year configured.	Yes	No	No
`current_fiscal_year_spend`	Current FY Spend	currency	Payments for the application in the current fiscal year, including AP, Reseller, and Expense payments. Aggregated from Financial integration or uploaded payment data. Null when the company has no fiscal year configured.	Yes	No	No
`current_week_cost`	Current Week Cost	currency	Total costs consumed in the current calendar week. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`current_week_cost_forecast`	Current Week Cost Forecast	currency	Forecasted costs for the current calendar week. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`current_week_cost_percent_to_forecast`	Current Week Cost Percent To Forecast	percentage	Percentage ratio comparing the total current week costs consumed against the current week's forecast. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`earliest_active_contract_start_date`	Contract Open Since	date	Start date of earliest active contract for this application.	Yes	No	No
`estimated_renewal_date`	Next Renewal Date	date	Calculated estimated renewal date based on contract data or payment history. Sources include active contracts, expired contracts, or AP transaction patterns.	Yes	No	No
`estimated_renewal_source`	Next Renewal Date Source	string	Source of the estimated renewal date: contract, month_to_month, expired_contract_12m, expired_contract_24m, ap_transaction_12m, ap_transaction_24m, unable_to_estimate. Allowed values: `contract`, `month_to_month`, `expired_contract_12m`, `expired_contract_24m`, `ap_transaction_12m`, `ap_transaction_24m`, `unable_to_estimate`.	Yes	No	No
`forecast_to_commitment_percentage`	Forecast to Commitment %	percentage	Percentage comparing forecasted costs against the total payment commitment in the contract term. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`id`	Id	UUID	Unique identifier for the application these stats belong to.	No	No	No
`inactive_functionalities`	Inactive Functionalities	array	Array of inactive functionality names for this application.	Yes	No	No
`inactive_user_count`	Inactive Users	number	Number of provisioned users that do not have tracked activity within the application's set activity threshold (90 days by default), aggregated from direct utilization integration (if connected), usage connect, or SSO integration data (sum of all users from mapped apps).	Yes	No	No
`last_12_months_ap_spend`	Last 12 Months AP Spend	currency	Only AP payments (including Reseller) in the last 12 months for the application. Aggregated from Financial integration or uploaded payment data.	Yes	No	No
`last_12_months_expense_spend`	Last 12 Months Expense Spend	currency	Only Expense payments in the last 12 months for the application. Aggregated from Financial integration or uploaded payment data.	Yes	No	No
`last_12_months_spend`	Last 12 Months Spend	currency	Payments for the application in the last 12 months, including AP, Reseller, and Expense payments. Aggregated from Financial integration or uploaded payment data.	Yes	No	No
`last_2_fiscal_years_spend`	Last 2 FYs Spend	currency	Payments for the application in the last 2 fiscal years, including AP, Reseller, and Expense payments. Aggregated from Financial integration or uploaded payment data. Null when the company has no fiscal year configured.	Yes	No	No
`last_ap_transaction_date`	Last AP Transaction Date	date	Last detected transaction date for the application across Accounts Payable (including Reseller) data sources.	Yes	No	No
`last_contract_expiration_date`	Previous Contract End Date	date	Most recent contract end date of expired contracts associated with this application.	Yes	No	No
`last_expense_transaction_date`	Last Expense Transaction Date	date	Last detected transaction date for the application across Expense data sources.	Yes	No	No
`last_fiscal_year_q_1_spend`	Last FY Q1 Spend	currency	Payments in the last fiscal year's Q1 window. Null when the company has no fiscal year configured.	Yes	No	No
`last_fiscal_year_q_2_spend`	Last FY Q2 Spend	currency	Payments in the last fiscal year's Q2 window. Null when the company has no fiscal year configured.	Yes	No	No
`last_fiscal_year_q_3_spend`	Last FY Q3 Spend	currency	Payments in the last fiscal year's Q3 window. Null when the company has no fiscal year configured.	Yes	No	No
`last_fiscal_year_q_4_spend`	Last FY Q4 Spend	currency	Payments in the last fiscal year's Q4 window. Null when the company has no fiscal year configured.	Yes	No	No
`last_fiscal_year_spend`	Last FY Spend	currency	Payments for the application in the last fiscal year, including AP, Reseller, and Expense payments. Aggregated from Financial integration or uploaded payment data. Null when the company has no fiscal year configured.	Yes	No	No
`last_monthly_payment_date`	Last Monthly Payment Date	date	Date of the most recent detected monthly recurring payment.	Yes	No	No
`last_transaction_date`	Last Transaction Date	date	Last detected transaction for the application across all payment data sources (financial integration, uploaded files).	Yes	No	No
`number_of_active_contracts`	Number Of Active Contracts	number	Number of active contracts with at least one line associated to this application.	Yes	No	No
`percent_active_licenses`	Percent Active Users	percentage	Active Users divided by Provisioned Users.	Yes	No	No
`percent_consumed`	Percent Consumed	percentage	Percentage of payment commitment consumed in the current contract term. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`percent_utilized_licenses`	Percent Licenses Provisioned	percentage	Provisioned Users divided by Licenses Purchased.	Yes	No	No
`po_count`	PO Count	number	Total number of purchase orders associated with this application.	Yes	No	No
`previous_day_cost`	Previous Day Cost	currency	Total costs consumed for the previous calendar day. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`previous_day_cost_forecast`	Previous Day Cost Forecast	currency	Forecasted costs for the previous calendar day. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`previous_day_cost_percent_to_forecast`	Previous Day Cost Percent To Forecast	percentage	Percentage comparing the previous day costs consumed against the previous day's forecast. Populated only for applications connected to a cloud cost integration; null otherwise.	Yes	No	No
`primary_cost_center`	Primary Cost Center	object	JSON blob with the primary cost center for this application. Keys: `cost_center` (name of the top-spending cost center), `annual_spend` (its annual spend), `total_cost_centers_count` (count of distinct cost centers across all payments for this app).	Yes	No	No
`purchased_license_count`	Licenses Purchased	number	Total count of licenses purchased across all active contracts associated to this application.	Yes	No	No
`renewal_date`	Next Contract End Date	date	Next contract end date for this application, calculated from contracts uploaded to this application.	Yes	No	No
`total_approved_po`	Total Approved PO Value	currency	Sum of approved purchase-order values for this application.	Yes	No	No
`total_contract_line_value`	Total Contract Line Value	currency	Sum of all contract lines that have the corresponding application assigned to them and the contract is active.	Yes	No	No
`total_contract_value`	Total Contract Value	currency	Total amount of all active contracts where this application has been associated to one or more lines.	Yes	No	No
`total_po_software_spend`	Total PO Software Spend	currency	Sum of PO line item amounts where the line is SaaS-typed (`is_saas = true`) for this application.	Yes	No	No
`unique_active_user_count`	Unique Active Users	number	Number of unique provisioned users, based on a unique identifier, with tracked activity within the application's set activity threshold (90 days by default), aggregated from direct utilization integration (if connected), or SSO integration data. Useful when mapping more than 1 SSO app to a Zylo app.	Yes	No	No
`unique_user_count`	Unique Provisioned Users	number	Number of unique provisioned users, based on a unique identifier, that have access to the application, aggregated from direct utilization integration (if connected), or SSO integration data. Useful when mapping more than 1 SSO app to a Zylo app.	Yes	No	No
`user_count`	Provisioned Users	number	Number of provisioned users that have access to the application, aggregated from direct utilization integration (if connected), or SSO integration data (sum of all users from mapped apps).	Yes	No	No
`users_expensing_count`	Users Expensing	number	Number of distinct users who submitted expense payments for this application.	Yes	No	No
`users_not_in_employee_roster`	Users Not In Employee Roster	number	Number of provisioned users that have access to the application, but are not in the employee roster, based on email address.	Yes	No	No
`year_to_date_spend`	YTD Spend	currency	Payments within the current calendar year. Aggregated from Financial integration or uploaded payment data.	Yes	No	No
`zybrary_id`	App Id	UUID	Identifier for the underlying Zybrary application catalog entry. Use this to correlate stats rows across applications that share the same upstream app.	No	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the application was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the application was last modified in Zylo.	Yes	No	No

Application Surveys

Resource name: application_surveys

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application ID	UUID	Unique identifier for the application the survey rollup belongs to.	No	No	No
`average_score`	Average Score	number	Average sentiment score across responses in the survey period.	Yes	No	No
`end_date`	End Date	date	End of the survey period.	Yes	No	No
`id`	Id	UUID	Unique identifier for an application survey rollup.	No	No	No
`response_count`	Response Count	number	Number of responses in the survey period.	Yes	No	No
`score_breakdown`	Score Breakdown	object	Breakdown of the sentiment scores that make up the average.	Yes	No	No
`start_date`	Start Date	date	Start of the survey period.	Yes	No	No
`survey_count`	Survey Count	number	Number of surveys sent in the period.	Yes	No	No
`survey_type`	Survey Type	string	The type of survey.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the survey rollup was created in Zylo.	Yes	No	No
`zylo_created_by`	Zylo Created By	string	The user or entity that created the survey rollup.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the survey rollup was last modified in Zylo. Uses the created date by default.	Yes	No	No
`zylo_modified_by`	Zylo Modified By	string	The user or entity that last modified the survey rollup.	Yes	No	No

Application Users

Resource name: application_users

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`active`	Active	boolean	If user has activity within the application activity threshold.	Yes	No	No
`application_data`	Application Data	object	Application specific data related to the application user. Varies per integration type.	Yes	No	No
`application_id`	Application Id	UUID	Unique identifier for an application.	Yes	No	No
`days_active`	Days Active in Threshold	number	Number of days the user has been active within the application activity threshold.	Yes	No	No
`email`	Email	email	Email for the application user.	Yes	No	No
`external_user_id`	External User Id	string	The unique identifier for the application user in the external system.	Yes	No	No
`first_name`	First Name	string	First name of the application user.	Yes	No	No
`full_name`	Full Name	string	Full name of the application user.	Yes	No	No
`id`	Id	UUID	Unique identifier for an application user.	No	No	No
`integration_type`	Integration Type	string	The type of integration that the application user is associated with.	Yes	No	No
`is_paid_user`	Is Paid User	boolean	If the application user's license is considered paid.	Yes	No	No
`last_activity_date`	Last Activity Date	date	The date of the last activity for the application user.	Yes	No	No
`last_name`	Last Name	string	Last name of the application user.	Yes	No	No
`license_names`	License Names	array	The license names from the application associated with the application user.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Applications

Resource name: applications

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`activity_threshold`	Activity Threshold	number	Threshold in days compared against a user's last activity to determine whether the user is Active. 90 days by default and editable on Subscription details page.	Yes	Yes	Yes
`app_label`	App Label	string	The label for the application.	Yes	Yes	Yes
`app_name`	App Name	string	The name of the application.	Yes	No	No
`application_owner_user_email`	Application Owner	email	Manually selected email address of the Application Owner.	Yes	Yes	Yes
`business_goals`	Business Goals	string	Business goals of the application.	Yes	Yes	Yes
`business_owner_user_email`	Business Owner	email	Manually selected email address of the Business Owner.	Yes	Yes	Yes
`business_unit`	Business Unit	string	Manually selected team that primarily owns the management of the application. Accepts an existing value, null, or a new value, which is created on write.	Yes	Yes	Yes
`category`	Category	string	Zylo-managed or internally-managed Category of the application. New values cannot be created through the API: add them in Zylo under Admin -> Categorization with Custom Categories enabled, then read them from GET /v2/applications/options/category and assign with a PATCH.	Yes	Yes	Yes
`custom_fields`	Custom Fields	object	Values for custom fields associated with this Application.	Yes	Yes	Yes
`holds_pii`	Holds PII	boolean	Manually selected field to identify which applications contain Personally Identifiable Information (PII) on users.	Yes	Yes	Yes
`id`	Id	UUID	Unique identifier for an application.	No	No	No
`is_cloud`	Cloud	boolean	Manually selected field to indicate if application is cloud delivered or on-premises.	Yes	No	No
`is_direct_integration`	Available Direct Integration	boolean	Field to indicate if application has an available direct integration.	Yes	No	No
`is_price_benchmarks`	Available Price Benchmark	boolean	Field to indicate if application has an available Zylo Price Benchmark.	Yes	No	No
`is_saml`	SAML Capable	boolean	Field to indicate if application is SAML capable.	Yes	No	No
`it_owner_user_email`	IT Owner	email	Manually selected email address of the IT Owner.	Yes	Yes	Yes
`it_supported`	IT Supported	boolean	Manually selected field to indicate if supported internally by IT.	Yes	Yes	Yes
`last_processed_date`	Last Processed At	datetime	The last date the application was processed by its data source.	Yes	No	No
`launch_url`	Launch Url	string	The URL to launch the application.	Yes	No	No
`next_action`	Next Action	string	Manually selected pick list field to identify what action needs to be taken next on an application. Allowed values: `cancel`, `evaluate`, `keep`, `potential`.	Yes	Yes	Yes
`payment_method`	Payment Method	string	Approved method in which the vendor is compensated as entered in contract details for the application.	Yes	No	No
`source`	Sources	array	The sources of all data on an Application, including payments, imports and integrations	Yes	No	No
`sso_enforced`	SSO Enforced	boolean	Manually selected field to identify which applications are enforced behind Single Sign On provider.	Yes	Yes	Yes
`status`	App Status	string	Status of the application. Reads may return: active, expired, cancelled, inactive, detected, discovered, monitored, managed, discontinued. Only "active" and "cancelled" may be set via the API; other statuses are calculated by Zylo from app data. Allowed values: `active`, `expired`, `cancelled`, `inactive`, `detected`, `discovered`, `monitored`, `managed`, `discontinued`.	Yes	Yes	Yes
`subcategory`	Subcategory	string	Zylo-managed or internally-managed Subcategory of the application. New values cannot be created through the API: add them in Zylo under Admin -> Categorization with Custom Categories enabled, then read them from GET /v2/applications/options/subcategory and assign with a PATCH.	Yes	Yes	Yes
`supplier_id`	Supplier Id	UUID	The id for the supplier associated with the application, if applicable.	Yes	No	No
`tags`	Tags	array	Custom tags that have been applied to an Application.	Yes	Yes	Yes
`true_up`	True Up	boolean	Manually selected field to indicate if true-ups are required by the application supplier.	Yes	Yes	Yes
`zybrary_id`	App Id	UUID	Unique identifier for the application's entry in Zylo's central application catalog (Zybrary). Multiple companies can have application records that point to the same Zybrary entry.	No	Yes	No
`zylo_created_at`	Created Date	datetime	Date the application was added to Zylo, via Discovery from financial data, an Integration or mannually added.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Company

Resource name: company

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`currency`	Currency	string	The default currency used by the company (e.g., USD, EUR). Allowed values: `USD`, `EUR`, `GBP`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `FJD`, `FKP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`.	Yes	No	No
`employee_roster`	Employee Roster	string	The employee roster source for the company.	Yes	No	No
`employee_roster_integration_id`	Employee Roster Integration Id	UUID	The integration ID of the employee roster.	Yes	No	No
`fiscal_year_settings`	Fiscal Year Settings	object	The fiscal year configuration settings for the company.	Yes	No	No
`id`	Id	UUID	Unique identifier for the company.	No	No	No
`name`	Name	string	The name of the company.	Yes	No	No
`timezone`	Timezone	string	The timezone preference for the company (e.g., America/New_York).	Yes	No	No

Company Documents

Resource name: company_documents

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`byte_size`	Byte Size	string	File size in bytes.	Yes	No	No
`content_type`	Content Type	string	MIME type of the uploaded file (e.g., application/pdf, image/jpeg).	Yes	No	No
`description`	Description	string	Description of the uploaded document.	Yes	No	No
`external_document_id`	External Document Id	string	External ID for the document if fetched from an external system (e.g., Coupa).	Yes	No	No
`filename`	Filename	string	Name of the uploaded file.	Yes	No	No
`id`	Id	UUID	Unique identifier for the company document.	No	No	No
`status`	Status	string	Processing status of the document. U = Uploading, A = Active (processed), E = Error. Allowed values: `U`, `A`, `E`.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the document was created.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the document was last modified.	Yes	No	No
`zylo_user_id`	Zylo User Id	UUID	Unique identifier for the Zylo user who created this document.	Yes	No	No

Company Tokens

Resource name: company_tokens

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`created_at`	Created At	datetime	Date and time the token was created.	Yes	No	No
`created_by`	Created By	string	User or entity that created the token.	Yes	No	No
`expires_at`	Expires At	datetime	When the token expires. Null if it does not expire.	Yes	No	No
`id`	Id	UUID		No	No	No
`roles`	Roles	array	Roles granted to the token.	Yes	No	No
`token_name`	Token Name	string	Human-readable name for the API token.	Yes	No	No

Connected Apps

Resource name: connected_apps

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`created_at`	Created At	datetime	Date and time the connected app was created.	Yes	No	No
`created_by`	Created By	string	User or entity that created the connected app.	Yes	No	No
`id`	Id	UUID		No	No	No
`legacy_role`	Legacy Role	string	Legacy single-role assignment, if present.	Yes	No	No
`name`	Name	string	Name of the connected app.	Yes	No	No
`oauth2_type`	OAuth2 Type	string	Which OAuth2 flow the connected app uses: "client-credentials" or "jwt-bearer".	Yes	No	No
`roles`	Roles	array	Roles granted to the connected app.	Yes	No	No

Contract Line Items

Resource name: contract_line_items

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for the application associated with the contract line item.	Yes	Yes	Yes
`company_app_id_manually_set`	Company App Id Manually Set	boolean		Yes	No	Yes
`contract_id`	Contract Id	UUID	Unique identifier for the contract associated with the contract line item.	No	Yes	No
`created_by`	Created By	string	Name of the person who created this contract line entry.	Yes	No	No
`end_date`	End Date	date	Contract line end date; If null, contract is ongoing.	Yes	Yes	Yes
`id`	Id	UUID	Unique identifier for a contract line item.	No	No	No
`license_name`	License Name	string	The optional label given to the contract line item license.	Yes	Yes	Yes
`license_type`	License Type	string	The type of licenses associated with the contract line item. Allowed values: `license`, `platform`, `professionalService`, `email`, `host`, `event`, `synthetic`, `envelope`, `maintenance`, `message`, `contact`, `project`, `cpu`, `document`, `storage`, `other`.	Yes	Yes	Yes
`line_description`	Line Description	string	Identifier for the contract line item.	Yes	Yes	Yes
`modified_by`	Modified By	string	Name of the person who last modified this contract line entry.	Yes	No	No
`native_currency`	Native Currency	string	Currency code of the currency the contract value is in. Allowed values: `USD`, `EUR`, `GBP`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `FJD`, `FKP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`.	Yes	Yes	Yes
`native_unit_price`	Native Unit Price	currency	Unit price for the line item in the value of the native_currency.	Yes	Yes	Yes
`quantity`	Quantity	number	Quantity of the contract line item.	Yes	Yes	Yes
`source`	Source	string	Source system of the contract line.	Yes	No	No
`start_date`	Start Date	date	Contract line item start date.	Yes	Yes	Yes
`total_price`	Total Price	currency	Total quantity multiplied by the unit_price.	Yes	No	No
`unit_of_measure`	Unit Of Measure	string	The unit of measurement for the contract line item. Allowed values: `Each`, `Year`, `Month`, `Week`, `Day`, `Hour`, `Terabyte`, `Gigabyte`, `Megabyte`, `Kilobyte`.	Yes	Yes	Yes
`unit_price`	Unit Price	currency	Unit price for the line item. Currency is converted if the Native Currency is different than the global currency set in Zylo. Zylo uses the currency exchange rate of the line item start_date.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Contract Match Details

Resource name: contract_match_details

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`accuracy_binary_confidence`	Accuracy Confidence	number	Confidence score for the accuracy binary classifier.	Yes	No	No
`accuracy_binary_result`	Accuracy Result	string	Result of the accuracy binary classifier.	Yes	No	No
`app_match_confidence`	App Match Confidence	number	Confidence score for the application match.	Yes	No	No
`app_match_reason`	App Match Reason	string	Explanation of why the application match was made.	Yes	No	No
`app_match_result_id`	App Match Result	UUID	The application id determined for the contract through the importer/modeler.	Yes	No	No
`cleansed_name`	Cleansed Name	string	The cleansed charge/contract name produced by the importer.	Yes	No	No
`contract_id`	Contract ID	UUID	Unique identifier for the contract these match details belong to.	No	No	No
`id`	Id	UUID	Unique identifier for a contract match detail record (the contract id).	No	No	No
`recall_binary_confidence`	Recall Confidence	number	Confidence score for the recall binary classifier.	Yes	No	No
`recall_binary_result`	Recall Result	string	Result of the recall binary classifier.	Yes	No	No
`reseller_binary_confidence`	Reseller Confidence	number	Confidence score for the reseller binary classifier.	Yes	No	No
`reseller_binary_result`	Reseller Result	string	Result of the reseller binary classifier.	Yes	No	No
`reseller_match`	Reseller Match	boolean	Whether the contract was matched to a reseller.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the match detail record was created in Zylo.	Yes	No	No
`zylo_created_by`	Zylo Created By	string	The user or entity that created the match detail record.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the match detail record was last modified in Zylo. Uses the created date by default.	Yes	No	No
`zylo_modified_by`	Zylo Modified By	string	The user or entity that last modified the match detail record.	Yes	No	No

Contracts

Resource name: contracts

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`account_number`	Account Number	string	The account number associated with the contract.	Yes	Yes	Yes
`application_id`	Application Id	UUID	The application associated with the contract. This is only set for single-application contracts. When a contract has line items, each application is associated through its line items instead, and this field is empty.	Yes	Yes	Yes
`billing_frequency`	Billing Frequency	string	Billing frequency for the contract. Allowed values: `Annually`, `Monthly`, `One Time`, `Quarterly`, `Semi-Annually`.	Yes	Yes	Yes
`can_have_contract_lines`	Can Have Contract Lines	boolean	Indicates if the contract can have lines added	Yes	Yes	Yes
`cancellation_policy`	Cancellation Policy	string	Cancellation policy for the contract.	Yes	Yes	Yes
`contract_term`	Contract Term	string	The term of duration of the contract.	Yes	Yes	Yes
`contract_value_year`	Contract Value Year	array[number]	Contract values by year for the contract.	Yes	No	No
`current_year_contract_value`	Current Year Contract Value	currency	Contract Year value that best relates to the Current Year.	Yes	No	No
`custom_fields`	Custom Fields	object	Values for custom fields associated with this Contract.	Yes	Yes	Yes
`end_date`	End Date	date	End date of the contract. This is required unless the contract field `month_to_month` is `true`.	Yes	Yes	Yes
`external_id`	External Id	string	Identifier of the contract in its source system.	Yes	No	No
`external_source_link`	External Source Link	string	External link to contract data source.	Yes	No	No
`has_contract_lines`	Has Contract Lines	boolean	Indicates if the contract can have lines added	Yes	No	No
`id`	Id	UUID	Unique identifier for a contract.	No	No	No
`month_to_month`	Month To Month	boolean	Indicates if the contract is auto-renewing.	Yes	Yes	Yes
`name`	Name	string	The contract name.	No	Yes	Yes
`native_contract_value_year`	Native Contract Value Year	array[number]	Total native value of the contract as entered in the contract record.	Yes	Yes	Yes
`native_currency`	Native Currency	string	Currency code of the currency the contract value is in. Allowed values: `USD`, `EUR`, `GBP`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `FJD`, `FKP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`.	Yes	Yes	Yes
`native_total_contract_value`	Native Total Contract Value	currency	Total native value of the contract as entered in the contract record.	Yes	Yes	Yes
`notification_period`	Notification Period	string	Length of notice required to submit contract termination to supplier.	Yes	Yes	Yes
`number`	Number	string	Contract Number from source system.	No	Yes	Yes
`owner`	Owner	string	Name of the primary contact for the contract.	Yes	Yes	Yes
`owner_manually_set`	Owner Manually Set	boolean	The owner was set manually.	Yes	No	Yes
`payment_method`	Payment Method	string	Payment method of the contract.	Yes	Yes	Yes
`payment_term`	Payment Term	string	The terms of payment for the contract.	Yes	Yes	Yes
`price_protection`	Price Protection	boolean	Is there price protection built into the contract.	Yes	Yes	Yes
`purchase_order_number`	Purchase Order Number	array	Purchase Order Number associated to this contract.	Yes	Yes	Yes
`remit_to_address`	Remit To Address	string	Remittance address for this contract.	Yes	Yes	Yes
`renewal_state`	Renewal State	string	Next steps for renewal of this contract.	Yes	Yes	Yes
`reseller`	Reseller	string	Reseller name for the contract.	Yes	Yes	Yes
`source`	Source	string	Source system of the contract.	Yes	No	No
`start_date`	Start Date	date	Start date of the contract.	Yes	Yes	Yes
`status`	Status	string	Status of the contract based on the current date and the contract start and end dates. "Active" indicates the contract is currently valid, "Expired" indicates the contract has ended, and "Inactive" indicates the contract has not yet started. Allowed values: `Active`, `Expired`, `Inactive`.	No	No	No
`supplier_id`	Supplier Id	UUID	Supplier is the publisher of the Application(s) associated with this Contract. Please note that this may not represent the supplier you purchase from if your contract is through a reseller.	Yes	Yes	Yes
`supplier_manually_set`	Supplier Manually Set	boolean	The supplier was set manually.	Yes	No	Yes
`supplier_name`	Supplier Name	string	Supplier is the publisher of the Application(s) associated with this Contract. Please note that this may not represent the supplier you purchase from if your contract is through a reseller.	Yes	No	No
`total_contract_value`	Total Contract Value	currency	Total value of the contract as entered in the contract record. Currency is converted if the Native Currency is different than the global currency set in Zylo. Zylo uses the currency exchange rate of the Contract Start Date.	Yes	No	No
`total_licenses`	Total Licenses	number	The total licenses for the contract.	Yes	No	No
`type`	Type	array	The type of contract recorded.	Yes	Yes	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Cost Per User Items

Resource name: cost_per_user_items

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application ID	UUID	Unique identifier for the application the cost-per-user item belongs to.	No	No	No
`contract_id`	Contract ID	UUID	Unique identifier for the contract the cost-per-user item is associated with.	Yes	No	No
`contract_line_item_id`	Contract Line Item ID	UUID	Unique identifier for the contract line item the cost-per-user item is associated with.	Yes	No	No
`description`	Description	string	Description of the cost-per-user item.	Yes	No	No
`id`	Id	UUID	Unique identifier for a cost-per-user item.	No	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the cost-per-user item was created in Zylo.	Yes	No	No
`zylo_created_by`	Zylo Created By	string	The user or entity that created the cost-per-user item.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the cost-per-user item was last modified in Zylo. Uses the created date by default.	Yes	No	No
`zylo_modified_by`	Zylo Modified By	string	The user or entity that last modified the cost-per-user item.	Yes	No	No

Custom Fields

Resource name: custom_fields

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`custom_field_group_id`	Custom Field Group ID	UUID	The custom field group this field belongs to.	Yes	No	No
`description`	Description	string	The custom field description.	Yes	Yes	Yes
`entity_type`	Entity Type	string	The type of entity this custom field applies to (e.g. company_app, contract, charge). Defaults to applications. Allowed values: `applications`, `payments`, `contracts`, `users`.	Yes	Yes	No
`id`	Id	UUID	Unique identifier for a custom field.	No	No	No
`is_enabled`	Is Enabled	boolean	Indicates whether the custom field is enabled or not.	Yes	Yes	Yes
`is_key`	Is Key	boolean	Indicates whether the custom field is a key field or not.	Yes	No	No
`name`	Name	string	The custom field name.	No	Yes	No
`options`	Options	object	The options of the custom field.	Yes	Yes	No
`position`	Position	number	The position of the custom field.	Yes	Yes	Yes
`section`	Section	string	The custom field section.	No	No	No
`type`	Type	string	The type of the custom field. Allowed values: `date`, `text`, `choice`, `multichoice`, `currency`, `boolean`, `number`, `email`.	No	Yes	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_created_by`	Zylo Created By	string	The user or entity that created the custom field.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No
`zylo_modified_by`	Zylo Modified By	string	The user or entity that last modified the custom field.	Yes	No	No

Functionalities

Resource name: functionalities

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for the application associated with the functionality.	No	No	No
`functionality_name`	Functionality Name	string	The functionality name.	Yes	No	No
`id`	Id	UUID	Unique identifier for a functionality.	No	No	No
`is_active`	Is Active	boolean	Whether or not the functionality is active.	Yes	No	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Connections Job History

Resource name: integration_uploads

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`app_domain`	Application Domain	string	Domain of the application associated with the connection.	Yes	No	No
`app_label`	Application	string	Application title associated with the connection.	Yes	No	No
`archive_file_name`	Archive File Name	string	Name of the archived copy of the uploaded file in S3.	Yes	No	No
`company_app_id`	Application ID	UUID	The Application ID associated with this upload.	No	No	No
`company_integration_id`	Company Integration ID	UUID	The connection this upload belongs to.	No	No	No
`created_by`	Created By	string	User or entity that created the upload.	Yes	No	No
`data_type`	Data Type	string	The type of data imported through the connection.	Yes	No	No
`delivery_method`	Delivery Method	string	The process in which the data is being imported.	Yes	No	No
`file_name`	File Name	string	The display name on the imported file.	Yes	No	No
`id`	Id	UUID		No	No	No
`job_id`	Job ID	string	The Id of the file import run.	Yes	No	No
`message`	Message	string	This field contains information about the connection. It may contain error details or status updates.	Yes	No	No
`rows_with_errors`	Rows With Errors	number	Number of rows that had an error.	Yes	No	No
`status`	Status	string	The connection state.	Yes	No	No
`successful_rows`	Successful Rows	number	Number of rows that successfully imported.	Yes	No	No
`upload_date`	Upload Date	date	The date the file was uploaded.	Yes	No	No

Integrations

Resource name: integrations

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for the application associated with the integration.	Yes	No	No
`application_name`	Application Name	string	The name of the application associated with the integration.	Yes	No	No
`error_message`	Error Message	string	The error message for the integration.	Yes	No	No
`external_organization_id`	External Organization Id	string	The unique ID of the instance in the third party provider.	Yes	No	No
`id`	Id	UUID	Unique identifier for an integration.	No	No	No
`last_fetch_date`	Last Fetch Date	date	The last date integration data was fetched.	Yes	No	No
`last_processed_date`	Last Processed Date	date	The date in which the integration was last processed.	Yes	No	No
`mapped_apps_failed_count`	Mapped Apps Failed Count	number	Only applicable for SSO integrations. The number of mapped applications that failed to run.	Yes	No	No
`mapped_apps_running_count`	Mapped Apps Running Count	number	Only applicable for SSO integrations. The number of mapped applications that are currently running.	Yes	No	No
`mapped_apps_succeeded_count`	Mapped Apps Succeeded Count	number	Only applicable for SSO integrations. The number of mapped applications that have succeeded.	Yes	No	No
`mappings`	Mappings	array	The mapping for the integration, only available for Usage Connect.	Yes	No	No
`status`	Status	string	The status of the integration. Allowed values: `RUNNING`, `SUCCEEDED`, `FAILED`.	Yes	No	No
`type`	Type	string	The type of integration. Allowed values: `aha!`, `airtable`, `asana`, `asanav2`, `atlassian`, `azuread`, `calendly`, `centrify`, `concur`, `concurendorsed`, `concurv2`, `confluence`, `coupa`, `docusign`, `domo`, `dropbox`, `expensify`, `figjam`, `figma`, `github`, `gsuite`, `hrroster`, `idaptive`, `informatica`, `intacct`, `jiracloud`, `looker`, `microsoftteams`, `monday`, `msdynamics365`, `netsuite`, `office365`, `office365v2`, `okta`, `onelogin`, `outreach`, `outreachv2`, `pagerduty`, `pagerdutyv2`, `salesforce`, `servicenow`, `servicenowv2`, `slack`, `smartsheet`, `usageconnect`, `veevacrm`, `veevavault`, `workdayfinancialap`, `workdayfinancialexpense`, `workdayhris`, `zendesk`, `zoom`.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

IP Passlist

Resource name: ip_passlist

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`created_at`	Created At	datetime	Date and time the entry was created.	Yes	No	No
`created_by`	Created By	string	User or entity that created the entry.	Yes	No	No
`description`	Description	string	Description of the IP passlist entry.	Yes	No	No
`id`	Id	UUID		No	No	No
`ip_address`	IP Address	string	The allowed IP address.	Yes	No	No
`is_api`	API Access	boolean	Whether this IP address is used for API access.	Yes	No	No
`is_app`	App Access	boolean	Whether this IP address is used for App access.	Yes	No	No
`modified_at`	Modified At	datetime	Date and time the entry was last modified.	Yes	No	No

OAuth Sessions

Resource name: oauth_sessions

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`client_id`	Client ID	string	OAuth client that initiated the session.	Yes	No	No
`client_name`	Client Name	string	Display name of the OAuth client (e.g. Claude Desktop, ChatGPT).	Yes	No	No
`created_at`	Created At	datetime	Date and time the session record was created.	Yes	No	No
`created_by`	Created By	string	User or entity that created the session record.	Yes	No	No
`email`	Email	email	Email of the Zylo user who authorized this session.	Yes	No	No
`expires_at`	Expires At	datetime	Absolute session expiry (e.g. 90 day cap).	Yes	No	No
`id`	Id	UUID		No	No	No
`last_refreshed_at`	Last Refreshed At	datetime	When the token was last refreshed.	Yes	No	No
`original_auth_at`	Original Auth At	datetime	When the session was first created.	Yes	No	No
`revoked_at`	Revoked At	datetime	Null if active, set if the session was revoked.	Yes	No	No
`type`	Type	string	Type of OAuth session (e.g. mcp).	Yes	No	No
`zylo_auth_id`	Zylo Auth ID	UUID	References the zylo_auth record for the user who authorized this session.	No	No	No

Payment Imports

Resource name: payment_imports

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`created_by`	Created By	string	The user or entity that uploaded the file.	Yes	No	No
`id`	Id	UUID	The payment id.	No	No	No
`import_type`	Import Type	string	The source and expense type of file that was uploaded.	Yes	No	No
`original_file`	Original File	string	The original name of the uploaded file.	Yes	No	No
`row_error`	Rows Errored	number	Count of errored rows in file. This count is only ever populated when the file comes from an integration connection.	Yes	No	No
`row_match`	Rows Matched	number	Count of matched rows in file. This count is only ever populated when the file comes from an integration connection.	Yes	No	No
`row_unmatch`	Rows Unmatched	number	Count of unmatched rows in file. This count is only ever populated when the file comes from an integration connection.	Yes	No	No
`status`	Status	string	Current status of the uploaded file. Possible values include: "U" (Uploaded), "P" (Processing), "C" (Completed), "E" (Error). Allowed values: `U`, `P`, `C`, `E`.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Software Charges

Resource name: payments

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`amount`	Amount	currency	Line item amount of the payment, mapped from financial data source.	Yes	No	No
`application_id`	Application Id	UUID	Unique identifier for the application associated with the payment. Null when the payment has not been matched to an application.	Yes	No	No
`associated`	PO Spend/Non PO Spend	string		Yes	No	No
`cost_center`	Cost Center	string	Cost center of the payment, mapped from financial data source.	Yes	No	No
`custom_fields`	Custom Fields	object	Values for custom fields associated with this Payment. Read-only — custom field values on Payments cannot be created or edited via this API.	Yes	No	No
`email`	Email	email	User responsible for expense transaction mapped from financial data source.	Yes	No	No
`email_domain`	Email Domain	string		Yes	No	No
`expense_type`	Expense Type	string	Expense type of the payment (e.g. Software & Subscriptions), mapped from financial data source.	Yes	No	No
`external_po_number`	Source System PO Number	string	Purchase Order Number as identified by the financial source system.	Yes	No	No
`id`	Id	UUID	The payment id.	No	No	No
`metadata`	Metadata	object	Raw financial data and fields in addition to standard payment detail.	Yes	No	No
`payment_date`	Payment Date	date	Date the payment occurred (e.g. Paid Date or Transaction Date), mapped from financial data source.	Yes	No	No
`payment_description`	Description	string	Description of the transaction, mapped from financial data source.	Yes	No	No
`payment_name`	Name	string	Name of payment, vendor, or supplier, mapped from financial data source.	Yes	No	No
`payment_type`	Type	string	Zylo's classification of the payment, AP (accounts payable) or Expense, based on the financial data source.	Yes	No	No
`po_line_item_id`	Po Line Item Id	UUID	The ID for the PO Line Item associated to this Payment.	Yes	No	No
`purchase_order_id`	Purchase Order Id	UUID	The ID for the Purchase Order associated to this Payment.	Yes	No	No
`reseller`	Reseller	string	Reseller the payment was processed through.	Yes	No	No
`source`	Source	string	Financial source of the payment.	Yes	No	No
`supplier_name`	Supplier Name	string	Name of the supplier, mapped from financial data source.	No	No	No
`transaction_id`	Transaction Id	string	Unique transaction ID of the payment, mapped from financial data source if available, or a Zylo-generated unique ID.	Yes	No	No
`zybrary_supplier_id`	Zybrary Supplier Id	UUID	The id for the Zybrary supplier. Found on the "Zybrary" resource	No	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Pending Contract Line Items

Resource name: pending_contract_line_items

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`app_name`	App Name	string	Name of the application associated with this line item.	Yes	No	No
`application_id`	Application Id	UUID	The application associated with this line item.	Yes	No	No
`end_date`	End Date	date	Ending date of the pending contract line item. May be null for ongoing contracts.	Yes	No	No
`id`	Id	UUID	Unique identifier for the pending contract line item.	No	No	No
`license_name`	License Name	string	The name of the license.	Yes	No	No
`license_type`	License Type	string	The type of license for this pending contract line item.	Yes	No	No
`line_description`	Line Description	string	Description of the product the licenses represent.	Yes	No	No
`line_item_number`	Line Item Number	number	Ordinal number for this line item as it appears in the contract (1-based).	Yes	No	No
`native_currency`	Native Currency	string	Native currency the pending contract line item was made out for.	Yes	No	No
`native_unit_price`	Native Unit Price	currency	Unit price in the native currency.	Yes	No	No
`pending_contract_id`	Pending Contract Id	UUID	The parent pending contract this line item belongs to.	No	No	No
`quantity`	Quantity	string	Quantity of licenses on the line item.	Yes	No	No
`start_date`	Start Date	date	Beginning date of the pending contract line item.	Yes	No	No
`total_price`	Total Price	currency	Estimated total price over the life of the pending contract line.	Yes	No	No
`unit_of_measure`	Unit Of Measure	string	Unit of measure for the license quantity.	Yes	No	No
`unit_price`	Unit Price	currency	Price per license.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the line item was created.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the line item was last modified.	Yes	No	No

Pending Contracts

Resource name: pending_contracts

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`billing_frequency`	Billing Frequency	string	How often billing occurs (e.g., monthly, annually).	Yes	No	No
`cancellation_policy`	Cancellation Policy	string	The cancellation policy for the pending contract.	Yes	No	No
`company_document_id`	Company Document Id	UUID	The company document associated with this pending contract.	No	No	No
`contract_term`	Contract Term	string	Contract term type (Fixed, Auto-renewed, or Perpetual).	Yes	No	No
`created_by`	Created By	string	Who uploaded the contract document.	Yes	No	No
`end_date`	End Date	date	Pending contract end date. May be null for ongoing contracts.	Yes	No	No
`id`	Id	UUID	Unique identifier for the pending contract.	No	No	No
`is_reviewed`	Is Reviewed	boolean	Whether the AI-extracted data has been reviewed by a human.	Yes	No	No
`month_to_month`	Month To Month	boolean	Whether this is a recurring payment contract.	Yes	No	No
`name`	Name	string	Name of the pending contract, typically derived from the uploaded document filename.	Yes	No	No
`native_currency`	Native Currency	string	Currency the pending contract was made out for.	Yes	No	No
`native_total_contract_value`	Native Total Contract Value	currency	Estimated total value of the pending contract in native currency.	Yes	No	No
`notification_period`	Notification Period	string	Required notification period before contract changes.	Yes	No	No
`number`	Number	string	Pending contract number extracted from the document.	Yes	No	No
`owner`	Owner	string	Person responsible for administering the pending contract.	Yes	No	No
`source`	Source	string	The source of the contract data (e.g., API, manual upload).	Yes	No	No
`start_date`	Start Date	date	Pending contract start date.	Yes	No	No
`supplier_id`	Supplier Id	UUID	The supplier associated with this pending contract.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the pending contract was created (upload date).	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the pending contract was last modified.	Yes	No	No

PO Line Items

Resource name: po_line_items

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`amount`	Amount	currency	The amount of allocated spend for the PO line item.	Yes	No	No
`application_id`	Application Id	UUID	Unique identifier for the application associated with the purchase order line item.	Yes	No	No
`commodity_category`	Commodity Category	string	Commodity category of the PO Line Item.	Yes	No	No
`commodity_name`	Commodity Name	string	Commodity Type of the PO Line Item.	Yes	No	No
`department_name`	Department Name	string	Department name of the PO Line Item.	Yes	No	No
`description`	Description	string	The description provided for this PO Line Item.	Yes	No	No
`expense_type`	Expense Type	string	Expense type of the PO Line Item.	Yes	No	No
`external_created_at`	External Created Date	datetime	The date the source system reported as the creation date of the purchase order line item.	Yes	No	No
`id`	Id	UUID	Unique identifier for a purchase order line item.	No	No	No
`is_saas`	Include	boolean	Is this PO Line Item related to SaaS spend (Included).	Yes	No	No
`order_line_number`	PO Line #	string	PO Line Order Number.	Yes	No	No
`percent_spend_against`	Percent Spend Against	percentage	Percentage of spend made against the approved purchase order line amount.	Yes	No	No
`purchase_order_id`	Purchase Order Id	UUID	Unique identifier for the purchase order associated with the purchase order line item.	Yes	No	No
`remaining_spend_against`	Remaining Spend Against	currency	Remaining amount of associated spend against the purchase order line item.	Yes	No	No
`requestor_name`	Requestor Name	string	Requestor name of the PO Line Item.	Yes	No	No
`source`	Source	string	Source system of the PO Line Item.	Yes	No	No
`supplier_account_number`	Supplier Account Number	string	Supplier account number of the PO Line Item.	Yes	No	No
`supplier_name`	Supplier Name	string	Supplier name of the PO Line Item.	Yes	No	No
`supplier_number`	Supplier Number	string	Supplier number of the PO Line Item.	Yes	No	No
`supplier_order_number`	Supplier Order Number	string	Supplier order number of the PO Line Item.	Yes	No	No
`total_spend_against`	Total Spend Against	currency	Total amount on the related charge.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Purchase Orders

Resource name: purchase_orders

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`account_number`	Account Number	string	The account number associated with the purchase order.	Yes	No	No
`amount`	Amount	currency	Total approved amount of the purchase order.	Yes	No	No
`contract_message`	Contract Message	string	Details of the contract creation.	Yes	No	No
`external_closed_at`	External Closed At	date	The date the source system reported as the close date of the purchase order.	Yes	No	No
`external_created_at`	External Created At	date	The date the source system reported as the creation date of the purchase order.	Yes	No	No
`id`	Id	UUID	Unique identifier for a purchase order.	No	No	No
`metadata`	Metadata	object	Raw source system data.	Yes	No	No
`number`	Number	string	The number of the purchase order.	Yes	No	No
`percent_spend_against`	Percent Spend Against	percentage	Total percent of associated spend against the purchase order's approved amount.	Yes	No	No
`remaining_spend_against`	Remaining Spend Against	currency	Remaining amount of associated spend against the purchase order.	Yes	No	No
`requisition_number`	Requisition Number	string	The requisition number associated with the purchase order.	Yes	No	No
`source`	Source	string	Source system of the purchase order.	Yes	No	No
`status`	Status	string	The status of the purchase order.	Yes	No	No
`supplier_id`	Supplier Id	UUID	The unique identifier for the supplier associated with the purchase order.	Yes	No	No
`total_spend_against`	Total Spend Against	currency	Total associated spend against the purchase order.	Yes	No	No
`vendor_name`	Vendor Name	string	The name of the vendor associated with the purchase order.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Report Jobs

Resource name: report_jobs

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`error_message`	Error Message	string	The error message associated with the report job, if any.	Yes	No	No
`id`	Id	UUID		No	No	No
`query`	Query	object	The query used to generate the report.	Yes	No	No
`rows`	Rows	number	The number of rows in the generated report.	Yes	No	No
`status`	Status	string	The current status of the report job. "E" - The job has errored and will be not be available for download. "P" - The job is currently processing. "C" - The job has completed and is available for download. Allowed values: `P`, `C`, `E`.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No

Savings Events

Resource name: savings_events

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for the application related to the savings event.	Yes	Yes	Yes
`description`	Description	string	Description of the savings event.	Yes	Yes	Yes
`event_type`	Event Type	string	Type of the savings event.	Yes	Yes	Yes
`exclude_from_event_total`	Exclude From Event Total	boolean	If checked, event will be excluded from aggregated event statistics and total event count.	Yes	Yes	Yes
`id`	Id	UUID	Unique identifier for a savings event.	No	No	No
`is_custom`	Is Custom	boolean	Yes/No field to indicate if the event is custom or created by Zylo.	Yes	No	No
`manual`	Manual	boolean	Whether the savings event was entered manually rather than generated by the system.	Yes	No	No
`monetary_value`	Monetary Value	currency	Monetary value of the savings event.	Yes	Yes	Yes
`name`	Name	string	Name of the savings event.	Yes	Yes	Yes
`notes`	Notes	string	Notes of the savings event.	Yes	Yes	Yes
`numerical_value`	Numerical Value	string	The numerical value of the savings event. This must be not null if the unit of measure is not null.	Yes	Yes	Yes
`origin`	Origin	string	Indicates if the savings event is system or user generated.	Yes	No	No
`quantity`	Quantity	string	The numerical value of the savings event combined with its unit of measure (e.g. "10 licenses").	Yes	No	No
`savings_per_unit`	Savings Per Unit	number	Savings per unit for the savings event.	Yes	No	No
`transaction_date`	Transaction Date	date	Date of the transaction for the savings event.	Yes	Yes	Yes
`unit_of_measure`	Unit Of Measure	string	The unit of measure for the numerical value of the savings event. This must be not null if the numerical value is not null. Allowed values: `Application`, `Contract`, `Licenses`, `Survey`, `Users`.	Yes	Yes	Yes
`user_override`	User Override	boolean	Whether or not the savings event has been overridden with data by the user.	Yes	No	Yes
`value_type`	Value Type	string	Category that classifies the savings event by stage and kind. 'Realized Savings' and 'Realized Avoidance' represent value that has already been captured. 'Identified Savings' and 'Identified Avoidance' represent projected value that has not yet been realized. 'Informational' represents non-monetary tracking entries. Savings reduce committed spend; avoidance prevents new spend from being incurred. Allowed values: `Identified Avoidance`, `Identified Savings`, `Informational`, `Realized Avoidance`, `Realized Savings`.	Yes	Yes	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_created_by`	Zylo Created By	string	The user or entity that created the savings event.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No
`zylo_modified_by`	Zylo Modified By	string	The user or entity that last modified the savings event.	Yes	No	No

Suppliers

Resource name: suppliers

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`description`	Description	string	The supplier description.	Yes	No	No
`domain`	Domain	string	The supplier domain.	Yes	No	No
`id`	Id	UUID	The supplier id.	No	No	No
`name`	Name	string	The supplier name.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Unmatched Payments

Resource name: unmatched_payments

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`amount`	Amount	currency	Line item amount of the payment, mapped from payment data source.	Yes	No	No
`expense_type`	Expense Type	string	Expense type of the payment (e.g. Software & Subscriptions), mapped from payment data source.	Yes	No	No
`external_po_number`	Source System PO Number	string	Purchase Order Number as identified by the payment source system.	Yes	No	No
`id`	Id	UUID	The unmatched payment id.	No	No	No
`payment_date`	Payment Date	date	Date the payment occurred (e.g. Paid Date or Transaction Date), mapped from payment data source.	Yes	No	No
`payment_description`	Description	string	Description of the transaction, mapped from payment data source.	Yes	No	No
`payment_name`	Name	string	Name of payment, vendor, or supplier, mapped from payment data source.	Yes	No	No
`payment_type`	Type	string	Zylo's classification of the payment, AP (accounts payable) or Expense, based on the payment data source.	Yes	No	No
`po_line_item_id`	Po Line Item Id	UUID	The ID for the PO Line Item associated to this payment.	Yes	No	No
`purchase_order_id`	Purchase Order Id	UUID	The ID for the Purchase Order associated to this payment.	Yes	No	No
`reseller`	Reseller	string	Reseller the payment was processed through.	Yes	No	No
`saas_confidence`	SaaS Confidence	string	This score represents the confidence of Zylo's proprietary AI model in classifying a payment as SaaS spend. Higher scores indicate greater certainty in the classification.	Yes	No	No
`source`	Source	string	Source of the payment.	Yes	No	No
`supplier_name`	Supplier	string	Name of the supplier associated with this payment.	Yes	No	No
`transaction_id`	Transaction Id	string	Unique transaction ID of the payment, mapped from payment data source if available, or a Zylo-generated unique ID.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No

Usage Connect

Resource name: usage_connect

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`app_label`	App Label	string	The label for the application.	Yes	No	No
`application_id`	Application Id	UUID	Unique identifier for the application associated with the usage connection.	No	No	No
`data_type`	Data Type	string	The type of data imported through the connection.	Yes	No	No
`delivery_method`	Delivery Method	string	The process in which the data is being imported.	Yes	No	No
`errored_rows`	Errored Rows	number	Number of rows that had an error.	Yes	No	No
`file_name`	File Name	string	The display name on the imported file.	Yes	No	No
`id`	Id	UUID	Unique identifier for the usage connection import job.	No	No	No
`import_status`	Import Status	string	The state of the file import. Allowed values: `new`, `pending`, `ignore`, `complete`, `error`.	Yes	No	No
`integration_id`	Integration Id	UUID	Unique identifier for the integration associated with the usage connection.	No	No	No
`message`	Message	string	This field contains information about the connection. It may contain error details or status updates.	Yes	No	No
`successful_rows`	Successful Rows	number	Number of rows that successfully imported.	Yes	No	No
`upload_date`	Upload Date	datetime	The date the file was uploaded.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No

User Stats

Resource name: user_stats

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`active_applications`	Active Applications	number	Count of provisioned applications with tracked activity in the app's activity threshold.	Yes	No	No
`applications`	Applications	number	Count of provisioned applications the user has access to.	Yes	No	No
`cost_centers`	Cost Centers	array	Distinct cost centers the user has expenses tied to in the last 12 months.	Yes	No	No
`cost_per_user`	Cost Per User	currency	Total cost of the user (Showbacks feature).	Yes	No	No
`email`	Email	email	User email — join key against `users`.	Yes	No	No
`expense_spend`	Expense Spend	currency	Total Expense payments made by the user in the last 12 months.	Yes	No	No
`expensed_apps_count`	Expensed Apps Count	number	Count of unique applications the user has Expense payments against in the last 12 months.	Yes	No	No
`full_name`	Full Name	string	Full name of the user as resolved by the pre-aggregation.	Yes	No	No
`inactive_cost_per_user`	Inactive Cost Per User	currency	Sum of the cost-per-user for applications where the user is inactive.	Yes	No	No
`last_expense_transaction_date`	Last Expense Transaction Date	datetime	Most recent Expense transaction date across payment sources.	Yes	No	No

Users

Resource name: users

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`apps_owned`	Apps Owned	number	Number of applications that the user has been set as one of the types of "owner" within Zylo: Application Owner, Business Owner, or IT Owner.	Yes	No	No
`custom_fields`	Custom Fields	object	Values for custom fields associated with this User.	Yes	Yes	Yes
`date_disabled`	Date Disabled	date	The date at which the user's status was marked as disabled.	Yes	No	No
`email`	Email	email	A user's email via any direct, HR, or SSO integration.	Yes	No	No
`email_domain`	Email Domain	string	The email domain of the user's email.	Yes	No	No
`external_status`	External Status	string	User's external status as it comes in directly from your Employee Roster.	Yes	No	No
`full_name`	Full Name	string	A user's full name via any direct, HR, SSO integration, or will be pulled from the Employee Roster if one is setup. Use the link below for setup steps.	Yes	No	No
`id`	Id	UUID	A user's Zylo id.	No	No	No
`in_employee_roster`	In Employee Roster	boolean	Whether the user's email matches an active record in the Employee Roster. This is the best indicator for identifying departed or former employees — filter on in_employee_roster = false to find users who are no longer at the company or were never imported into the roster.	Yes	No	No
`is_archived`	Is Archived	boolean	Marked as archived if Zylo account has been deleted from the Team page.	Yes	No	No
`notes`	Notes	string	Any notes a Zylo account has associated with a user.	Yes	Yes	Yes
`tags`	Tags	array	Any tags a Zylo account has associated with a user.	Yes	Yes	Yes
`user_data`	User Data	object	Data about the user from the Employee Roster. Any inner key can be referenced with dot notation (e.g. `user_data.department`).	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the user was first added to Zylo, either by an admin or from an integration.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No
`zylo_status`	Zylo Status	string	Whether a user is considered active or disabled based on the External Status propagated from the Employee Roster. This field only reflects an explicitly set status and may remain empty when a user departs. To identify departed or former users, prefer in_employee_roster instead.	Yes	No	No

View Applications

Resource name: view_applications

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for an Application.	No	Yes	Yes
`id`	Id	string		Yes	No	No
`view_id`	View Id	UUID	Unique identifier for a view.	No	Yes	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No

View Zylo Users

Resource name: view_zylo_users

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`id`	Id	string		Yes	No	No
`view_id`	View Id	UUID	Unique identifier for a view.	No	Yes	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No
`zylo_user_id`	Zylo User Id	UUID	Unique identifier for a Zylo user.	No	Yes	Yes

Views

Resource name: views

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`id`	Id	UUID	Unique identifier for the view.	No	No	No
`is_dynamic`	Is Dynamic	boolean	Whether the view is dynamically adjusting applications within the view.	Yes	No	No
`name`	Name	string	Name of the view. Must be unique.	Yes	Yes	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the view was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the view was last modified in Zylo.	Yes	No	No

Workflow Responses

Resource name: workflow_responses

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for the application associated with the workflow response.	Yes	No	No
`email`	Email	email	Email for the user responding to the workflow.	Yes	No	No
`id`	Id	UUID	Unique identifier for a workflow response.	No	No	No
`response`	Response	boolean	Whether the user responded to the workflow.	Yes	No	No
`response_at`	Response At	date	The date the user responded to the workflow.	Yes	No	No
`response_text`	Response Text	string	The user's text response to the workflow.	Yes	No	No
`workflow_id`	Workflow Id	UUID	Unique identifier for the workflow associated with the workflow response.	No	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Workflows

Resource name: workflows

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`application_id`	Application Id	UUID	Unique identifier for the application associated with the workflow.	Yes	No	No
`current_step`	Current Step	string	The current step of the workflow. Allowed values: `Review Users`, `Send Email`, `Review Responses`, `Deprovision & Notify`, `Complete Workflow`.	Yes	No	No
`current_step_index`	Current Step Index	number	The current step index of the workflow.	Yes	No	No
`id`	Id	UUID	Unique identifier for a workflow.	No	No	No
`last_day_to_respond`	Last Day To Respond	string	The last day to respond to the workflow.	Yes	No	No
`name`	Name	string	The name of the workflow.	Yes	No	No
`status`	Status	string	The status of the workflow. Allowed values: `Action Needed`, `In Progress`, `Not Started`, `Complete`, `Errored`, `Skipped`.	Yes	No	No
`total_step_count`	Total Step Count	number	The total step count of the workflow.	Yes	No	No
`users_actioned`	Users Actioned	number	The number of users who have taken action on the workflow.	Yes	No	No
`users_qualified`	Users Qualified	number	The number of users who have met the criteria for the workflow.	Yes	No	No
`users_responded`	Users Responded	string	The number of users who have responded to the workflow.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo. Uses the created date by default.	Yes	No	No

Zybrary

Resource name: zybrary

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`app_description`	App Description	string	The application description.	Yes	No	No
`app_domain`	App Domain	string	The application domain.	Yes	No	No
`app_name`	App Name	string	The application name.	Yes	No	No
`id`	Id	UUID	Unique identifier for a Zybrary application.	No	No	No
`zybrary_supplier_id`	Zybrary Supplier Id	UUID	The supplier id associated with the application, if applicable.	Yes	No	No
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No

Zylo Users

Resource name: zylo_users

Field	Display Name	Type	Description	Nullable	Can Add	Can Update
`email`	Email	email	The email of the Zylo user.	Yes	Yes	No
`first_name`	First Name	string	The first name of the Zylo user.	Yes	Yes	No
`id`	Id	UUID	Unique identifier for a Zylo user.	No	No	No
`in_view`	In View	boolean	Whether the Zylo user is in a view.	Yes	No	No
`last_login`	Last Login	datetime	The date and time of the last login for the Zylo user.	Yes	No	No
`last_name`	Last Name	string	The last name of the Zylo user.	Yes	Yes	No
`permissions`	Permissions	array	Roles assigned to this Zylo user. Updating permissions replaces the entire set — any role omitted from the request is removed, not merged. See the permissions reference for the full list of available roles.	Yes	Yes	Yes
`zylo_created_at`	Zylo Created At	datetime	Date and time the record was created in Zylo.	Yes	No	No
`zylo_modified_at`	Zylo Modified At	datetime	Date and time the record was last modified in Zylo.	Yes	No	No
`zylo_user_account_id`	Zylo User Account Id	UUID		No	Yes	Yes

Field Type Reference

string: Text value
number: Numeric value (integer or decimal)
boolean: True/false value
date: Date in YYYY-MM-DD format
datetime: Date and time in ISO 8601 format
UUID: Universally unique identifier
email: Email address format
JSON: Complex JSON object or array
array: Array of values