RArailz
Reports

GET /reports/revenue

Changed on

API to retrieve formatted revenue report

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required

Unique business name identifier.

serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'zohoBooks' | 'byod' required

Name of accounting service provider, reuse currently available enum used in the feeder

startDatestring required

The start date of the report frequency in the format: yyyy-MM-dd.

endDatestring required

The end date of the report frequency in the format: yyyy-MM-dd.

reportFrequency'month' | 'quarter' | 'year' required

The report snapshot frequency.

accountingMethod'cash' | 'accrual'

Response

Successfully returned revenue report

Example response

{
  "meta": {
    "reportId": [
      "5fad8a342a88364234392fb5"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "endDate": "2020-12-25T01:02:03Z",
    "startDate": "2020-11-25T01:02:03Z",
    "reportFrequency": "month",
    "currency": [
      "USD"
    ]
  },
  "data": {
    "subSections": [
      {
        "name": "Operating Expenses",
        "amount": 1200
      }
    ],
    "totalAmount": 3500,
    "percentageChange": 15
  }
}

Changes

  • 5cdfae3fa1faRevision changes
    • breaking

      removed the enum value myob from the query request parameter serviceName

    • breaking

      removed the enum value sandbox from the query request parameter serviceName

    • breaking

      removed the enum value wave from the query request parameter serviceName

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status

    • info

      added the new enum value byod to the query request parameter serviceName

    • info

      added the new enum value zohoBooks to the query request parameter serviceName