@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api obono RKSV API
@version 1.4.0.0
@auth ApiKey Authorization in header | basic
@endpoints 18
@toc auth(1), registrierkassen(7), belege(1), export(9)

@group auth
@endpoint GET /auth
@returns(200)

@endgroup

@group registrierkassen
@endpoint GET /registrierkassen/{registrierkasseUuid}
@required {registrierkasseUuid: any}
@returns(200)
@errors {404}

@endpoint GET /registrierkassen/{registrierkasseUuid}/dep
@required {registrierkasseUuid: any}
@returns(200)

@endpoint POST /registrierkassen/{registrierkasseUuid}/abschluss
@required {registrierkasseUuid: any, abschlussbelegdaten: map}
@returns(201)

@endpoint GET /registrierkassen/{registrierkasseUuid}/belege
@required {registrierkasseUuid: any, format: any}
@optional {order: any, limit: any, offset: any, before: any, after: any, gte: any, lte: any}
@returns(200)

@endpoint PUT /registrierkassen/{registrierkasseUuid}/belege/{belegUuid}
@required {registrierkasseUuid: any, belegUuid: any, belegdaten: map}
@returns(201)
@errors {400, 403, 409, 415, 429, 500}

@endpoint GET /registrierkassen/{registrierkasseUuid}/belege/{belegUuid}
@required {registrierkasseUuid: any, belegUuid: any}
@returns(200)
@errors {404}

@endpoint GET /registrierkassen/{registrierkasseUuid}/monatsbelege
@required {registrierkasseUuid: any}
@optional {year: any, month: any}
@returns(200)

@endgroup

@group belege
@endpoint GET /belege/{belegUuid}
@required {belegUuid: any}
@returns(200)
@errors {404}

@endgroup

@group export
@endpoint GET /export/pdf/belege/{belegUuid}
@required {belegUuid: any}
@returns(200)

@endpoint GET /export/qr/belege/{belegUuid}
@required {belegUuid: any}
@returns(200)

@endpoint GET /export/html/belege/{belegUuid}
@required {belegUuid: any}
@returns(200)

@endpoint GET /export/thermal-print/belege/{belegUuid}
@required {belegUuid: any}
@optional {qr: any, width: any, dialect: any, encoding: any}
@returns(200)

@endpoint GET /export/gobd/registrierkassen/{registrierkasseUuid}
@required {registrierkasseUuid: any}
@optional {before: any, after: any}
@returns(200)

@endpoint GET /export/xls/registrierkassen/{registrierkasseUuid}/belege
@required {registrierkasseUuid: any}
@optional {before: any, after: any}
@returns(200)

@endpoint GET /export/csv/registrierkassen/{registrierkasseUuid}/belege
@required {registrierkasseUuid: any}
@optional {before: any, after: any, posten: any}
@returns(200)

@endpoint GET /export/dep7/registrierkassen/{registrierkasseUuid}/belege
@required {registrierkasseUuid: any}
@optional {before: any, after: any}
@returns(200)

@endpoint GET /export/dep131/registrierkassen/{registrierkasseUuid}/belege
@required {registrierkasseUuid: any}
@optional {before: any, after: any}
@returns(200)

@endgroup

@end