me/kombo-ruby-sdk
1
0
Fork 0
mirror of https://github.com/acaloiaro/kombo-ruby-sdk synced 2026-07-21 10:12:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
kombo-ruby-sdk/docs/CustomEndpointsApi.md
Adriano Caloiaroooo 000eb69c9e
initial commit
2025-11-19 13:39:55 -08:00

47 KiB
Raw Blame History

Kombo::CustomEndpointsApi

All URIs are relative to https://api.kombo.dev/v1

Method HTTP request Description
get_custom_datev_available_documents GET /custom/datev/available-documents Retrieve available documents
get_custom_datev_check_document_permission GET /custom/datev/check-document-permission Verify service is enabled
get_custom_datev_check_eau_permission GET /custom/datev/check-eau-permission Verify service is enabled
get_custom_datev_check_write_permission GET /custom/datev/check-write-permission Verify service is enabled
get_custom_datev_data_pushes GET /custom/datev/data-pushes Get DATEV data pushes
get_custom_datev_eau_requests_eau_id GET /custom/datev/eau-requests/{eau_id} Query the status of the eAU request
get_custom_datev_system_information GET /custom/datev/system-information Get DATEV system information
post_custom_datev_download_document POST /custom/datev/download-document Download Payroll Document
post_custom_datev_employees_employee_id_download_document POST /custom/datev/employees/{employee_id}/download-document Download Payroll Document
post_custom_datev_employees_employee_id_eau_requests POST /custom/datev/employees/{employee_id}/eau-requests Create eAU Request
post_custom_datev_passthrough POST /custom/datev/passthrough Write raw DATEV ASCII file
post_custom_datev_push_data_general POST /custom/datev/push-data/general Push general data to DATEV
post_custom_datev_push_data_payroll POST /custom/datev/push-data/payroll Push payroll data to DATEV
post_custom_silae_employees_employee_id_payroll_supplements POST /custom/silae/employees/{employee_id}/payroll-supplements Write Payroll Supplement
put_custom_datev_employees_employee_id_compensations PUT /custom/datev/employees/{employee_id}/compensations Set DATEV compensations
put_custom_datev_employees_employee_id_prepare_payroll PUT /custom/datev/employees/{employee_id}/prepare-payroll Prepare DATEV Payroll

get_custom_datev_available_documents

get_custom_datev_available_documents(x_integration_id, period)

Retrieve available documents

Use this endpoint to get all available documents for a specific period.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
period = 'period_example' # String | Provide the period in the format YYYY-MM-DD for which to check for available documents.

begin
  # Retrieve available documents
  result = api_instance.get_custom_datev_available_documents(x_integration_id, period)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_available_documents: #{e}"
end

Using the get_custom_datev_available_documents_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_datev_available_documents_with_http_info(x_integration_id, period)

begin
  # Retrieve available documents
  data, status_code, headers = api_instance.get_custom_datev_available_documents_with_http_info(x_integration_id, period)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetCustomDatevAvailableDocumentsPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_available_documents_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
period String Provide the period in the format YYYY-MM-DD for which to check for available documents.

Return type

GetCustomDatevAvailableDocumentsPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_custom_datev_check_document_permission

get_custom_datev_check_document_permission(x_integration_id)

Verify service is enabled

This endpoint returns the available document types for this DATEV integration.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.

begin
  # Verify service is enabled
  result = api_instance.get_custom_datev_check_document_permission(x_integration_id)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_check_document_permission: #{e}"
end

Using the get_custom_datev_check_document_permission_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_datev_check_document_permission_with_http_info(x_integration_id)

begin
  # Verify service is enabled
  data, status_code, headers = api_instance.get_custom_datev_check_document_permission_with_http_info(x_integration_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetCustomDatevCheckDocumentPermissionPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_check_document_permission_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.

Return type

GetCustomDatevCheckDocumentPermissionPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_custom_datev_check_eau_permission

get_custom_datev_check_eau_permission(x_integration_id)

Verify service is enabled

This endpoint validates that this DATEV integration is ready to use the eAU feature.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.

begin
  # Verify service is enabled
  result = api_instance.get_custom_datev_check_eau_permission(x_integration_id)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_check_eau_permission: #{e}"
end

Using the get_custom_datev_check_eau_permission_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_datev_check_eau_permission_with_http_info(x_integration_id)

begin
  # Verify service is enabled
  data, status_code, headers = api_instance.get_custom_datev_check_eau_permission_with_http_info(x_integration_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetCustomDatevCheckEauPermissionPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_check_eau_permission_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.

Return type

GetCustomDatevCheckEauPermissionPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_custom_datev_check_write_permission

get_custom_datev_check_write_permission(x_integration_id)

Verify service is enabled

This endpoint returns whether you can write to this DATEV integration.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.

begin
  # Verify service is enabled
  result = api_instance.get_custom_datev_check_write_permission(x_integration_id)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_check_write_permission: #{e}"
end

Using the get_custom_datev_check_write_permission_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_datev_check_write_permission_with_http_info(x_integration_id)

begin
  # Verify service is enabled
  data, status_code, headers = api_instance.get_custom_datev_check_write_permission_with_http_info(x_integration_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetCustomDatevCheckWritePermissionPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_check_write_permission_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.

Return type

GetCustomDatevCheckWritePermissionPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_custom_datev_data_pushes

get_custom_datev_data_pushes(x_integration_id)

Get DATEV data pushes

Returns all "DATEV Data Pushes" of the last 2 months. You can use this endpoint to give your users transparency about submitted "ASCII-Files" and their status. Each data push can contain multiple files that were submitted.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.

begin
  # Get DATEV data pushes
  result = api_instance.get_custom_datev_data_pushes(x_integration_id)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_data_pushes: #{e}"
end

Using the get_custom_datev_data_pushes_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_datev_data_pushes_with_http_info(x_integration_id)

begin
  # Get DATEV data pushes
  data, status_code, headers = api_instance.get_custom_datev_data_pushes_with_http_info(x_integration_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetCustomDatevDataPushesPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_data_pushes_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.

Return type

GetCustomDatevDataPushesPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_custom_datev_eau_requests_eau_id

get_custom_datev_eau_requests_eau_id(x_integration_id, eau_id)

Query the status of the eAU request

This endpoint queries the status of the eAU request for the given DATEV integration.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
eau_id = 'eau_id_example' # String | GET /custom/datev/eau-requests/:eau_id Parameter

begin
  # Query the status of the eAU request
  result = api_instance.get_custom_datev_eau_requests_eau_id(x_integration_id, eau_id)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_eau_requests_eau_id: #{e}"
end

Using the get_custom_datev_eau_requests_eau_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_datev_eau_requests_eau_id_with_http_info(x_integration_id, eau_id)

begin
  # Query the status of the eAU request
  data, status_code, headers = api_instance.get_custom_datev_eau_requests_eau_id_with_http_info(x_integration_id, eau_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetCustomDatevEauRequestsEauIdPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_eau_requests_eau_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
eau_id String GET /custom/datev/eau-requests/:eau_id Parameter

Return type

GetCustomDatevEauRequestsEauIdPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_custom_datev_system_information

get_custom_datev_system_information(x_integration_id)

Get DATEV system information

This endpoint returns BeraterNr (consultant_number), MandantenNr (client_number) and the payroll system (LODAS or Lohn und Gehalt). Useful to generate a DATEV ASCII file for the passthrough endpoint.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.

begin
  # Get DATEV system information
  result = api_instance.get_custom_datev_system_information(x_integration_id)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_system_information: #{e}"
end

Using the get_custom_datev_system_information_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_datev_system_information_with_http_info(x_integration_id)

begin
  # Get DATEV system information
  data, status_code, headers = api_instance.get_custom_datev_system_information_with_http_info(x_integration_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetCustomDatevSystemInformationPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->get_custom_datev_system_information_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.

Return type

GetCustomDatevSystemInformationPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

post_custom_datev_download_document

post_custom_datev_download_document(x_integration_id, opts)

Download Payroll Document

Download a document from DATEV This endpoint requires the permission Manage documents to be enabled in your scope config. ### Example Request Body json { \"accounting_month\": \"2001-12-01\", \"document_type\": \"LOJE\", \"employee_id\": null }

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
opts = {
  post_custom_datev_download_document_request_body: Kombo::PostCustomDatevDownloadDocumentRequestBody.new({accounting_month: Time.now, document_type: 'AANB', employee_id: 'employee_id_example'}) # PostCustomDatevDownloadDocumentRequestBody | POST /custom/datev/download-document Request body
}

begin
  # Download Payroll Document
  result = api_instance.post_custom_datev_download_document(x_integration_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_download_document: #{e}"
end

Using the post_custom_datev_download_document_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_custom_datev_download_document_with_http_info(x_integration_id, opts)

begin
  # Download Payroll Document
  data, status_code, headers = api_instance.post_custom_datev_download_document_with_http_info(x_integration_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PostCustomDatevDownloadDocumentPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_download_document_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
post_custom_datev_download_document_request_body PostCustomDatevDownloadDocumentRequestBody POST /custom/datev/download-document Request body [optional]

Return type

PostCustomDatevDownloadDocumentPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_custom_datev_employees_employee_id_download_document

post_custom_datev_employees_employee_id_download_document(x_integration_id, employee_id, opts)

Download Payroll Document

Download a document from DATEV This endpoint requires the permission Manage documents to be enabled in your scope config. ### Example Request Body json { \"accounting_month\": \"2001-12-01\", \"document_type\": \"LOJE\" }

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
employee_id = 'employee_id_example' # String | POST /custom/datev/employees/:employee_id/download-document Parameter
opts = {
  post_custom_datev_employees_employee_id_download_document_request_body: Kombo::PostCustomDatevEmployeesEmployeeIdDownloadDocumentRequestBody.new({accounting_month: Time.now, document_type: 'AANB'}) # PostCustomDatevEmployeesEmployeeIdDownloadDocumentRequestBody | POST /custom/datev/employees/:employee_id/download-document Request body
}

begin
  # Download Payroll Document
  result = api_instance.post_custom_datev_employees_employee_id_download_document(x_integration_id, employee_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_employees_employee_id_download_document: #{e}"
end

Using the post_custom_datev_employees_employee_id_download_document_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_custom_datev_employees_employee_id_download_document_with_http_info(x_integration_id, employee_id, opts)

begin
  # Download Payroll Document
  data, status_code, headers = api_instance.post_custom_datev_employees_employee_id_download_document_with_http_info(x_integration_id, employee_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PostCustomDatevEmployeesEmployeeIdDownloadDocumentPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_employees_employee_id_download_document_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
employee_id String POST /custom/datev/employees/:employee_id/download-document Parameter
post_custom_datev_employees_employee_id_download_document_request_body PostCustomDatevEmployeesEmployeeIdDownloadDocumentRequestBody POST /custom/datev/employees/:employee_id/download-document Request body [optional]

Return type

PostCustomDatevEmployeesEmployeeIdDownloadDocumentPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_custom_datev_employees_employee_id_eau_requests

post_custom_datev_employees_employee_id_eau_requests(x_integration_id, employee_id, opts)

Create eAU Request

Create a request for an electronic certificate of incapacity for work (eAU). This endpoint requires the permission Manage eAU to be enabled in your scope config. ### Example Request Body json { \"start_work_incapacity\": \"2022-01-01\" }

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
employee_id = 'remote:12312' # String | ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
opts = {
  post_custom_datev_employees_employee_id_eau_requests_request_body: Kombo::PostCustomDatevEmployeesEmployeeIdEauRequestsRequestBody.new({start_work_incapacity: 'start_work_incapacity_example'}) # PostCustomDatevEmployeesEmployeeIdEauRequestsRequestBody | POST /custom/datev/employees/:employee_id/eau-requests Request body
}

begin
  # Create eAU Request
  result = api_instance.post_custom_datev_employees_employee_id_eau_requests(x_integration_id, employee_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_employees_employee_id_eau_requests: #{e}"
end

Using the post_custom_datev_employees_employee_id_eau_requests_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_custom_datev_employees_employee_id_eau_requests_with_http_info(x_integration_id, employee_id, opts)

begin
  # Create eAU Request
  data, status_code, headers = api_instance.post_custom_datev_employees_employee_id_eau_requests_with_http_info(x_integration_id, employee_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PostCustomDatevEmployeesEmployeeIdEauRequestsPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_employees_employee_id_eau_requests_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
employee_id String ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
post_custom_datev_employees_employee_id_eau_requests_request_body PostCustomDatevEmployeesEmployeeIdEauRequestsRequestBody POST /custom/datev/employees/:employee_id/eau-requests Request body [optional]

Return type

PostCustomDatevEmployeesEmployeeIdEauRequestsPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_custom_datev_passthrough

post_custom_datev_passthrough(x_integration_id, opts)

Write raw DATEV ASCII file

This action allows to send an arbitrary ASCII file directly to DATEV LODAS or Lohn und Gehalt. Kombo adds validation for the file format but not on the content. This action allows you to implement any use case that you might have with DATEV payroll ASCII imports.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
opts = {
  post_custom_datev_passthrough_request_body: Kombo::PostCustomDatevPassthroughRequestBody.new({file_content: 'file_content_example', accounting_month: Time.now, target_system: 'LODAS', file_type: 'STAMMDATEN', file_name: 'file_name_example'}) # PostCustomDatevPassthroughRequestBody | POST /custom/datev/passthrough Request body
}

begin
  # Write raw DATEV ASCII file
  result = api_instance.post_custom_datev_passthrough(x_integration_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_passthrough: #{e}"
end

Using the post_custom_datev_passthrough_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_custom_datev_passthrough_with_http_info(x_integration_id, opts)

begin
  # Write raw DATEV ASCII file
  data, status_code, headers = api_instance.post_custom_datev_passthrough_with_http_info(x_integration_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PostCustomDatevPassthroughPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_passthrough_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
post_custom_datev_passthrough_request_body PostCustomDatevPassthroughRequestBody POST /custom/datev/passthrough Request body [optional]

Return type

PostCustomDatevPassthroughPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_custom_datev_push_data_general

post_custom_datev_push_data_general(x_integration_id, opts)

Push general data to DATEV

Uploads the currently relevant general data (employees, compensations, and time offs) to DATEV. This will create so called ASCII files that the accountant has to import in DATEV. You can call this endpoint to implement an on-demand sync to DATEV, for example if you want to offer your users a button to do that in your application.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
opts = {
  body: { ... } # Object | POST /custom/datev/push-data/general Request body
}

begin
  # Push general data to DATEV
  result = api_instance.post_custom_datev_push_data_general(x_integration_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_push_data_general: #{e}"
end

Using the post_custom_datev_push_data_general_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_custom_datev_push_data_general_with_http_info(x_integration_id, opts)

begin
  # Push general data to DATEV
  data, status_code, headers = api_instance.post_custom_datev_push_data_general_with_http_info(x_integration_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PostCustomDatevPushDataGeneralPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_push_data_general_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
body Object POST /custom/datev/push-data/general Request body [optional]

Return type

PostCustomDatevPushDataGeneralPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_custom_datev_push_data_payroll

post_custom_datev_push_data_payroll(x_integration_id, opts)

Push payroll data to DATEV

Uploads the currently relevant payroll data (supplements) to DATEV. This will create so called ASCII files that the accountant has to import in DATEV. After finishing the payroll preparation or after correcting payroll, you can call this.

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
opts = {
  post_custom_datev_push_data_payroll_request_body: Kombo::PostCustomDatevPushDataPayrollRequestBody.new({payroll_month: Time.now}) # PostCustomDatevPushDataPayrollRequestBody | POST /custom/datev/push-data/payroll Request body
}

begin
  # Push payroll data to DATEV
  result = api_instance.post_custom_datev_push_data_payroll(x_integration_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_push_data_payroll: #{e}"
end

Using the post_custom_datev_push_data_payroll_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_custom_datev_push_data_payroll_with_http_info(x_integration_id, opts)

begin
  # Push payroll data to DATEV
  data, status_code, headers = api_instance.post_custom_datev_push_data_payroll_with_http_info(x_integration_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PostCustomDatevPushDataPayrollPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_datev_push_data_payroll_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
post_custom_datev_push_data_payroll_request_body PostCustomDatevPushDataPayrollRequestBody POST /custom/datev/push-data/payroll Request body [optional]

Return type

PostCustomDatevPushDataPayrollPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_custom_silae_employees_employee_id_payroll_supplements

post_custom_silae_employees_employee_id_payroll_supplements(x_integration_id, employee_id, opts)

Write Payroll Supplement

Write a payroll supplement to Silae using the supplement code. This endpoint requires the permission Manage payroll to be enabled in your scope config. ### Example Request Body json { \"employee_id\": \"EvLV61zdahkN4ftPJbmPCkdv\", \"supplement_code\": \"200\", \"effective_date\": \"2024-01-14\", \"element_amount\": 6 }

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'silae:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
employee_id = 'EvLV61zdahkN4ftPJbmPCkdv' # String | ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
opts = {
  post_custom_silae_employees_employee_id_payroll_supplements_request_body: Kombo::PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsRequestBody.new({supplement_code: 'supplement_code_example', effective_date: Time.now}) # PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsRequestBody | POST /custom/silae/employees/:employee_id/payroll-supplements Request body
}

begin
  # Write Payroll Supplement
  result = api_instance.post_custom_silae_employees_employee_id_payroll_supplements(x_integration_id, employee_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_silae_employees_employee_id_payroll_supplements: #{e}"
end

Using the post_custom_silae_employees_employee_id_payroll_supplements_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_custom_silae_employees_employee_id_payroll_supplements_with_http_info(x_integration_id, employee_id, opts)

begin
  # Write Payroll Supplement
  data, status_code, headers = api_instance.post_custom_silae_employees_employee_id_payroll_supplements_with_http_info(x_integration_id, employee_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->post_custom_silae_employees_employee_id_payroll_supplements_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
employee_id String ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
post_custom_silae_employees_employee_id_payroll_supplements_request_body PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsRequestBody POST /custom/silae/employees/:employee_id/payroll-supplements Request body [optional]

Return type

PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

put_custom_datev_employees_employee_id_compensations

put_custom_datev_employees_employee_id_compensations(x_integration_id, employee_id, opts)

Set DATEV compensations

Sets the compensations for an employee on the specified effective date. Other compensations will end at the effective date. That means, if you would like to add a compensation, you also have to include the compensations that you would like to keep. This endpoint requires the permission Manage payroll to be enabled in your scope config. ### Example Request Body json { \"employee_id\": \"3bdhemmSP1TPQDGWtRveRot9\", \"effective_date\": \"2022-12-01\", \"compensations\": [ { \"amount\": 4500, \"currency\": \"EUR\", \"period\": \"MONTH\", \"lohnart\": 200 }, { \"amount\": 30, \"currency\": \"EUR\", \"period\": \"HOUR\" } ] }

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
employee_id = '3bdhemmSP1TPQDGWtRveRot9' # String | ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
opts = {
  put_custom_datev_employees_employee_id_compensations_request_body: Kombo::PutCustomDatevEmployeesEmployeeIdCompensationsRequestBody.new({effective_date: Time.now, compensations: [Kombo::PutCustomDatevEmployeesEmployeeIdCompensationsRequestBodyCompensationsInner.new({amount: 3.56, currency: 'EUR', period: 'HOUR'})]}) # PutCustomDatevEmployeesEmployeeIdCompensationsRequestBody | PUT /custom/datev/employees/:employee_id/compensations Request body
}

begin
  # Set DATEV compensations
  result = api_instance.put_custom_datev_employees_employee_id_compensations(x_integration_id, employee_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->put_custom_datev_employees_employee_id_compensations: #{e}"
end

Using the put_custom_datev_employees_employee_id_compensations_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> put_custom_datev_employees_employee_id_compensations_with_http_info(x_integration_id, employee_id, opts)

begin
  # Set DATEV compensations
  data, status_code, headers = api_instance.put_custom_datev_employees_employee_id_compensations_with_http_info(x_integration_id, employee_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PutCustomDatevEmployeesEmployeeIdCompensationsPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->put_custom_datev_employees_employee_id_compensations_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
employee_id String ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
put_custom_datev_employees_employee_id_compensations_request_body PutCustomDatevEmployeesEmployeeIdCompensationsRequestBody PUT /custom/datev/employees/:employee_id/compensations Request body [optional]

Return type

PutCustomDatevEmployeesEmployeeIdCompensationsPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

put_custom_datev_employees_employee_id_prepare_payroll

put_custom_datev_employees_employee_id_prepare_payroll(x_integration_id, employee_id, opts)

Prepare DATEV Payroll

What DATEV requires to prepare payroll is very specific and currently, as DATEV is not providing "read", this is not part of the unified model. This endpoint requires the permission Manage payroll to be enabled in your scope config. ### Example Request Body json { \"employee_id\": \"EvLV61zdahkN4ftPJbmPCkdv\", \"payroll_run\": { \"date\": \"2022-05-01\" }, \"fixed_payments\": [ { \"amount\": 560, \"lohnart\": 100 } ], \"hourly_payments\": [ { \"hours\": 14, \"lohnart\": 200 }, { \"hours\": 16, \"lohnart\": 232 } ], \"custom_lodas\": [ { \"amount\": 8, \"lohnart\": 300, \"bearbeitungsschluessel\": 4 } ] }

Examples

require 'time'
require 'kombo_client'
# setup authorization
Kombo.configure do |config|
  # Configure Bearer authorization: ApiKey
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Kombo::CustomEndpointsApi.new
x_integration_id = 'datev:HWUTwvyx2wLoSUHphiWVrp28' # String | ID of the integration you want to interact with.
employee_id = 'EvLV61zdahkN4ftPJbmPCkdv' # String | ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
opts = {
  put_custom_datev_employees_employee_id_prepare_payroll_request_body: Kombo::PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBody.new({payroll_run: Kombo::PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBodyPayrollRun.new({date: Time.now}), hourly_payments: [Kombo::PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBodyHourlyPaymentsInner.new({hours: 3.56, lohnart: 3.56})], fixed_payments: [Kombo::PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBodyFixedPaymentsInner.new({amount: 3.56, lohnart: 3.56})]}) # PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBody | PUT /custom/datev/employees/:employee_id/prepare-payroll Request body
}

begin
  # Prepare DATEV Payroll
  result = api_instance.put_custom_datev_employees_employee_id_prepare_payroll(x_integration_id, employee_id, opts)
  p result
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->put_custom_datev_employees_employee_id_prepare_payroll: #{e}"
end

Using the put_custom_datev_employees_employee_id_prepare_payroll_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> put_custom_datev_employees_employee_id_prepare_payroll_with_http_info(x_integration_id, employee_id, opts)

begin
  # Prepare DATEV Payroll
  data, status_code, headers = api_instance.put_custom_datev_employees_employee_id_prepare_payroll_with_http_info(x_integration_id, employee_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PutCustomDatevEmployeesEmployeeIdPreparePayrollPositiveResponse>
rescue Kombo::ApiError => e
  puts "Error when calling CustomEndpointsApi->put_custom_datev_employees_employee_id_prepare_payroll_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_integration_id String ID of the integration you want to interact with.
employee_id String ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`)
put_custom_datev_employees_employee_id_prepare_payroll_request_body PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBody PUT /custom/datev/employees/:employee_id/prepare-payroll Request body [optional]

Return type

PutCustomDatevEmployeesEmployeeIdPreparePayrollPositiveResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json