Store branch settlement reconciliation export artifact

POST

/branch-settlement-reconciliation-export-artifacts/{branchProfileId}

const url = 'https://example.com/branch-settlement-reconciliation-export-artifacts/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-artifacts/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

201

Stored private branch settlement reconciliation export artifact

application/json

BranchSettlementReconciliationExportArtifact

object

branchProfileId

required

string

>= 1 characters

businessReportSnapshotId

required

string

>= 1 characters

businessReportExportId

required

string

>= 1 characters

exportCode

required

string

>= 1 characters

exportFormat

required

string

Allowed values: csv xlsx json

artifactBucket

required

Allowed value: business-report-exports

artifactStorageObjectKey

required

string

>= 1 characters /^[^/].*$/

contentType

required

string

>= 1 characters

fileName

required

string

>= 1 characters

byteSize

required

integer

>= 1

renderedAt

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 artifact store is unavailable