At Railz, a Report refers to a response object hierarchy. Each API endpoint that retrieves data from an Accounting Service Provider returns a response with one or more Reports.
Each Report has a meta and a data parameter:
metais an object that contains a summary of the report such as data type, reporting period, etc.datais an array of one or more objects containing the relevant data types.
Report Meta
All responses related to accounting data include a meta object containing the following information:
connectionUuid: the connection unique id.reportId: The report's unique id.startDate: Date from which the report data begins in the format: YYYY-MM-DD.endDate: Date from which the report data ends in the format: YYYY-MM-DD.reportFrequency: The reporting period requested.currency: The default currency the business used.accountingMethod: Specifies cash or accrual report. Applies to financial statements only.createdAt: The date/time the report was created by the accounting service provider.updatedAt: The date/time when the data was last updated by Railz.
An example meta object would look like this:
"meta": {
"connectionUuid":"CON-396d5daa-26b2-4979-89b6-cafb2c298155",
"reportId": "60000000c6115a0a166e2222",
"startDate": "2020-01-01T00:00:00",
"endDate": "2020-12-31T00:00:00",
"reportFrequency": "year",
"accountingMethod": "accrual",
"currency": "CAD",
"createdAt": "2020-12-31T00:00:00",
"updatedAt": "2021-01-16T21:14:44"
}
reportFrequency,currency,startDate, andendDateare not always returned.