{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:codat-assess/get-accounts-for-enhanced-balance-sheet":{"get":{"operationId":"finance_codat_assess_get_accounts_for_enhanced_balance_sheet","summary":"Enhanced Balance Sheet Accounts","description":"GET /companies/{companyId}/reports/enhancedBalanceSheet/accounts","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-enhanced-cash-flow-transactions":{"get":{"operationId":"finance_codat_assess_get_enhanced_cash_flow_transactions","summary":"Get enhanced cash flow report","description":"GET /companies/{companyId}/reports/enhancedCashFlow/transactions","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-enhanced-invoices-report":{"get":{"operationId":"finance_codat_assess_get_enhanced_invoices_report","summary":"Enhanced Invoices Report","description":"GET /companies/{companyId}/reports/enhancedInvoices","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-accounts-for-enhanced-profit-and-loss":{"get":{"operationId":"finance_codat_assess_get_accounts_for_enhanced_profit_and_loss","summary":"Enhanced Profit and Loss Accounts","description":"GET /companies/{companyId}/reports/enhancedProfitAndLoss/accounts","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-data-integrity-details":{"get":{"operationId":"finance_codat_assess_get_data_integrity_details","summary":"Lists data integrity details for date type","description":"GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"dataType","in":"query","required":true,"description":"A key for a Codat data type.","schema":{"type":"string","enum":["banking-accounts","banking-transactions","bankAccounts","accountTransactions"],"description":"A key for a Codat data type."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-data-integrity-status":{"get":{"operationId":"finance_codat_assess_get_data_integrity_status","summary":"Get data integrity status","description":"GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"dataType","in":"query","required":true,"description":"A key for a Codat data type.","schema":{"type":"string","enum":["banking-accounts","banking-transactions","bankAccounts","accountTransactions"],"description":"A key for a Codat data type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-data-integrity-summaries":{"get":{"operationId":"finance_codat_assess_get_data_integrity_summaries","summary":"Get data integrity summary","description":"GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"dataType","in":"query","required":true,"description":"A key for a Codat data type.","schema":{"type":"string","enum":["banking-accounts","banking-transactions","bankAccounts","accountTransactions"],"description":"A key for a Codat data type."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-excel-report-generation-status":{"get":{"operationId":"finance_codat_assess_get_excel_report_generation_status","summary":"Get status of Excel report","description":"GET /data/companies/{companyId}/assess/excel","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"reportType","in":"query","required":true,"description":"The type of report you want to generate and download.","schema":{"type":"string","enum":["audit","enhancedFinancials"],"description":"The type of report you want to generate and download."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/generate-excel-report":{"post":{"operationId":"finance_codat_assess_generate_excel_report","summary":"Generate an Excel report","description":"POST /data/companies/{companyId}/assess/excel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyId","reportType"],"properties":{"companyId":{"type":"string","description":"Unique identifier for your SMB in Codat."},"reportType":{"type":"string","enum":["audit","enhancedFinancials"],"description":"The type of report you want to generate and download."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-excel-report":{"get":{"operationId":"finance_codat_assess_get_excel_report","summary":"Download generated excel report","description":"GET /data/companies/{companyId}/assess/excel/download","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"reportType","in":"query","required":true,"description":"The type of report you want to generate and download.","schema":{"type":"string","enum":["audit","enhancedFinancials"],"description":"The type of report you want to generate and download."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-accounting-marketing-metrics":{"get":{"operationId":"finance_codat_assess_get_accounting_marketing_metrics","summary":"Get the marketing metrics from an accounting source for a given company.","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"periodLength","in":"query","required":true,"description":"The number of months per period. E.g. 2 = 2 months per period.","schema":{"type":"integer","description":"The number of months per period. E.g. 2 = 2 months per period."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}},{"name":"periodUnit","in":"query","required":true,"description":"The period unit of time returned.","schema":{"type":"string","enum":["Day","Week","Month","Year"],"description":"The period unit of time returned."}},{"name":"includeDisplayNames","in":"query","required":false,"description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.","schema":{"type":"boolean","description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable."}},{"name":"showInputValues","in":"query","required":false,"description":"If set to true, then the system includes the input values within the response.","schema":{"type":"boolean","description":"If set to true, then the system includes the input values within the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-commerce-customer-retention-metrics":{"get":{"operationId":"finance_codat_assess_get_commerce_customer_retention_metrics","summary":"Get the customer retention metrics for a specific company.","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"periodLength","in":"query","required":true,"description":"The number of months per period. E.g. 2 = 2 months per period.","schema":{"type":"integer","description":"The number of months per period. E.g. 2 = 2 months per period."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}},{"name":"periodUnit","in":"query","required":true,"description":"The period unit of time returned.","schema":{"type":"string","enum":["Day","Week","Month","Year"],"description":"The period unit of time returned."}},{"name":"includeDisplayNames","in":"query","required":false,"description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.","schema":{"type":"boolean","description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-commerce-lifetime-value-metrics":{"get":{"operationId":"finance_codat_assess_get_commerce_lifetime_value_metrics","summary":"Get the lifetime value metric for a specific company.","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"periodLength","in":"query","required":true,"description":"The number of months per period. E.g. 2 = 2 months per period.","schema":{"type":"integer","description":"The number of months per period. E.g. 2 = 2 months per period."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}},{"name":"periodUnit","in":"query","required":true,"description":"The period unit of time returned.","schema":{"type":"string","enum":["Day","Week","Month","Year"],"description":"The period unit of time returned."}},{"name":"includeDisplayNames","in":"query","required":false,"description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.","schema":{"type":"boolean","description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-commerce-orders-metrics":{"get":{"operationId":"finance_codat_assess_get_commerce_orders_metrics","summary":"Get order information for a specific company","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"periodLength","in":"query","required":true,"description":"The number of months per period. E.g. 2 = 2 months per period.","schema":{"type":"integer","description":"The number of months per period. E.g. 2 = 2 months per period."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}},{"name":"periodUnit","in":"query","required":true,"description":"The period unit of time returned.","schema":{"type":"string","enum":["Day","Week","Month","Year"],"description":"The period unit of time returned."}},{"name":"includeDisplayNames","in":"query","required":false,"description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.","schema":{"type":"boolean","description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-commerce-refunds-metrics":{"get":{"operationId":"finance_codat_assess_get_commerce_refunds_metrics","summary":"Get the refunds information for a specific company","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"periodLength","in":"query","required":true,"description":"The number of months per period. E.g. 2 = 2 months per period.","schema":{"type":"integer","description":"The number of months per period. E.g. 2 = 2 months per period."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}},{"name":"periodUnit","in":"query","required":true,"description":"The period unit of time returned.","schema":{"type":"string","enum":["Day","Week","Month","Year"],"description":"The period unit of time returned."}},{"name":"includeDisplayNames","in":"query","required":false,"description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.","schema":{"type":"boolean","description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-commerce-revenue-metrics":{"get":{"operationId":"finance_codat_assess_get_commerce_revenue_metrics","summary":"Commerce Revenue Metrics","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"reportDate","in":"query","required":true,"description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.","schema":{"type":"string","description":"The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month."}},{"name":"periodLength","in":"query","required":true,"description":"The number of months per period. E.g. 2 = 2 months per period.","schema":{"type":"integer","description":"The number of months per period. E.g. 2 = 2 months per period."}},{"name":"numberOfPeriods","in":"query","required":true,"description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…","schema":{"type":"integer","description":"The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to…"}},{"name":"periodUnit","in":"query","required":true,"description":"The period unit of time returned.","schema":{"type":"string","enum":["Day","Week","Month","Year"],"description":"The period unit of time returned."}},{"name":"includeDisplayNames","in":"query","required":false,"description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.","schema":{"type":"boolean","description":"Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/get-recurring-revenue-metrics":{"get":{"operationId":"finance_codat_assess_get_recurring_revenue_metrics","summary":"Get key metrics for subscription revenue","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-assess/request-recurring-revenue-metrics":{"get":{"operationId":"finance_codat_assess_request_recurring_revenue_metrics","summary":"Request production of key subscription revenue metrics","description":"GET /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/process","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}