@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Banking API
@base https://api.codat.io
@version 3.0.0
@auth ApiKey Authorization in header
@endpoints 8
@toc companies(8)

@endpoint GET /companies/{companyId}/connections/{connectionId}/data/banking-accountBalances
@required {companyId: str(uuid), connectionId: str(uuid)}
@optional {page: int(int32)=1, pageSize: int(int32)=100, query: str, orderBy: str}
@returns(200)
@errors {400, 401, 402, 403, 404, 409, 429, 500, 503}

@endpoint GET /companies/{companyId}/connections/{connectionId}/data/banking-accounts
@required {companyId: str(uuid), connectionId: str(uuid)}
@optional {page: int(int32)=1, pageSize: int(int32)=100, query: str, orderBy: str}
@returns(200)
@errors {400, 401, 402, 403, 404, 409, 429, 500, 503}

@endpoint GET /companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}
@required {companyId: str(uuid), connectionId: str(uuid), accountId: str}
@returns(200)
@errors {401, 402, 403, 404, 409, 429, 500, 503}

@endpoint GET /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories
@optional {page: int(int32)=1, pageSize: int(int32)=100, query: str, orderBy: str}
@returns(200)
@errors {400, 401, 402, 403, 404, 409, 429, 500, 503}

@endpoint GET /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}
@returns(200)
@errors {401, 402, 403, 404, 409, 429, 500, 503}

@endpoint GET /companies/{companyId}/connections/{connectionId}/data/banking-transactions
@optional {page: int(int32)=1, pageSize: int(int32)=100, query: str, orderBy: str}
@returns(200)
@errors {400, 401, 402, 403, 404, 409, 429, 500, 503}

@endpoint GET /companies/{companyId}/data/banking-transactions
@optional {page: int(int32)=1, pageSize: int(int32)=100, query: str, orderBy: str}
@returns(200)
@errors {400, 401, 402, 403, 404, 409, 429, 500, 503}

@endpoint GET /companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}
@returns(200)
@errors {401, 402, 403, 404, 409, 429, 500, 503}

@end