GEgetpliant
Statements

Statement CSV

Changed on

Generates a CSV file with the statement data asynchronously for the specified organization and card account and date period. The CSV file will be available for download shortly. You will receive a callback of type STATEMENT_CSV_DOWNLOAD_READY once the exported CSV file is ready. Do not forget to subscribe to the callback upfront! Otherwise this endpoint returns an error. The endpoint can only be used with an active callback subscription for the STATEMENT_CSV_DOWNLOAD_READY event type. Hint: The time it takes to generate the file may vary according to system load.

get/statements/csv

Request

Query parameters

organizationIdstring uuid required

The organization ID for which the statement is requested.

cardAccountIdstring uuid

Optionally, the card account ID for which the statement is requested. If not provided, the default card account will be used. A superseded card account still serves the statements of the periods before the switch. For periods after the switch, request the statement for its successor (supersededBy).

fromBookingDatestring date required

The start date of the statement period, has to be in the past and before the toBookingDate. Format is YYYY-MM-DD. This is normally the first day of the month.

toBookingDatestring date required

The end date of the statement period, has to be in the past. Format is YYYY-MM-DD. This is normally the last day of the month.

language'en' | 'de'

The language of the headers in the CSV file. If not provided, English (en) will be used.

Response

Accepted. The CSV file is being generated and will be available for download shortly. You will receive a callback of type STATEMENT_CSV_DOWNLOAD_READY once the exported CSV file is ready. Do not forget to subscribe to it!

statementFileExportIdstring uuid

Changes

  • a4fbf7d068b4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status