---
title: "Create a CSV export job"
method: POST
path: "/api/business/{businessId}/branch/{branchId}/csvexportjob"
tags: ["CSV Export Job"]
---

# Create a CSV export job

`POST /api/business/{businessId}/branch/{branchId}/csvexportjob`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/csvexportjob`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/csvexportjob/post.ts> (a function with typed inputs; its response is checked against the schema)

Create and return a CSV export job for the specified business id and branch id

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Request body

- CsvExportJob
  - `jobId` string
  - `jobType` 'TRANSACTIONS_CSV' | 'SUNDRIES_CSV' | 'DATEV_CSV' | 'CLIENT_COURSES_CSV' | 'CLIENT_COURSE_TRANSACTIONS_CSV' | 'CLIENT_CSV'
  - `jobStatus` 'SCHEDULED' | 'RUNNING' | 'FAILED' | 'DONE'
  - `started` string, date-time: Job start time
  - `finished` string, date-time: Job end time
  - `startFilter` string, date
  - `finishFilter` string, date
  - `filterExpression` string
  - `totalRows` integer
  - `succeededRows` integer
  - `tempCsvExternalUrl` string: Url to csv file generated
  - `failureReason` string

## Response `201`

CSV export job created successfully

- CsvExportJob
  - `jobId` string
  - `jobType` 'TRANSACTIONS_CSV' | 'SUNDRIES_CSV' | 'DATEV_CSV' | 'CLIENT_COURSES_CSV' | 'CLIENT_COURSE_TRANSACTIONS_CSV' | 'CLIENT_CSV'
  - `jobStatus` 'SCHEDULED' | 'RUNNING' | 'FAILED' | 'DONE'
  - `started` string, date-time: Job start time
  - `finished` string, date-time: Job end time
  - `startFilter` string, date
  - `finishFilter` string, date
  - `filterExpression` string
  - `totalRows` integer
  - `succeededRows` integer
  - `tempCsvExternalUrl` string: Url to csv file generated
  - `failureReason` string

## Other responses

- `400`: Bad Request
- `404`: Business or branch with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)