Add financial statement

POST

https://api.sureshake.com/v2/entities/{id}/financial-statements

Path parameters

id
string
required
format: uuid

Request body JSON required

statementType
balance_sheet
or
income_statement
or
cash_flow
or
tax_return
or
audit_report
or
other
required
statementDate
string
required
fileKey
string
required
visibility
optional
private
or
followers
or
public
default: "private"

Returns

200

Default Response

JSON

statement
object
required
- statementType
  balance_sheet
  or
  income_statement
  or
  cash_flow
  or
  tax_return
  or
  audit_report
  or
  other
  required
- statementDate
  string
  required
- fileKey
  string
  required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- uploadedBy
  string
  required
- visibility
  optional
  private
  or
  followers
  or
  public
  default: "private"
- createdAt
  optional
  string
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request POST \ --url 'https://api.sureshake.com/v2/entities/<id>/financial-statements' \ --header 'Content-Type: application/json' \ --data ' { "statementType": "balance_sheet", "statementDate": "string", "fileKey": "string", "visibility": "private" } '

{ "statement": { "statementType": "balance_sheet", "statementDate": "string", "fileKey": "string", "visibility": "private", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "uploadedBy": "string", "createdAt": "2019-08-24T14:15:22Z" } }