/finance/catalog

Lists paged catalogs

List paged finance journals with the type 'catalog'

Base URL

https://<tenant>.dieagenturverwaltung.de/api/v2

Required Security

ApiKeyAuth (Authorization: Session Token)

Produces

application/json

Request

Query Parameters

Name	Type	Required	Description
account_id	integer	No	No description.
created_at_end	integer	No	No description.
created_at_start	integer	No	No description.
custom_filter	integer	No	No description.
customer_id	integer	No	No description.
date_customer_approval_end	integer	No	No description.
date_customer_approval_start	integer	No	No description.
date_expire_end	integer	No	No description.
date_expire_start	integer	No	No description.
delivery_date_end	integer	No	No description.
delivery_date_start	integer	No	No description.
document_date_end	integer	No	No description.
document_date_start	integer	No	No description.
field	array<string>	No	No description.
fin_doc_category_id	integer	No	No description.
ids	array<integer>	No	No description.
job_id	integer	No	No description.
order_asc	boolean	No	No description.
order_by	string	No	No description.
payment_date_end	integer	No	No description.
payment_date_start	integer	No	No description.
payment_status	array<string>	No	No description.
period_of_performance_end	integer	No	No description.
period_of_performance_start	integer	No	No description.
search	string	No	No description.
status	array<string>	No	No description.
sub_type	enum(akonto \| final_invoice \| storno \| partial_statement)	No	No description.
user_id	integer	No	No description.
with_crafts	boolean	No	No description.
page	integer	No	The page
page_size	integer	No	The page size

cURL

curl -X GET 'https://<tenant>.dieagenturverwaltung.de/api/v2/finance/catalog?account_id=123&created_at_end=1' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token'

Responses

200OK

rest_models.PageResponse-app_Catalogapplication/json

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
}