Start branch settlement reconciliation export workflow

POST

/branch-settlement-reconciliation-export-workflow-starts/{branchProfileId}

const url = 'https://example.com/branch-settlement-reconciliation-export-workflow-starts/example?exportFormat=csv';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'https://example.com/branch-settlement-reconciliation-export-workflow-starts/example?exportFormat=csv' \
  --header 'Authorization: Bearer <token>'

Authorizations

supabaseBearerAuth

Parameters

Path Parameters

branchProfileId

required

string

>= 1 characters

Query Parameters

exportFormat

string

default: csv

Allowed values: csv xlsx json

Responses

202

Restate accepted branch settlement reconciliation export workflow

application/json

BranchSettlementReconciliationExportWorkflowStart

object

branchProfileId

required

string

>= 1 characters

exportFormat

required

string

Allowed values: csv xlsx json

branchSettlementReconciliationExportWorkflowRequestId

required

string

>= 1 characters

workflowStateEngine

required

Allowed value: restate

workflowName

required

Allowed value: BranchSettlementReconciliationExportWorkflow

workflowKey

required

string

>= 1 characters

handlerName

required

Allowed value: run

invocationId

required

string

>= 1 characters

workflowStatus

required

string

>= 1 characters

key

additional properties

400

Export format or request is invalid

401

Supabase bearer token is required

403

Actor cannot export branch settlement reconciliation

503

Branch settlement export workflow starter is unavailable