/finance/position

List positions

List positions

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

Request

Query Parameters

NameTypeRequiredDescription
searchstringNosearch
doc_searchstringNodoc_search
doctypestringNodoctype
period_of_performance_frominteger:int64Noperiod_of_performance_from
period_of_performance_untilinteger:int64Noperiod_of_performance_until
document_date_frominteger:int64Nodocument_date_from
document_date_untilinteger:int64Nodocument_date_until
status[]stringNostatus[]
custom_filter_id[]integerNocustom_filter_id[]
customer_id[]integerNocustomer_id[]
account_id[]integerNoaccount_id[]
job_id[]integerNojob_id[]
user_id[]integerNouser_id[]
service_typestringNoservice_type
category_id[]integerNocategory_id[]
commission_id[]integerNocommission_id[]
catalog_id[]integerNocatalog_id[]
craft_id[]integerNocraft_id[]
pageintegerNopage
page_sizeintegerNopage_size
cURL
curl -X GET 'https://<tenant>.dieagenturverwaltung.de/api/v2/finance/position?search=string&doc_search=string' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token'

Responses

Example
{
  "collection": [
    {...}
  ],
  "count": 123,
  "page": 123,
  "page_size": 123
}
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
}