getBooksExportWithHttpInfo method

Future<Response> getBooksExportWithHttpInfo({
  1. String? sandbox,
  2. String? from,
  3. String? to,
  4. String? format,
  5. int? limit,
})

Returns the complete financial package for the caller's org over (from, to]: the trial balance, the P&L, the balance sheet, and the GL detail behind them — the four statements a tax preparer or an investor asks for, assembled from the one ledger in a single read so they cannot disagree with each other.

Returns the complete financial package for the caller's org over (from, to]: the trial balance, the P&L, the balance sheet, and the GL detail behind them — the four statements a tax preparer or an investor asks for, assembled from the one ledger in a single read so they cannot disagree with each other.

Note: This method returns the HTTP Response.

Parameters:

  • String sandbox: Sandbox reads the org's SANDBOX ledger when it is exactly "true".

  • String from: From is the RFC3339 start of the window, exclusive. Empty means all time.

  • String to: To is the RFC3339 end of the window, inclusive. Empty means up to now.

  • String format: Format is the export encoding. Only "json" is supported; empty means json.

  • int limit: Limit caps the GL detail rows included as the audit trail; 5000 when absent or not positive.

Implementation

Future<Response> getBooksExportWithHttpInfo({ String? sandbox, String? from, String? to, String? format, int? limit, }) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/books/export';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (sandbox != null) {
    queryParams.addAll(_queryParams('', 'sandbox', sandbox));
  }
  if (from != null) {
    queryParams.addAll(_queryParams('', 'from', from));
  }
  if (to != null) {
    queryParams.addAll(_queryParams('', 'to', to));
  }
  if (format != null) {
    queryParams.addAll(_queryParams('', 'format', format));
  }
  if (limit != null) {
    queryParams.addAll(_queryParams('', 'limit', limit));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}