Skip to main content
POST
/
data_exports
Create an export job
curl --request POST \
  --url https://api.sandbox.monite.com/v1/data_exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "date_from": "2023-12-25",
  "date_to": "2023-12-25",
  "format": "csv",
  "objects": [
    {
      "name": "payable",
      "statuses": [
        "draft"
      ]
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
date_from
string<date>
required
date_to
string<date>
required
format
enum<string>
required
Available options:
csv,
pdf,
csv_xero
objects
object[]
required

Response

Successful Response

id
string<uuid>
required