openapi: 3.2.0 info: title: FIS® Accounting Data as a Service™ Reports API description: What's changed in our API version: v2 contact: {} servers: - url: https://api.railz.ai description: Main (production) API server tags: - name: Reports paths: /reports/invoices: get: description: API to retrieve formatted invoices report operationId: reportInvoices parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - wave - myob - zohoBooks - 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: Report invoices tags: - Reports x-summary-source: derived /reports/bills: get: description: API to retrieve formatted bills report operationId: reportBills parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - dynamics365Finance - myob - zohoBooks - 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: Report bills tags: - Reports x-summary-source: derived /reports/revenue: get: description: API to retrieve formatted revenue report operationId: reportRevenue parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - zohoBooks - byod - 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: array readOnly: true example: - USD items: type: string 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: Report revenue tags: - Reports x-summary-source: derived /reports/expenses: get: description: API to retrieve formatted expenses report operationId: reportExpenses parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - zohoBooks - byod - 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: array readOnly: true example: - USD items: type: string 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: Report expenses tags: - Reports x-summary-source: derived /reports/cashflowStatements: get: description: API to retrieve formatted cashflow report operationId: reportCashflowStatements parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - xero - dynamicsBusinessCentral - zohoBooks - byod - 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: Report cashflow statements tags: - Reports x-summary-source: derived /reports/incomeStatements: get: description: API to retrieve formatted income statements report operationId: reportIncomeStatements parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - zohoBooks - byod - 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: Report income statements tags: - Reports x-summary-source: derived /reports/balanceSheets: get: description: API to retrieve formatted balance sheets report operationId: reportBalanceSheets parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - zohoBooks - byod - 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: Report balance sheets tags: - Reports x-summary-source: derived /reports/financialRatios: get: description: API to retrieve formatted financial ratios report operationId: reportFinancialRatios parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - zohoBooks - byod - 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: Report financial ratios tags: - Reports x-summary-source: derived /reports/railzScore: get: description: API to retrieve formatted credit score report operationId: reportRailzScore parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: type: string - name: serviceName required: true in: query description: Name of accounting service provider, reuse currently available enum used in the feeder schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - zohoBooks - byod - name: startDate required: false in: query description: 'The start date of the report frequency in the format: yyyy-MM-dd.' schema: type: string deprecated: true - 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: Report railz score tags: - Reports x-summary-source: derived /reports/credits: get: description: Combines /creditScores and /creditRatings operationId: credits parameters: - name: businessName required: true in: query description: Unique business name identifier. schema: example: Railz type: string - name: serviceName required: true in: query description: Name of accounting service provider. schema: type: string enum: - freshbooks - quickbooks - quickbooksDesktop - xero - oracleNetsuite - sageBusinessCloud - sageIntacct - dynamicsBusinessCentral - zohoBooks - byod - 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/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: Credits tags: - Reports x-summary-source: derived components: schemas: Error403ResponseDto: type: object properties: error: readOnly: true allOf: - $ref: '#/components/schemas/Error403Dto' payload: type: object readOnly: true example: {} required: - error - payload CreditsReport: type: object properties: meta: $ref: '#/components/schemas/CreditRatingsReportMetaData' data: $ref: '#/components/schemas/CreditsData' required: - meta - data 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 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 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 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 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 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 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