API Docs
AbsenceAbsence Additional ContingentAbsence ContingentAccountAccountingAccounting ContactAdded ValueAsset AccountAttachmentAttendanceAuthBank AccountCatalogCommissionContactCraftCredit InvoiceCreditorCustom FilterCustom ReportCustomerCustomFieldDashboardDebitorEmailEmployment ContractEstimateFinanceFinance JournalFinance Journal PositionsFinDocCategoryFollowupForecastGeneral InfoHolidayIntegrationsInvoiceJobJob TasksLogin MethodMeMetricsOffice LocationOrder ConfirmationOrganisationPaymentPersonProcedureProcedure ViewPurchase InvoicePurchase OrderReportResource PlanningSnippetTargetTeamTemplateTimeUserUser CraftUser GroupUser Group ActionsUser Group UsersWorkPattern
POSTCustom Report

/custom_report/{id}/generate

Generate a custom report

get the custom report

Base URL
https://<tenant>.dieagenturverwaltung.de/api/v2
Required Security
ApiKeyAuth (Authorization: Session Token)
Produces
application/json

Request

Path Parameters

NameTypeRequiredDescription
idintegerYesCustom Report ID

Body Parameters

NameTypeRequiredDescription
accountcustom_report.generateRequestYesPartial Account

Parameter Models

Inspect object parameters and nested model references without loading the full Swagger file in the browser.

accountBody parametercustom_report.generateRequest
custom_filter_id
array<integer>
No description.
filter
report_models.Filter
No description.
from
integer
No description.
hide_zero_values
boolean
No description.
probabilities
array<app.ProbabilityType>
No description.
status
app.Status
No description.
until
integer
No description.
cURL
curl -X POST 'https://<tenant>.dieagenturverwaltung.de/api/v2/custom_report/123/generate' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "custom_filter_id": [
    123
  ],
  "filter": {},
  "from": 123,
  "hide_zero_values": true,
  "probabilities": [
    "sicher"
  ],
  "status": "aktiv",
  "until": 123
}'
Request Body (application/json)
{
  "custom_filter_id": [
    123
  ],
  "filter": {...},
  "from": 123,
  "hide_zero_values": true,
  "probabilities": [
    "sicher"
  ],
  "status": "aktiv",
  "until": 123
}

Responses

200OK
custom_report.CustomReportBuildapplication/json
Example
{
  "headers": {...},
  "interval": {...},
  "metrics_config": [
    {...}
  ],
  "report": {...},
  "rows": [
    {...}
  ],
  "totals": {...}
}
400Bad Request
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
404Not Found
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
500Internal Server Error
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}