Add a field to be included in data export

import requests
url = "https://api.sandbox.monite.com/v1/data_exports/extra_data"
payload = {
    "field_name": "default_account_code",
    "field_value": "field_value",
    "object_id": "object_id",
    "object_type": "counterpart"
}
headers = {
    "x-monite-version": "2023-09-01",
    "x-monite-entity-id": "9d2b4c8f-2087-4738-ba91-7359683c49a4",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "field_name": "default_account_code",
  "field_value": "field_value",
  "object_id": "object_id",
  "object_type": "counterpart",
  "created_by": "created_by"
}

Authentication

AuthorizationBearer

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

Headers

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

field_nameenumRequired

Allowed values:

field_valuestringRequired

object_idstringRequiredformat: "uuid"

object_type"counterpart"Required

Response

Successful Response

idstringformat: "uuid"

created_atdatetime

updated_atdatetime

field_nameenum

Allowed values:

field_valuestring

object_idstringformat: "uuid"

object_type"counterpart"

created_bystringformat: "uuid"

Errors

400

Post Data Exports Extra Data Request Bad Request Error

401

Post Data Exports Extra Data Request Unauthorized Error

403

Post Data Exports Extra Data Request Forbidden Error

422

Post Data Exports Extra Data Request Unprocessable Entity Error

500

Post Data Exports Extra Data Request Internal Server Error