openapi: 3.2.0 info: title: FIS® Accounting Data as a Service™ Visualizations API description: What's changed in our API version: v2 contact: {} servers: - url: https://api.railz.ai description: Main (production) API server tags: - name: Visualizations paths: /v2/visualizations/invoices: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `oracleNetsuite` `sageBusinessCloud` `sageIntacct` `dynamicsBusinessCentral` `dynamics365Finance` `wave` `myob` `zohoBooks`' operationId: reportInvoices parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string responses: '200': description: Successfully returned invoices report content: application/json: schema: type: object readOnly: true properties: meta: type: object readOnly: true properties: reportId: type: array items: type: string readOnly: true example: - 5fad8a342a88364234392fb5 serviceName: type: string readOnly: true enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod example: xero businessName: type: string readOnly: true example: Railz createdAt: type: string readOnly: true example: '2020-12-25T01:02:03Z' updatedAt: type: string readOnly: true example: '2020-12-25T01:02:03Z' endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' required: - reportId - serviceName - businessName - endDate - startDate data: type: object readOnly: true properties: unpaidAmount: type: number description: sum of amount due minimum: 0 example: 0 paidAmount: type: number description: sum (latestAmount - amountDue) minimum: 0 example: 1000 overdueAmount: type: number description: where current Date > dueDate, sum amountDue minimum: 0 required: - unpaidAmount - paidAmount - overdueAmount required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Invoices report tags: - Visualizations /v2/visualizations/bills: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `oracleNetsuite` `sageBusinessCloud` `sageIntacct` `dynamicsBusinessCentral` `dynamics365Finance` `myob` `zohoBooks`' operationId: reportBills parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string responses: '200': description: Successfully returned bills report content: application/json: schema: type: object readOnly: true properties: meta: type: object readOnly: true properties: reportId: type: array items: type: string readOnly: true example: - 5fad8a342a88364234392fb5 serviceName: type: string readOnly: true enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod example: xero businessName: type: string readOnly: true example: Railz createdAt: type: string readOnly: true example: '2020-12-25T01:02:03Z' updatedAt: type: string readOnly: true example: '2020-12-25T01:02:03Z' endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' required: - reportId - serviceName - businessName - endDate - startDate data: type: object readOnly: true properties: unpaidAmount: type: number description: sum of amount due minimum: 0 example: 0 paidAmount: type: number description: sum (latestAmount - amountDue) minimum: 0 example: 1000 overdueAmount: type: number description: where current Date > dueDate, sum amountDue minimum: 0 required: - unpaidAmount - paidAmount - overdueAmount required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Bills report tags: - Visualizations /v2/visualizations/revenue: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: reportRevenue parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: reportFrequency required: true in: query description: The report snapshot frequency. schema: enum: - month - quarter - year type: string - name: accountingMethod required: false in: query schema: default: accrual type: string enum: - cash - accrual responses: '200': description: Successfully returned revenue report content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' reportFrequency: type: string readOnly: true example: month enum: - month - quarter - year currency: type: string readOnly: true example: USD required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: object readOnly: true properties: subSections: type: array description: 'For each subsection, get its end date values and return the top 3 and the remaining sub section values should be summed up and indicated in the last object where name = ''Other'' ' items: type: object readOnly: true properties: name: type: string example: Operating Expenses description: Sub section with the largest amount amount: type: number example: 1200 minimum: 0 description: Total of all values in the expenses section in incomeStatement results example: - name: Utilities amount: 2300 - name: Service Fee Income amount: 1000 - name: Other amount: 200 required: - name - amount totalAmount: type: number example: 3500 description: Total of all values in the expenses section in incomeStatement results as at end date percentageChange: type: number example: 15 description: Percentage change between previous period and current end date period required: - totalAmount - percentChange - subSections readOnly: true required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Revenue report tags: - Visualizations /v2/visualizations/expenses: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: reportExpenses parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: reportFrequency required: true in: query description: The report snapshot frequency. schema: enum: - month - quarter - year type: string - name: accountingMethod required: false in: query schema: default: accrual type: string enum: - cash - accrual responses: '200': description: Successfully returned expenses report content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' reportFrequency: type: string readOnly: true example: month enum: - month - quarter - year currency: type: string readOnly: true example: USD required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: object readOnly: true properties: subSections: type: array description: 'For each subsection, get its end date values and return the top 3 and the remaining sub section values should be summed up and indicated in the last object where name = ''Other'' ' items: type: object readOnly: true properties: name: type: string example: Operating Expenses description: Sub section with the largest amount amount: type: number example: 1200 minimum: 0 description: Total of all values in the expenses section in incomeStatement results example: - name: Utilities amount: 2300 - name: Service Fee Income amount: 1000 - name: Other amount: 200 required: - name - amount totalAmount: type: number example: 3500 description: Total of all values in the expenses section in incomeStatement results as at end date percentageChange: type: number example: 15 description: Percentage change between previous period and current end date period required: - totalAmount - percentChange - subSections readOnly: true required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Expenses report tags: - Visualizations /v2/visualizations/cashflowStatements: get: description: '**Supported for:** `quickbooks` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: reportCashflowStatements parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: reportFrequency required: true in: query description: The report snapshot frequency. schema: enum: - month - quarter - year type: string - name: accountingMethod required: false in: query schema: default: accrual type: string enum: - cash - accrual responses: '200': description: Successfully returned cashflow report content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' reportFrequency: type: string readOnly: true example: month enum: - month - quarter - year currency: type: array readOnly: true example: - USD items: type: string required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: array readOnly: true items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date operatingActivities: type: number readOnly: true example: 345 financingActivities: type: number readOnly: true example: 345 investingActivities: type: number readOnly: true example: 345 netCash: type: number readOnly: true example: 345 required: - period - operatingActivities - financingActivities - investingActivities - netCash readOnly: true required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Cashflow report tags: - Visualizations /v2/visualizations/incomeStatements: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: reportIncomeStatements parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: reportFrequency required: true in: query description: The report snapshot frequency. schema: enum: - month - quarter - year type: string - name: accountingMethod required: false in: query schema: default: accrual type: string enum: - cash - accrual responses: '200': description: Successfully returned income statements report content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' reportFrequency: type: string readOnly: true example: month enum: - month - quarter - year currency: type: array readOnly: true example: - USD items: type: string required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: array readOnly: true items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date operatingIncome: type: number readOnly: true example: 345 operatingExpenses: type: number readOnly: true example: 345 costOfGoodsSold: type: number readOnly: true example: 345 otherIncome: type: number readOnly: true example: 345 otherExpenses: type: number readOnly: true example: 345 netIncome: type: number readOnly: true example: 345 required: - period - operatingIncome - operatingExpenses - costOfGoodsSold - otherIncome - otherExpenses - netIncome readOnly: true required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Income Statements report tags: - Visualizations /v2/visualizations/balanceSheets: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: reportBalanceSheets parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: reportFrequency required: true in: query description: The report snapshot frequency. schema: enum: - month - quarter - year type: string - name: accountingMethod required: false in: query schema: default: accrual type: string enum: - cash - accrual responses: '200': description: Successfully returned balance sheets content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' reportFrequency: type: string readOnly: true example: month enum: - month - quarter - year currency: type: array readOnly: true example: - USD items: type: string required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: array readOnly: true items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date currentAssets: type: number readOnly: true example: 345 nonCurrentAssets: type: number readOnly: true example: 345 currentLiabilities: type: number readOnly: true example: 345 nonCurrentLiabilities: type: number readOnly: true example: 345 equity: type: number readOnly: true example: 345 required: - period - assets - liabilities - equity readOnly: true required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Balance Sheets report tags: - Visualizations /v2/visualizations/financialRatios: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: reportFinancialRatios parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: reportFrequency required: true in: query description: The report snapshot frequency. schema: enum: - month - quarter - year type: string responses: '200': description: Successfully returned financial ratios content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' reportFrequency: type: string readOnly: true example: month enum: - month - quarter - year required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: object properties: credit: type: object readOnly: true properties: distanceToDefault: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData probabilityOfDefault: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData liquidationValue: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData efficiency: type: object readOnly: true properties: grossBurnRate: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData inventoryTurnoverRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData assetTurnoverRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData leverage: type: object readOnly: true properties: equityToLTAssets: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData shortDebtToEquityRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData debtToEquityRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData interestBankLoan: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData interestCoverageRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData debtToAssetsRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData debtServiceCoverageRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData liquidity: type: object readOnly: true properties: quickRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData absoluteLiquidity: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData currentRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData grossBurn: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData runway: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData cashRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData freeCashflowRatio: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData profitability: type: object readOnly: true properties: returnOnAssets: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData ebitda: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData ebitdaMargin: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData workingCapital: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData freeCashFlow: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData grossMargin: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData netProfitMargin: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData operatingMargin: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData returnOnEquity: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData revenueConcentrationIndex: type: object readOnly: true properties: currentValue: type: number description: Return on Assets - EBITDA calculation (a decimal value) example: 10 format: double percentageChange: type: number description: EBITDA (a dollar value) example: 10 format: double timePeriodData: type: array readOnly: true maxItems: 12 items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date value: type: number minimum: 0 example: 1000 required: - period - value required: - currentValue - percentageChange - timePeriodData readOnly: true required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Financial Ratios report tags: - Visualizations /v2/visualizations/railzScore: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: reportRailzScore parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: endDate required: false in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string responses: '200': description: Successfully returned credit score content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: object readOnly: true properties: score: type: integer description: A standard point in time credit score based on a 1-year probability of default in the range of 300-850. example: 800 minimum: 300 maximum: 850 rating: type: string description: Railz credit rating example: Excellent lastUpdated: type: string description: Last synchronization date example: '2020-12-31' required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Credit Score report tags: - Visualizations /v2/visualizations/credits: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: credits parameters: - name: connectionUuid required: true in: query schema: type: string - name: offset required: false in: query description: The offset is the position in the dataset of a particular record. schema: format: integer type: number - name: limit required: false in: query description: 'This is the size of the results set you would like (default: 100).' schema: format: integer example: 100 type: number - name: orderBy required: false in: query schema: type: string - name: startDate required: false in: query schema: type: string - name: endDate required: false in: query schema: type: string - name: reconstruct required: false in: query description: Railz reconstructed Credit Score. schema: default: 'false' type: string enum: - 'true' - 'false' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CreditsResponseDto' '202': description: Data in pending state content: application/json: schema: $ref: '#/components/schemas/CreditsResponseDto' '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Credit report tags: - Visualizations /v2/visualizations/bankAccounts: get: description: '**Supported for:** `plaid`' operationId: bankAccountsVisualizations parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 type: string - name: offset required: false in: query schema: format: integer type: number - name: limit required: false in: query schema: format: integer example: 100 type: number - name: orderBy required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetBankAccountResponseV2Dto' '202': description: Data in pending state content: application/json: schema: $ref: '#/components/schemas/GetBankAccountResponseV2Dto' '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Bank Account tags: - Visualizations /v2/visualizations/bankReconciliation: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `oracleNetsuite` `sageBusinessCloud` `sageIntacct` `dynamicsBusinessCentral` `myob`' operationId: bankReconciliationVisualizations parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 type: string - name: startDate required: false in: query description: 'The start date of the Transaction report frequency in the format: YYYY-MM-DD.' schema: type: string - name: endDate required: false in: query description: 'The end date of the Transaction report frequency in the format: YYYY-MM-DD.' schema: type: string - name: offset required: false in: query description: The offset is the position in the dataset of a particular record. schema: format: integer type: number - name: limit required: false in: query description: 'This is the size of the results set you would like (default: 100).' schema: format: integer example: 100 type: number - name: orderBy required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BankReconciliationResponseV2Dto' '202': description: Data in pending state content: application/json: schema: $ref: '#/components/schemas/BankReconciliationResponseV2Dto' '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Banking Reconciliations tags: - Visualizations /v2/visualizations/businessValuations: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: businessValuationVisualizations parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 type: string - name: startDate required: false in: query schema: type: string - name: endDate required: false in: query schema: type: string - name: reconstruct required: false in: query description: Railz reconstructed Business Valuation schema: default: 'false' type: string enum: - 'true' - 'false' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BusinessValuationResponseV2Dto' '202': description: Data in pending state content: application/json: schema: $ref: '#/components/schemas/BusinessValuationResponseV2Dto' '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Business Valuations tags: - Visualizations /v2/visualizations/taxBenchmarking: get: operationId: taxbenchmarkingVisualizations parameters: - name: industryCode required: true in: query schema: example: '44' type: string - name: region required: false in: query schema: example: CA type: string - name: offset required: false in: query schema: format: integer type: number - name: limit required: false in: query schema: format: integer example: 100 type: number - name: orderBy required: false in: query schema: type: string - name: connectionUuid required: true in: query description: Unique connection identifier. schema: example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/TaxBenchmarkingVisualizationResponse' '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List of Tax Benchmarks tags: - Visualizations /v2/visualizations/financialForecasts: get: description: '**Supported for:** `freshbooks` `quickbooks` `quickbooksDesktop` `xero` `dynamicsBusinessCentral` `zohoBooks` `byod`' operationId: financialForecastsReport parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 type: string - name: startDate required: false in: query schema: type: string - name: endDate required: false in: query schema: type: string - name: financialStatementType required: true in: query schema: type: string enum: - balanceSheets - incomeStatements - cashflowStatements - name: reportFrequency required: true in: query schema: type: string enum: - month - quarter - year - name: percentile required: false in: query schema: format: float example: 0.05 type: number - name: reconstruct required: false in: query description: Railz reconstructed Financial Forecast schema: default: 'false' type: string enum: - 'true' - 'false' responses: '200': description: '' content: application/json: schema: type: object properties: meta: type: object readOnly: true properties: reportId: type: array readOnly: true example: - 5fad8a342a88364234392fb5 items: type: string serviceName: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod readOnly: true example: xero businessName: type: string readOnly: true example: Railz endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' description: if report frequency is monthly, end date is maximum of 12 months from start date, if quaterly, its a maximum of 3 years from start date, if yearly, its maximum of 12 years from start date startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' reportFrequency: type: string readOnly: true example: month enum: - month - quarter - year currency: type: array readOnly: true example: - USD items: type: string required: - reportId - serviceName - businessName - startDate - endDate - reportFrequency - currency data: type: array readOnly: true items: type: object readOnly: true properties: period: type: object readOnly: true properties: year: type: number example: 2020 month: type: number example: 8 minimum: 1 quarter: type: number example: 3 minimum: 1 day: type: number example: 31 minimum: 1 date: type: string example: '2020-08-31T00:00:00.000Z' minimum: 1 required: - year - month - quarter - day - date currentAssets: type: number readOnly: true example: 345 nonCurrentAssets: type: number readOnly: true example: 345 currentLiabilities: type: number readOnly: true example: 345 nonCurrentLiabilities: type: number readOnly: true example: 345 equity: type: number readOnly: true example: 345 operatingActivities: type: number readOnly: true example: 345 financingActivities: type: number readOnly: true example: 345 investingActivities: type: number readOnly: true example: 345 netCash: type: number readOnly: true example: 345 operatingIncome: type: number readOnly: true example: 345 operatingExpenses: type: number readOnly: true example: 345 costOfGoodsSold: type: number readOnly: true example: 345 otherIncome: type: number readOnly: true example: 345 otherExpenses: type: number readOnly: true example: 345 netIncome: type: number readOnly: true example: 345 required: - period readOnly: true required: - meta - data '202': description: Data in pending state '204': description: No data available '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Financial Forecast report tags: - Visualizations x-operation-id-source: normalized x-operation-id-original: financialForecasts report /v2/visualizations/financialForecasts/summaryEligibility: get: description: If the given connection is eligible to show financial forecast summary operationId: financialForecastsSummaryEligibility parameters: - name: connectionUuid required: true in: query description: Unique connection identifier. schema: type: string - name: startDate required: true in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: endDate required: true in: query description: 'The end date of the report frequency in the format: yyyy-MM-dd.' schema: type: string - name: reportFrequency required: true in: query schema: type: string enum: - month - quarter - year responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FinancialForecastsSummaryEligibilityResponse' '400': description: Bad Request Error - Thrown if fields sent via query does not follow specifications content: application/json: schema: $ref: '#/components/schemas/Error400ResponseDto' '401': description: Unauthorized - Not logged in or log in expired content: application/json: schema: $ref: '#/components/schemas/Error401ResponseDto' '403': description: Forbidden - Not enough permission content: application/json: schema: $ref: '#/components/schemas/Error403ResponseDto' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error500ResponseDto' security: - bearer: [] summary: List Financial Forecast Summary Eligibility tags: - Visualizations x-operation-id-source: normalized x-operation-id-original: financialForecasts summary eligibility components: schemas: FinancialStatementReportMetaDataV2: type: object properties: connectionUuid: type: string readOnly: true example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 businessName: type: string readOnly: true example: Railz serviceName: type: string readOnly: true example: xero enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod reportId: type: string readOnly: true example: 5fad8a342a88364234392fb5 status: type: string readOnly: true example: success enum: - success - failed - pending - empty reportFrequency: type: string readOnly: true example: month currency: type: string example: USD createdAt: type: string readOnly: true example: '2020-11-25T01:02:03Z' format: date-time updatedAt: type: string readOnly: true example: '2020-11-30T01:02:03Z' format: date-time startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' endDate: type: string readOnly: true example: '2020-12-25T01:02:03Z' accountingMethod: type: string readOnly: true example: accrual enum: - cash - accrual required: - connectionUuid - businessName - serviceName - reportId - status - reportFrequency - createdAt - updatedAt - startDate - endDate - accountingMethod BusinessValuationData: type: object properties: liquidationValue: type: number example: 100000 format: double discountedCashflowValue: type: number example: 100000 format: double discountRate: type: number example: 0.12 format: double revenueMultiple: type: number example: 1.6 format: double multipleToRevenueValue: type: number example: 100000 format: double firstChicagoValue: type: number example: 100000 format: double Error401Dto: type: object properties: statusCode: type: number readOnly: true example: 401 message: readOnly: true example: - Unauthorized type: array items: type: string error: type: string readOnly: true example: Unauthorized required: - statusCode - message - error CreditsData: type: object properties: scorePit: type: number minimum: 300 maximum: 850 example: 800 format: integer readOnly: false score12m: type: number minimum: 300 maximum: 850 example: 800 format: integer readOnly: false score24m: type: number minimum: 300 maximum: 850 example: 800 format: integer readOnly: false score36m: type: number minimum: 300 maximum: 850 example: 800 format: integer readOnly: false spRating: type: string enum: - AAA - AA+ - AA - AA- - A+ - A - A- - BBB+ - BBB - BBB- - BB+ - BB - BB- - B+ - B - B- - CCC+ - CCC - CCC- - CC - C - D example: AA+ moodysRating: type: string enum: - Aaa - Aa1 - Aa2 - Aa3 - A1 - A2 - A3 - Baa1 - Baa2 - Baa3 - Ba1 - Ba2 - Ba3 - B1 - B2 - B3 - Caa1 - Caa2 - Ca - C example: Aaa fitchRating: type: string enum: - AAA - AA+ - AA - AA- - A+ - A - A- - BBB+ - BBB - BBB- - BB+ - BB - BB- - B+ - B - B- - CCC - DDD - DD - D example: AA+ dbrsRating: type: string enum: - AAA - AA (high) - AA - AA (low) - A (high) - A - A (low) - BBB (high) - BBB - BBB (low) - BB (high) - BB - BB (low) - CCC (high) - CCC - CCC (low) - CC - C - D example: AAA railzRating: type: string enum: - A+ - A - A- - B+ - B - B- - C+ - C - C- - D example: A railzGrade: type: string enum: - Very Poor - Poor - Fair - Good - Very Good - Excellent example: Excellent description: type: string example: Highest quality borrower, minimal credit risk. required: - scorePit - score12m - score24m - score36m - spRating - moodysRating - fitchRating - dbrsRating - railzRating - railzGrade - description TaxBenchmarkingFormattedData: type: object properties: section: oneOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' allOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' subSection: oneOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' allOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' group: oneOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' allOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' subGroup: oneOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' allOf: - $ref: '#/components/schemas/TaxBenchmarkingSubItems' required: - section - subSection - group - subGroup FinancialForecastsSummaryEligibilityResponse: type: object properties: summaryAvailable: type: boolean responseMsg: type: string statementsList: type: array items: type: string required: - summaryAvailable - responseMsg - statementsList TaxBenchmarkingVisualizationResponse: type: object properties: meta: $ref: '#/components/schemas/FinancialStatementReportMetaDataV2' businessValues: $ref: '#/components/schemas/BusinessValuesFormattedData' taxBenchmarkingData: $ref: '#/components/schemas/TaxBenchmarkingFormattedData' required: - meta - businessValues - taxBenchmarkingData GetBankAccountResponseV2Dto: type: object properties: pagination: $ref: '#/components/schemas/PaginationMetaData' data: type: array items: $ref: '#/components/schemas/GetBankAccountData' meta: $ref: '#/components/schemas/BankAccountMetaDataV2' count: type: integer readOnly: true example: 1 deprecated: true required: - pagination - data - meta - count BankReconciliationReportMetaDataV2: type: object properties: connectionUuid: type: string readOnly: true example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 businessName: type: string readOnly: true example: Railz serviceName: type: string readOnly: true example: xero enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod reportId: type: string example: 5fad8a342a88364234392fb6 readOnly: true startDate: type: string example: '2020-11-25T01:02:03Z' readOnly: true format: date-time endDate: type: string example: '2020-11-30T01:02:03Z' readOnly: true format: date-time createdAt: type: string example: '2020-11-25T01:02:03Z' readOnly: true format: date-time updatedAt: type: string example: '2020-11-30T01:02:03Z' readOnly: false format: date-time required: - connectionUuid - businessName - serviceName - reportId - startDate - endDate - createdAt - updatedAt Error400ResponseDto: type: object properties: error: readOnly: true allOf: - $ref: '#/components/schemas/Error400Dto' payload: type: object readOnly: true required: - error - payload Error401ResponseDto: type: object properties: error: readOnly: true allOf: - $ref: '#/components/schemas/Error401Dto' payload: type: object readOnly: true example: {} required: - error - payload GetBankAccountData: type: object properties: institutionName: type: string example: TD Bank accountId: type: string example: blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo currentBalance: type: number format: float example: 110 availableBalance: type: number format: float example: 100 limit: type: number format: float example: 200 currency: type: string example: CAD maskedAccountNumber: type: string example: '4445' accountName: type: string example: Railz Checking officialAccountName: type: string example: Railz Gold Standard 0% Interest Checking accountType: type: string enum: - investment - credit - depository - loan - brokerage - other example: depository accountSubType: type: string example: checking sourceModifiedDate: type: string format: date-time example: '2021-03-09T10:18:29.985Z' required: - institutionName - accountId - currency - accountName - accountType BankTransactions: type: object properties: id: type: string example: lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje readOnly: false date: type: string example: '2017-01-29' readOnly: false format: date-time amount: type: number readOnly: false example: 1000 accountType: type: string example: investment, credit, depository, loan, brokerage, other accountId: type: string example: onD7kPQJ98cDejlnXpZeHeqp1qBlX5TogLqxW description: type: string example: BMO Bank of Montreal required: - id - date - amount - accountId TaxBenchmarkingSubItems: type: object properties: max: type: object mean: type: object median: type: object min: type: object quantile25: type: object quantile5: type: object quantile75: type: object quantile95: type: object sdev: type: object total: type: object required: - max - mean - median - min - quantile25 - quantile5 - quantile75 - quantile95 - sdev - total BankAccountMetaDataV2: type: object properties: connectionUuid: type: string readOnly: true example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 businessName: type: string readOnly: true example: Railz serviceName: type: string readOnly: true example: xero enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod reportId: readOnly: true example: - 5fad8a342a88364234392fb5 type: array items: type: string createdAt: type: string readOnly: true format: date-time example: '2020-12-25T01:02:03Z' updatedAt: type: string format: date-time example: '2020-12-25T01:02:03Z' required: - connectionUuid - businessName - serviceName - reportId - createdAt - updatedAt Error400Dto: type: object properties: statusCode: type: number readOnly: true example: 400 message: readOnly: true example: - businessName cannot be null type: array items: type: string error: type: string readOnly: true example: Bad Request required: - statusCode - message - error ReconcilationAccountRef: type: object properties: id: type: string example: '1334' readOnly: false name: type: string example: Account Receivable readOnly: false section: type: string example: Assets readOnly: false enum: - Assets - Expenses - Income - Liabilities - Equity subSection: type: string example: Current Assets readOnly: false enum: - Current Assets - Non-Current Assets - Current Liabilities - Non-Current Liabilities - Equity - Income - Other Income - Operating Expenses - Other Expenses - Cost of Goods Sold group: type: string example: Cash And Cash Equivalents readOnly: false subGroup: type: string example: Cash And Cash Equivalents readOnly: false required: - id - name PaginationMetaData: type: object properties: offset: type: number readOnly: true limit: type: number readOnly: true count: type: number readOnly: true required: - offset - limit - count EntityRef: type: object properties: id: type: string example: '233' name: type: string example: Railz Inc. required: - id BankReconciliationResponseV2Dto: type: object properties: pagination: $ref: '#/components/schemas/PaginationMetaData' count: type: number readOnly: true example: 1 format: integer deprecated: true reports: readOnly: false type: array items: $ref: '#/components/schemas/BankReconciliationReportV2' required: - pagination - count - reports BusinessValuationReportV2: type: object properties: meta: $ref: '#/components/schemas/BusinessValuationMetaDataV2' data: $ref: '#/components/schemas/BusinessValuationData' required: - meta - data BankReconciliationV2Data: type: object properties: bankTransactionsCount: type: number example: 35 accountingTransactionsCount: type: number example: 50 bankTransactionsAmount: type: number example: 105.5 format: float accountingTransactionsAmount: type: number example: 750.5 format: float bankTransactionsTotalValue: type: number example: 109.95 format: float accountingTransactionsTotalValue: type: number example: 500.5 format: float weightedPercentageError: type: number example: 1 format: float accuracyScore: type: number example: 50.5 format: float bankTransactionsUnreconciledCount: type: number example: 25 bankTransactionsUnreconciledAmount: type: number example: 109.95 format: float dailyAccuracyScore: type: number example: 0.24 format: float unreconciledBankTransactions: type: array items: $ref: '#/components/schemas/BankTransactions' reconciledBankTransactions: type: array items: $ref: '#/components/schemas/ReconciledBankTransactionsV2' required: - bankTransactionsCount - accountingTransactionsCount - bankTransactionsAmount - accountingTransactionsAmount - bankTransactionsTotalValue - accountingTransactionsTotalValue - weightedPercentageError - accuracyScore - bankTransactionsUnreconciledCount - bankTransactionsUnreconciledAmount - dailyAccuracyScore Error403ResponseDto: type: object properties: error: readOnly: true allOf: - $ref: '#/components/schemas/Error403Dto' payload: type: object readOnly: true example: {} required: - error - payload ReconciledBankTransactionsV2: type: object properties: id: type: string example: lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje readOnly: false date: type: string example: '2017-01-29' readOnly: false format: date-time amount: type: number readOnly: false example: 1000 accountType: type: string example: investment, credit, depository, loan, brokerage, other accountId: type: string example: onD7kPQJ98cDejlnXpZeHeqp1qBlX5TogLqxW description: type: string example: BMO Bank of Montreal accountingTransactionId: type: string example: 13 accountingTransactionType: type: string enum: - expense - invoice - payment - payroll - journalEntry - bill - vendorCreditNote - creditNote - billPayment - bankTransaction - transfer - deposit - refund - estimate - inventoryAdjustment - purchaseOrder - taxPayment - taxAdjustment - taxRefund - taxReversal - other - unknown isPosting: type: boolean example: 'true' isSplitTransaction: type: boolean example: 'true' subTotal: type: number example: 300.5 format: float transactionNumber: type: string example: INV-001 transactionReportId: type: string example: 5fad8a342a88364234392fb6 accountRef: $ref: '#/components/schemas/ReconcilationAccountRef' entityRef: $ref: '#/components/schemas/EntityRef' required: - id - date - amount - accountId - accountRef CreditsReport: type: object properties: meta: $ref: '#/components/schemas/CreditRatingsReportMetaData' data: $ref: '#/components/schemas/CreditsData' required: - meta - data BusinessValuationResponseV2Dto: type: object properties: count: type: number readOnly: true example: 1 format: integer reports: type: array items: $ref: '#/components/schemas/BusinessValuationReportV2' required: - count - reports Error500Dto: type: object properties: error: type: string readOnly: true example: Internal Server Error message: readOnly: true example: - INTERNAL_ERROR type: array items: type: string statusCode: type: number readOnly: true example: 500 required: - error - message - statusCode BusinessValuesFormattedData: type: object properties: section: type: object subSection: type: object group: type: object subGroup: type: object required: - section - subSection - group - subGroup BankReconciliationReportV2: type: object properties: meta: $ref: '#/components/schemas/BankReconciliationReportMetaDataV2' data: readOnly: false type: array items: $ref: '#/components/schemas/BankReconciliationV2Data' required: - meta - data Error403Dto: type: object properties: statusCode: type: number readOnly: true example: 403 message: readOnly: true example: - Forbidden resource type: array items: type: string error: type: string readOnly: true example: Forbidden required: - statusCode - message - error CreditRatingsReportMetaData: type: object properties: reportId: type: string readOnly: true example: 5fad8a342a88364234392fb5 serviceName: type: string readOnly: true example: xero enum: - quickbooks - xero - freshbooks - quickbooksDesktop - sageIntacct - sageBusinessCloud - oracleNetsuite - dynamicsBusinessCentral - dynamics365Finance - wave - zohoBooks - myob businessName: type: string readOnly: true example: Railz startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' format: date-time endDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' format: date-time createdAt: type: string readOnly: true example: '2020-12-25T01:02:03Z' format: date-time updatedAt: type: string readOnly: false example: '2020-11-30T01:02:03Z' format: date-time required: - reportId - serviceName - businessName - startDate - endDate - createdAt - updatedAt BusinessValuationMetaDataV2: type: object properties: connectionUuid: type: string readOnly: true example: CON-396d5daa-26b2-4979-89b6-cafb2c298155 businessName: type: string readOnly: true example: Railz serviceName: type: string readOnly: true example: xero enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - byod reportId: type: string readOnly: true example: 5fad8a342a88364234392fb5 startDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' format: date-time endDate: type: string readOnly: true example: '2020-11-25T01:02:03Z' format: date-time createdAt: type: string readOnly: true example: '2020-12-25T01:02:03Z' format: date-time updatedAt: type: string readOnly: true example: '2020-12-25T01:02:03Z' format: date-time required: - connectionUuid - businessName - serviceName - reportId - startDate - endDate - createdAt - updatedAt CreditsResponseDto: type: object properties: count: type: number readOnly: true format: integer example: 1 reports: readOnly: false type: array items: $ref: '#/components/schemas/CreditsReport' required: - count - reports Error500ResponseDto: type: object properties: error: readOnly: true allOf: - $ref: '#/components/schemas/Error500Dto' payload: type: object readOnly: true required: - error - payload securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http