API Documentation

API Endpoint

Integration Exporter Configurations

Integration Exporter Configuration

IntegrationExporterConfiguration is an entity that stores configuration settings for exporting data to external systems. Each configuration is linked to a specific company and defines how that company’s data should be exported.

Company Types

Each integration exporter configuration defines a company_type that determines how the company is treated in the accounting export:

  • client: The company is treated as a client (customer) in accounting exports

  • vendor: The company is treated as a vendor (supplier) in accounting exports

  • both: The company can be treated as both client and vendor depending on transaction context

Supported filter params

  • company_id

Supported sort params

  • client_id

  • company_type

GET /api/v2/integration_exporter_configurations
Requestsreturns a list of exporter configurations

GET  /api/v2/integration_exporter_configurations

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "2",
      "type": "integration_exporter_configurations",
      "attributes": {
        "company_type": null,
        "datev_client_account_code": null,
        "datev_vendor_account_code": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2464"
          }
        },
        "company": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/integration_exporter_configurations?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/integration_exporter_configurations?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get integration exporter configurations
GET/api/v2/integration_exporter_configurations

GET /api/v2/integration_exporter_configurations/1
Requestsreturns an exporter configuration

GET  /api/v2/integration_exporter_configurations/3

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3",
    "type": "integration_exporter_configurations",
    "attributes": {
      "company_type": null,
      "datev_client_account_code": null,
      "datev_vendor_account_code": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2466"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Get integration exporter configuration
GET/api/v2/integration_exporter_configurations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

integration exporter configuration id

POST /api/v2/integration_exporter_configurations
Requestscreates an exporter configuration when params are validreturns an error when params are invalid

POST  /api/v2/integration_exporter_configurations

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "integration_exporter_configurations",
    "attributes": {
      "company_id": 6765,
      "company_type": "client",
      "datev_client_account_code": "1234567890",
      "datev_vendor_account_code": "1234567890"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4",
    "type": "integration_exporter_configurations",
    "attributes": {
      "company_type": "client",
      "datev_client_account_code": "1234567890",
      "datev_vendor_account_code": "1234567890"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2468"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/integration_exporter_configurations

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "integration_exporter_configurations",
    "attributes": {
      "company_id": null,
      "company_type": "client",
      "datev_client_account_code": "1234567890",
      "datev_vendor_account_code": "1234567890"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/company"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not accessible",
      "source": {
        "pointer": "data/attributes/company"
      }
    }
  ]
}

Create integration exporter configuration
POST/api/v2/integration_exporter_configurations

URI Parameters
HideShow
company_id
number (required) Example: 1

company id

company_type
string (optional) Example: client

company type (client, vendor, both)

datev_client_account_code
string (optional) Example: 1234567890

datev client account code

datev_vendor_account_code
string (optional) Example: 1234567890

datev vendor account code

PATCH /api/v2/integration_exporter_configurations/
Requestsupdates an exporter configuration when params are validreturns an error when params are invalid

PATCH  /api/v2/integration_exporter_configurations/5

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "integration_exporter_configurations",
    "id": 5,
    "attributes": {
      "company_type": "vendor",
      "company_id": 6768,
      "datev_client_account_code": "1234567890",
      "datev_vendor_account_code": "1234567890"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "5",
    "type": "integration_exporter_configurations",
    "attributes": {
      "company_type": "vendor",
      "datev_client_account_code": "1234567890",
      "datev_vendor_account_code": "1234567890"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2470"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/integration_exporter_configurations/6

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "integration_exporter_configurations",
    "id": 6,
    "attributes": {
      "company_type": "invalid_type",
      "company_id": 6770,
      "datev_client_account_code": "1234567890",
      "datev_vendor_account_code": "1234567890"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "source": {
        "pointer": "data/attributes/company_type"
      }
    }
  ]
}

Update integration exporter configuration
PATCH/api/v2/integration_exporter_configurations/

URI Parameters
HideShow
company_id
number (required) Example: 1

company id

company_type
string (optional) Example: client

company type (client, vendor, both)

datev_client_account_code
string (optional) Example: 1234567890

datev client account code

datev_vendor_account_code
string (optional) Example: 1234567890

datev vendor account code

DELETE /api/v2/integration_exporter_configurations/1
Requestsdestroys an exporter configuration

DELETE  /api/v2/integration_exporter_configurations/7

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Delete integration exporter configuration
DELETE/api/v2/integration_exporter_configurations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

integration exporter configuration id

Generated by aglio on 26 Dec 2025