Skip to main content
POST
Export P&L comparison as CSV

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string
required

The UUID of the business to export the P&L comparison for.

Query Parameters

money_format
enum<string>

Format for monetary values in the export.

Available options:
DOLLAR_STRING,
CENTS_INTEGER

Body

application/json
periods
object
tag_filters
object[] | null
reporting_basis
enum<string> | null
Available options:
ACCRUAL,
CASH
structure
enum<string> | null
Available options:
DEFAULT,
TRUCKING,
MEDSPA,
MEDSPA_NO_LICENSING,
CITRUS,
CITRUS_NO_LICENSING,
FLORIST

Response

Pre-signed URL for downloading the CSV export.

data
object
required

A pre-signed URL to download a document.