Create a data stream

Changed on
post/data_streams

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Request body

keystring required

Unique immutable identifier

namestring required

Human readable name

type'api' | 'bank_feed'

The type of data stream to create

bank_account_idstring

Required when type is bank_feed. The ID of the bank account to link.

Response

Data stream created

idstring uuid

Unique identifier

keystring required

Unique immutable identifier

namestring required

Human readable name

descriptionstring

Optional description of the data stream

typestring

The type of data stream (e.g. api, csv, stripe, bank_feed). adjustments is a stream End Close writes itself: a reconciliation's adjustment records for one side, bound to that reconciliation alone.

program_idstring uuid nullable
records_countinteger

Record count from the ClickHouse mirror

Changes

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status