{"swagger":"2.0","info":{"version":"v5","title":"Bkper REST API","description":"RESTful API for managing financial books, accounts, transactions, and balances in [Bkper](https://bkper.com).\n\n## Base URL\n\n```\nhttps://api.bkper.app\n```\n\nAll endpoints are under `/v5/`. For example:\n- `GET https://api.bkper.app/v5/user` — Get the authenticated user\n- `GET https://api.bkper.app/v5/books` — List books\n- `GET https://api.bkper.app/v5/books/{bookId}` — Get a specific book\n\n## Authentication\n\nAll requests require a [Google OAuth2](https://developers.google.com/identity/protocols/oauth2) access token with the `email` scope, sent as a Bearer token:\n\n```\nAuthorization: Bearer <access_token>\n```\n\n### Getting a token\n\nThe easiest way to authenticate is through the [Bkper CLI](https://www.npmjs.com/package/bkper), which manages the OAuth flow for you:\n\n```bash\nnpm i -g bkper\nbkper auth login  # Opens browser for Google sign-in\nbkper book list   # You're connected\n```\n\nFor programmatic access, use a client library that handles token management:\n\n- **Node.js** — [bkper-js](https://www.npmjs.com/package/bkper-js) with the CLI's `getOAuthToken()` for local scripts, or with [@bkper/web-auth](https://www.npmjs.com/package/@bkper/web-auth) for browser apps\n- **Google Apps Script** — [bkper-gs](https://www.npmjs.com/package/@bkper/bkper-gs) library, which uses Apps Script's built-in OAuth\n\nYou can also set up your own [OAuth2 client credentials](https://developers.google.com/identity/protocols/oauth2) in a Google Cloud project if you need full control over the authentication flow.\n\n## API Key (optional)\n\nFor dedicated quota and project-level usage tracking, you can pass an API key via the `key` query parameter. API keys are for quota management only — they do not replace OAuth2 authentication.\n\n## OpenAPI Specification\n\nThe machine-readable spec is available at [`https://bkper.com/docs/api/rest/openapi.json`](https://bkper.com/docs/api/rest/openapi.json). Use it with Swagger UI, Postman, or any OpenAPI-compatible tool."},"host":"api.bkper.app","basePath":"","tags":[{"name":"Apps"},{"name":"Books"},{"name":"Accounts"},{"name":"Balances"},{"name":"Collaborators"},{"name":"Collections"},{"name":"Events"},{"name":"Files"},{"name":"Groups"},{"name":"Integrations"},{"name":"Queries"},{"name":"Templates"},{"name":"Transactions"},{"name":"User"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/v5/apps":{"get":{"tags":["Apps"],"description":"List Apps","operationId":"listApps","responses":{"200":{"description":"A AppList response","schema":{"$ref":"#/definitions/AppList"},"examples":{"application/json":{"items":[{"apiVersion":"v0","clientId":"string","clientSecret":"string","connectable":true,"deprecated":true,"description":"string","developers":"string","events":["FILE_CREATED"],"filePatterns":["string"],"id":"string","installable":true,"logoUrl":"string","logoUrlDark":"string","menuOpenMode":"SIDEBAR","menuPopupHeight":"string","menuPopupWidth":"string","menuText":"string","menuUrl":"string","menuUrlDev":"string","name":"string","ownerEmail":"string","ownerId":"string","ownerLogoUrl":"string","ownerName":"string","ownerWebsite":"string","propertiesSchema":{"account":{"keys":["string"],"values":["string"]},"book":{"keys":["string"],"values":["string"]},"group":{"keys":["string"],"values":["string"]},"transaction":{"keys":["string"],"values":["string"]}},"published":true,"readme":"string","readmeMd":"string","repoPrivate":true,"repoUrl":"string","scopes":["string"],"users":"string","webhookUrl":"string","webhookUrlDev":"string","website":"string"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Apps"],"description":"Create an app","operationId":"createApp","parameters":[{"in":"body","name":"App","required":true,"schema":{"$ref":"#/definitions/App"}}],"responses":{"200":{"description":"A App response","schema":{"$ref":"#/definitions/App"},"examples":{"application/json":{"apiVersion":"v0","clientId":"string","clientSecret":"string","connectable":true,"deprecated":true,"description":"string","developers":"string","events":["FILE_CREATED"],"filePatterns":["string"],"id":"string","installable":true,"logoUrl":"string","logoUrlDark":"string","menuOpenMode":"SIDEBAR","menuPopupHeight":"string","menuPopupWidth":"string","menuText":"string","menuUrl":"string","menuUrlDev":"string","name":"string","ownerEmail":"string","ownerId":"string","ownerLogoUrl":"string","ownerName":"string","ownerWebsite":"string","propertiesSchema":{"account":{"keys":["string"],"values":["string"]},"book":{"keys":["string"],"values":["string"]},"group":{"keys":["string"],"values":["string"]},"transaction":{"keys":["string"],"values":["string"]}},"published":true,"readme":"string","readmeMd":"string","repoPrivate":true,"repoUrl":"string","scopes":["string"],"users":"string","webhookUrl":"string","webhookUrlDev":"string","website":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"put":{"tags":["Apps"],"description":"Update an app","operationId":"updateApp","parameters":[{"in":"body","name":"App","required":true,"schema":{"$ref":"#/definitions/App"}}],"responses":{"200":{"description":"A App response","schema":{"$ref":"#/definitions/App"},"examples":{"application/json":{"apiVersion":"v0","clientId":"string","clientSecret":"string","connectable":true,"deprecated":true,"description":"string","developers":"string","events":["FILE_CREATED"],"filePatterns":["string"],"id":"string","installable":true,"logoUrl":"string","logoUrlDark":"string","menuOpenMode":"SIDEBAR","menuPopupHeight":"string","menuPopupWidth":"string","menuText":"string","menuUrl":"string","menuUrlDev":"string","name":"string","ownerEmail":"string","ownerId":"string","ownerLogoUrl":"string","ownerName":"string","ownerWebsite":"string","propertiesSchema":{"account":{"keys":["string"],"values":["string"]},"book":{"keys":["string"],"values":["string"]},"group":{"keys":["string"],"values":["string"]},"transaction":{"keys":["string"],"values":["string"]}},"published":true,"readme":"string","readmeMd":"string","repoPrivate":true,"repoUrl":"string","scopes":["string"],"users":"string","webhookUrl":"string","webhookUrlDev":"string","website":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/apps/{agentId}":{"get":{"tags":["Apps"],"description":"Get an App","operationId":"getApp","parameters":[{"name":"agentId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"A App response","schema":{"$ref":"#/definitions/App"},"examples":{"application/json":{"apiVersion":"v0","clientId":"string","clientSecret":"string","connectable":true,"deprecated":true,"description":"string","developers":"string","events":["FILE_CREATED"],"filePatterns":["string"],"id":"string","installable":true,"logoUrl":"string","logoUrlDark":"string","menuOpenMode":"SIDEBAR","menuPopupHeight":"string","menuPopupWidth":"string","menuText":"string","menuUrl":"string","menuUrlDev":"string","name":"string","ownerEmail":"string","ownerId":"string","ownerLogoUrl":"string","ownerName":"string","ownerWebsite":"string","propertiesSchema":{"account":{"keys":["string"],"values":["string"]},"book":{"keys":["string"],"values":["string"]},"group":{"keys":["string"],"values":["string"]},"transaction":{"keys":["string"],"values":["string"]}},"published":true,"readme":"string","readmeMd":"string","repoPrivate":true,"repoUrl":"string","scopes":["string"],"users":"string","webhookUrl":"string","webhookUrlDev":"string","website":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books":{"get":{"tags":["Books"],"description":"List user books","operationId":"listBooks","parameters":[{"name":"query","in":"query","description":"Optional search term to filter books","required":false,"type":"string"}],"responses":{"200":{"description":"A BookList response","schema":{"$ref":"#/definitions/BookList"},"examples":{"application/json":{"items":[{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}},"post":{"tags":["Books"],"operationId":"createNewBook","parameters":[{"name":"name","in":"query","required":false,"type":"string"},{"in":"body","name":"Book","required":true,"schema":{"$ref":"#/definitions/Book"}}],"responses":{"200":{"description":"A Book response","schema":{"$ref":"#/definitions/Book"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"put":{"tags":["Books"],"description":"Update a book","operationId":"updateBook","parameters":[{"in":"body","name":"Book","required":true,"schema":{"$ref":"#/definitions/Book"}}],"responses":{"200":{"description":"A Book response","schema":{"$ref":"#/definitions/Book"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}":{"get":{"tags":["Books"],"description":"Load a book","operationId":"getBook","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"loadAccounts","in":"query","description":"Optionally load accounts and groups","required":false,"type":"boolean"},{"name":"loadGroups","in":"query","description":"Optionally load groups","required":false,"type":"boolean"}],"responses":{"200":{"description":"A Book response","schema":{"$ref":"#/definitions/Book"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"put":{"tags":["Books"],"description":"Update a book","operationId":"updateBookDeprecated","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Book","required":true,"schema":{"$ref":"#/definitions/Book"}}],"responses":{"200":{"description":"A Book response","schema":{"$ref":"#/definitions/Book"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"deprecated":true},"delete":{"tags":["Books"],"description":"Delete a book","operationId":"deleteBook","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"200":{"description":"A Book response","schema":{"$ref":"#/definitions/Book"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/accounts":{"get":{"tags":["Accounts"],"description":"List accounts","operationId":"listAccounts","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"200":{"description":"A AccountList response","schema":{"$ref":"#/definitions/AccountList"},"examples":{"application/json":{"items":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Accounts"],"description":"Create an account","operationId":"createAccount","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Account","required":true,"schema":{"$ref":"#/definitions/Account"}}],"responses":{"200":{"description":"A Account response","schema":{"$ref":"#/definitions/Account"},"examples":{"application/json":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}},"put":{"tags":["Accounts"],"description":"Update an account","operationId":"updateAccount","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Account","required":true,"schema":{"$ref":"#/definitions/Account"}}],"responses":{"200":{"description":"A Account response","schema":{"$ref":"#/definitions/Account"},"examples":{"application/json":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/accounts/batch":{"post":{"tags":["Accounts"],"description":"Batch create accounts","operationId":"createAccountsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"AccountList","required":true,"schema":{"$ref":"#/definitions/AccountList"}}],"responses":{"200":{"description":"A AccountList response","schema":{"$ref":"#/definitions/AccountList"},"examples":{"application/json":{"items":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}},"put":{"tags":["Accounts"],"description":"Batch update accounts","operationId":"updateAccountsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"AccountList","required":true,"schema":{"$ref":"#/definitions/AccountList"}}],"responses":{"200":{"description":"A AccountList response","schema":{"$ref":"#/definitions/AccountList"},"examples":{"application/json":{"items":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/accounts/delete/batch":{"post":{"tags":["Accounts"],"description":"Batch delete accounts","operationId":"deleteAccountsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"AccountList","required":true,"schema":{"$ref":"#/definitions/AccountList"}}],"responses":{"200":{"description":"A AccountList response","schema":{"$ref":"#/definitions/AccountList"},"examples":{"application/json":{"items":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/accounts/{id}":{"get":{"tags":["Accounts"],"description":"Get an account","operationId":"getAccount","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The account id or name","required":true,"type":"string"}],"responses":{"200":{"description":"A Account response","schema":{"$ref":"#/definitions/Account"},"examples":{"application/json":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"delete":{"tags":["Accounts"],"description":"Delete an account","operationId":"deleteAccount","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The account id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"A Account response","schema":{"$ref":"#/definitions/Account"},"examples":{"application/json":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/accounts/{id}/groups":{"get":{"tags":["Accounts"],"description":"List the groups of an account","operationId":"listAccountGroups","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The account id or name","required":true,"type":"string"}],"responses":{"200":{"description":"A GroupList response","schema":{"$ref":"#/definitions/GroupList"},"examples":{"application/json":{"items":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/apps":{"get":{"tags":["Books"],"description":"List book apps","operationId":"listBookApps","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"200":{"description":"A AppList response","schema":{"$ref":"#/definitions/AppList"},"examples":{"application/json":{"items":[{"apiVersion":"v0","clientId":"string","clientSecret":"string","connectable":true,"deprecated":true,"description":"string","developers":"string","events":["FILE_CREATED"],"filePatterns":["string"],"id":"string","installable":true,"logoUrl":"string","logoUrlDark":"string","menuOpenMode":"SIDEBAR","menuPopupHeight":"string","menuPopupWidth":"string","menuText":"string","menuUrl":"string","menuUrlDev":"string","name":"string","ownerEmail":"string","ownerId":"string","ownerLogoUrl":"string","ownerName":"string","ownerWebsite":"string","propertiesSchema":{"account":{"keys":["string"],"values":["string"]},"book":{"keys":["string"],"values":["string"]},"group":{"keys":["string"],"values":["string"]},"transaction":{"keys":["string"],"values":["string"]}},"published":true,"readme":"string","readmeMd":"string","repoPrivate":true,"repoUrl":"string","scopes":["string"],"users":"string","webhookUrl":"string","webhookUrlDev":"string","website":"string"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/audit":{"patch":{"tags":["Books"],"description":"Audit a book async","operationId":"auditBook","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/balances":{"get":{"tags":["Balances"],"description":"List accounts|groups Balances","operationId":"getBalances","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"query","in":"query","description":"The query to filter balances","required":true,"type":"string"}],"responses":{"200":{"description":"A Balances response","schema":{"$ref":"#/definitions/Balances"},"examples":{"application/json":{"accountBalances":[{"archived":true,"balances":[],"credit":true,"cumulativeBalance":"string","cumulativeCredit":"string","cumulativeDebit":"string","empty":true,"name":"string","normalizedName":"string","periodBalance":"string","periodCredit":"string","periodDebit":"string","permanent":true,"properties":{"key":"value"}}],"balancesUrl":"string","groupBalances":[{"accountBalances":[],"balances":[],"credit":true,"cumulativeBalance":"string","cumulativeCredit":"string","cumulativeDebit":"string","groupBalances":[],"name":"string","normalizedName":"string","periodBalance":"string","periodCredit":"string","periodDebit":"string","permanent":true,"properties":{"key":"value"}}],"nextRange":"string","periodicity":"DAILY","previousRange":"string","range":"string","rangeBeginLabel":"string","rangeEndLabel":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/collaborators":{"get":{"tags":["Collaborators"],"description":"List collaborators of the book","operationId":"listCollaborators","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"200":{"description":"A CollaboratorPayloadCollection response","schema":{"$ref":"#/definitions/CollaboratorPayloadCollection"},"examples":{"application/json":{"items":[{"agentId":"string","avatarUrl":"string","createdAt":"1592000000000","email":"string","id":"string","permission":"OWNER","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Collaborators"],"description":"Add or update a collaborator to the book","operationId":"addCollaborator","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"message","in":"query","description":"Optional message to send with the invitation email","required":false,"type":"string"},{"in":"body","name":"Collaborator","required":true,"schema":{"$ref":"#/definitions/Collaborator"}}],"responses":{"200":{"description":"A Collaborator response","schema":{"$ref":"#/definitions/Collaborator"},"examples":{"application/json":{"agentId":"string","avatarUrl":"string","createdAt":"1592000000000","email":"string","id":"string","permission":"OWNER","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/collaborators/request":{"post":{"tags":["Collaborators"],"description":"Request access to a Book","operationId":"requestBookAccess","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"permission","in":"query","description":"The permission requested in the Book","required":true,"type":"string","enum":["OWNER","EDITOR","POSTER","RECORDER","VIEWER","NONE"]},{"name":"message","in":"query","description":"An optional message to the Book owner","required":false,"type":"string"}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/collaborators/request/{id}":{"get":{"tags":["Collaborators"],"description":"Resolve a Book access request","operationId":"getBookAccessRequest","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The Book access request id","required":true,"type":"string"}],"responses":{"200":{"description":"A Collaborator response","schema":{"$ref":"#/definitions/Collaborator"},"examples":{"application/json":{"agentId":"string","avatarUrl":"string","createdAt":"1592000000000","email":"string","id":"string","permission":"OWNER","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/collaborators/{id}":{"delete":{"tags":["Collaborators"],"description":"Remove a collaborator from the book","operationId":"removeCollaborator","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The collaborator id or email","required":true,"type":"string"}],"responses":{"200":{"description":"A Collaborator response","schema":{"$ref":"#/definitions/Collaborator"},"examples":{"application/json":{"agentId":"string","avatarUrl":"string","createdAt":"1592000000000","email":"string","id":"string","permission":"OWNER","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/copy":{"post":{"tags":["Books"],"description":"Copy a book with optional transaction copying","operationId":"copyBook","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"name","in":"query","description":"Name for the copied book","required":false,"type":"string"},{"name":"copyTransactions","in":"query","description":"Whether to copy transactions","required":false,"type":"boolean"},{"name":"fromDate","in":"query","description":"Start date for copying transactions (YYYYMMDD format)","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"A Book response","schema":{"$ref":"#/definitions/Book"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/events":{"get":{"tags":["Events"],"description":"List book events","operationId":"listEvents","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"after","in":"query","description":"After date and time, on RFC3339 format","required":false,"type":"string","format":"date-time"},{"name":"before","in":"query","description":"Before date and time, on RFC3339 format","required":false,"type":"string","format":"date-time"},{"name":"error","in":"query","description":"Filter by error","required":false,"type":"boolean"},{"name":"resoureId","in":"query","description":"The resourceId associated","required":false,"type":"string"},{"name":"type","in":"query","description":"Filter by event type","required":false,"type":"string","enum":["FILE_CREATED","FILE_UPDATED","FILE_DELETED","TRANSACTION_CREATED","TRANSACTION_UPDATED","TRANSACTION_DELETED","TRANSACTION_POSTED","TRANSACTION_CHECKED","TRANSACTION_UNCHECKED","TRANSACTION_RESTORED","ACCOUNT_CREATED","ACCOUNT_UPDATED","ACCOUNT_DELETED","QUERY_CREATED","QUERY_UPDATED","QUERY_DELETED","GROUP_CREATED","GROUP_UPDATED","GROUP_DELETED","COMMENT_CREATED","COMMENT_DELETED","COLLABORATOR_ADDED","COLLABORATOR_UPDATED","COLLABORATOR_REMOVED","INTEGRATION_CREATED","INTEGRATION_UPDATED","INTEGRATION_DELETED","BOOK_CREATED","BOOK_AUDITED","BOOK_UPDATED","BOOK_DELETED"]},{"name":"limit","in":"query","description":"The dataset limit. Useful for pagination","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"A EventList response","schema":{"$ref":"#/definitions/EventList"},"examples":{"application/json":{"cursor":"string","items":[{"agent":{"id":"string","logo":"string","logoDark":"string","name":"string"},"book":{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"},"bookId":"string","botResponses":[],"createdAt":"1592000000000","createdOn":"string","data":{"object":{},"previousAttributes":{"key":"value"}},"id":"string","resource":"string","type":"FILE_CREATED","user":{"avatarUrl":"string","bankConnections":true,"billingAdminEmail":"string","billingEnabled":true,"daysLeftInTrial":1,"domain":{"id":"string","name":"string"},"email":"string","free":true,"fullName":"string","givenName":"string","hash":"string","hostedDomain":"string","id":"string","name":"string","plan":"string","planAmount":1,"planCurrency":"string","planCycle":"MONTHLY","planOverdue":true,"startedTrial":true,"totalTransactionsThisMonth":1,"totalTransactionsThisYear":1,"username":"string"}}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/events/backlog":{"get":{"tags":["Events"],"description":"Get book events backlog","operationId":"getBookEventsBacklog","parameters":[{"name":"bookId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"A Backlog response","schema":{"$ref":"#/definitions/Backlog"},"examples":{"application/json":{"count":1}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/events/replay/batch":{"patch":{"tags":["Events"],"description":"Batch replay events responses","operationId":"replayEvents","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"errorsOnly","in":"query","description":"Replay errors only","required":false,"type":"boolean"},{"in":"body","name":"EventList","required":true,"schema":{"$ref":"#/definitions/EventList"}}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/events/{id}/responses/{agentId}":{"put":{"tags":["Events"],"description":"Replay an event response","operationId":"replayEventResponse","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The event id","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"}],"responses":{"200":{"description":"A Event response","schema":{"$ref":"#/definitions/Event"},"examples":{"application/json":{"agent":{"id":"string","logo":"string","logoDark":"string","name":"string"},"book":{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"},"bookId":"string","botResponses":[{"agentId":"string","createdAt":"string","message":"string","type":"INFO"}],"createdAt":"1592000000000","createdOn":"string","data":{"object":{},"previousAttributes":{"key":"value"}},"id":"string","resource":"string","type":"FILE_CREATED","user":{"avatarUrl":"string","bankConnections":true,"billingAdminEmail":"string","billingEnabled":true,"daysLeftInTrial":1,"domain":{"id":"string","name":"string"},"email":"string","free":true,"fullName":"string","givenName":"string","hash":"string","hostedDomain":"string","id":"string","name":"string","plan":"string","planAmount":1,"planCurrency":"string","planCycle":"MONTHLY","planOverdue":true,"startedTrial":true,"totalTransactionsThisMonth":1,"totalTransactionsThisYear":1,"username":"string"}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"delete":{"tags":["Events"],"description":"Delete an event response","operationId":"deleteEventResponse","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The event id","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"}],"responses":{"200":{"description":"A Event response","schema":{"$ref":"#/definitions/Event"},"examples":{"application/json":{"agent":{"id":"string","logo":"string","logoDark":"string","name":"string"},"book":{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"},"bookId":"string","botResponses":[{"agentId":"string","createdAt":"string","message":"string","type":"INFO"}],"createdAt":"1592000000000","createdOn":"string","data":{"object":{},"previousAttributes":{"key":"value"}},"id":"string","resource":"string","type":"FILE_CREATED","user":{"avatarUrl":"string","bankConnections":true,"billingAdminEmail":"string","billingEnabled":true,"daysLeftInTrial":1,"domain":{"id":"string","name":"string"},"email":"string","free":true,"fullName":"string","givenName":"string","hash":"string","hostedDomain":"string","id":"string","name":"string","plan":"string","planAmount":1,"planCurrency":"string","planCycle":"MONTHLY","planOverdue":true,"startedTrial":true,"totalTransactionsThisMonth":1,"totalTransactionsThisYear":1,"username":"string"}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/files":{"get":{"tags":["Files"],"description":"List files","operationId":"listFiles","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"limit","in":"query","description":"The dataset limit. Useful for pagination","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"A FileList response","schema":{"$ref":"#/definitions/FileList"},"examples":{"application/json":{"cursor":"string","items":[{"agentId":"string","content":"string","contentType":"string","createdAt":"1592000000000","id":"string","name":"string","properties":{"key":"value"},"size":1,"updatedAt":"1592000000000","url":"string"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Files"],"description":"Create a file","operationId":"createFile","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"File","required":true,"schema":{"$ref":"#/definitions/File"}}],"responses":{"200":{"description":"A File response","schema":{"$ref":"#/definitions/File"},"examples":{"application/json":{"agentId":"string","content":"string","contentType":"string","createdAt":"1592000000000","id":"string","name":"string","properties":{"key":"value"},"size":1,"updatedAt":"1592000000000","url":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}},"put":{"tags":["Files"],"description":"Update a file","operationId":"updateFile","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"File","required":true,"schema":{"$ref":"#/definitions/File"}}],"responses":{"200":{"description":"A File response","schema":{"$ref":"#/definitions/File"},"examples":{"application/json":{"agentId":"string","content":"string","contentType":"string","createdAt":"1592000000000","id":"string","name":"string","properties":{"key":"value"},"size":1,"updatedAt":"1592000000000","url":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/files/{id}":{"get":{"tags":["Files"],"description":"Get a file","operationId":"getFile","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The file id","required":true,"type":"string"}],"responses":{"200":{"description":"A File response","schema":{"$ref":"#/definitions/File"},"examples":{"application/json":{"agentId":"string","content":"string","contentType":"string","createdAt":"1592000000000","id":"string","name":"string","properties":{"key":"value"},"size":1,"updatedAt":"1592000000000","url":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}},"delete":{"tags":["Files"],"description":"Delete a file","operationId":"deleteFile","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The file id","required":true,"type":"string"}],"responses":{"200":{"description":"A File response","schema":{"$ref":"#/definitions/File"},"examples":{"application/json":{"agentId":"string","content":"string","contentType":"string","createdAt":"1592000000000","id":"string","name":"string","properties":{"key":"value"},"size":1,"updatedAt":"1592000000000","url":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/groups":{"get":{"tags":["Groups"],"description":"List groups","operationId":"listGroups","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"200":{"description":"A GroupList response","schema":{"$ref":"#/definitions/GroupList"},"examples":{"application/json":{"items":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Groups"],"description":"Group a group","operationId":"createGroup","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Group","required":true,"schema":{"$ref":"#/definitions/Group"}}],"responses":{"200":{"description":"A Group response","schema":{"$ref":"#/definitions/Group"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}},"put":{"tags":["Groups"],"description":"Update a group","operationId":"updateGroup","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Group","required":true,"schema":{"$ref":"#/definitions/Group"}}],"responses":{"200":{"description":"A Group response","schema":{"$ref":"#/definitions/Group"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/groups/batch":{"post":{"tags":["Groups"],"description":"Batch create groups","operationId":"createGroupsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"GroupList","required":true,"schema":{"$ref":"#/definitions/GroupList"}}],"responses":{"200":{"description":"A GroupList response","schema":{"$ref":"#/definitions/GroupList"},"examples":{"application/json":{"items":[{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/groups/{id}":{"get":{"tags":["Groups"],"description":"Get a group","operationId":"getGroup","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The group id or name","required":true,"type":"string"}],"responses":{"200":{"description":"A Group response","schema":{"$ref":"#/definitions/Group"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"delete":{"tags":["Groups"],"description":"Delete a group","operationId":"deleteGroup","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The group id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"A Group response","schema":{"$ref":"#/definitions/Group"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","credit":true,"hasAccounts":true,"hasGroups":true,"hidden":true,"id":"string","locked":true,"mixed":true,"name":"string","normalizedName":"string","parent":null,"permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/groups/{id}/accounts":{"get":{"tags":["Groups"],"description":"List the accounts of a group","operationId":"listGroupAccounts","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The group id or name","required":true,"type":"string"}],"responses":{"200":{"description":"A AccountList response","schema":{"$ref":"#/definitions/AccountList"},"examples":{"application/json":{"items":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/integrations":{"get":{"tags":["Integrations"],"description":"List the integrations of the book","operationId":"listIntegrations","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"200":{"description":"A IntegrationList response","schema":{"$ref":"#/definitions/IntegrationList"},"examples":{"application/json":{"items":[{"addedBy":"string","agentId":"string","bookId":"string","connectionId":"string","createdAt":"1592000000000","dateAddedMs":"string","id":"string","lastUpdateMs":"string","logo":"string","logoDark":"string","name":"string","normalizedName":"string","properties":{"key":"value"},"updatedAt":"1592000000000","userId":"string"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Integrations"],"description":"Create an integration","operationId":"createIntegration","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Integration","required":true,"schema":{"$ref":"#/definitions/Integration"}}],"responses":{"200":{"description":"A Integration response","schema":{"$ref":"#/definitions/Integration"},"examples":{"application/json":{"addedBy":"string","agentId":"string","bookId":"string","connectionId":"string","createdAt":"1592000000000","dateAddedMs":"string","id":"string","lastUpdateMs":"string","logo":"string","logoDark":"string","name":"string","normalizedName":"string","properties":{"key":"value"},"updatedAt":"1592000000000","userId":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"put":{"tags":["Integrations"],"description":"Update an integration","operationId":"updateIntegration","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Integration","required":true,"schema":{"$ref":"#/definitions/Integration"}}],"responses":{"200":{"description":"A Integration response","schema":{"$ref":"#/definitions/Integration"},"examples":{"application/json":{"addedBy":"string","agentId":"string","bookId":"string","connectionId":"string","createdAt":"1592000000000","dateAddedMs":"string","id":"string","lastUpdateMs":"string","logo":"string","logoDark":"string","name":"string","normalizedName":"string","properties":{"key":"value"},"updatedAt":"1592000000000","userId":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/integrations/{id}":{"delete":{"tags":["Integrations"],"description":"Delete an integration","operationId":"deleteIntegration","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"A Integration response","schema":{"$ref":"#/definitions/Integration"},"examples":{"application/json":{"addedBy":"string","agentId":"string","bookId":"string","connectionId":"string","createdAt":"1592000000000","dateAddedMs":"string","id":"string","lastUpdateMs":"string","logo":"string","logoDark":"string","name":"string","normalizedName":"string","properties":{"key":"value"},"updatedAt":"1592000000000","userId":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/queries":{"get":{"tags":["Queries"],"description":"List saved queries","operationId":"listQueries","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"}],"responses":{"200":{"description":"A QueryList response","schema":{"$ref":"#/definitions/QueryList"},"examples":{"application/json":{"items":[{"agentId":"string","createdAt":"1592000000000","id":"string","query":"string","title":"string","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Queries"],"description":"Create a saved query","operationId":"saveQuery","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Query","required":true,"schema":{"$ref":"#/definitions/Query"}}],"responses":{"200":{"description":"A Query response","schema":{"$ref":"#/definitions/Query"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","id":"string","query":"string","title":"string","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"put":{"tags":["Queries"],"description":"Update a saved query","operationId":"updateQuery","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Query","required":true,"schema":{"$ref":"#/definitions/Query"}}],"responses":{"200":{"description":"A Query response","schema":{"$ref":"#/definitions/Query"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","id":"string","query":"string","title":"string","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/queries/{id}":{"delete":{"tags":["Queries"],"description":"Delete a saved query","operationId":"deleteQuery","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The query id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"A Query response","schema":{"$ref":"#/definitions/Query"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","id":"string","query":"string","title":"string","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/transactions":{"get":{"tags":["Transactions"],"description":"List transactions","operationId":"listTransactions","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"query","in":"query","description":"The query to filter transactions","required":false,"type":"string"},{"name":"limit","in":"query","description":"The dataset limit. Useful for pagination","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"A TransactionList response","schema":{"$ref":"#/definitions/TransactionList"},"examples":{"application/json":{"account":"string","cursor":"string","items":[{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Transactions"],"description":"Create a transaction","operationId":"createTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"timeZone","in":"query","description":"Optional time zone for parsing dates when recording from different book time zone","required":false,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":1}}},"put":{"tags":["Transactions"],"description":"Update a transaction","operationId":"updateTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/transactions/batch":{"post":{"tags":["Transactions"],"description":"Batch create transactions","operationId":"createTransactionsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"timeZone","in":"query","description":"Optional time zone for parsing dates when recording from different book time zone","required":false,"type":"string"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"200":{"description":"A TransactionList response","schema":{"$ref":"#/definitions/TransactionList"},"examples":{"application/json":{"account":"string","cursor":"string","items":[{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}},"put":{"tags":["Transactions"],"description":"Batch update transactions","operationId":"updateTransactionsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"updateChecked","in":"query","description":"True to also update checked transactions","required":false,"type":"boolean"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"200":{"description":"A TransactionList response","schema":{"$ref":"#/definitions/TransactionList"},"examples":{"application/json":{"account":"string","cursor":"string","items":[{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/check":{"patch":{"tags":["Transactions"],"description":"Check a transaction","operationId":"checkTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/transactions/check/batch":{"patch":{"tags":["Transactions"],"description":"Batch check transactions","operationId":"checkTransactionsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/count":{"get":{"tags":["Transactions"],"description":"Count transactions","operationId":"countTransactions","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"query","in":"query","description":"The query to filter transactions","required":false,"type":"string"}],"responses":{"200":{"description":"A Count response","schema":{"$ref":"#/definitions/Count"},"examples":{"application/json":{"day":1,"fuzzyDate":1,"month":1,"total":1,"year":1}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/transactions/count/posted":{"get":{"tags":["Transactions"],"description":"Count transactions posted","operationId":"countTransactionsPosted","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"after","in":"query","description":"After date, on yyyy-mm-dd format.","required":true,"type":"string","format":"date"},{"name":"before","in":"query","description":"Before date, on yyyy-mm-dd format.","required":true,"type":"string","format":"date"},{"name":"periodicity","in":"query","description":"Periodicity DAILY or MONTHLY","required":true,"type":"string","enum":["DAILY","MONTHLY","YEARLY"]}],"responses":{"200":{"description":"A Counts response","schema":{"$ref":"#/definitions/Counts"},"examples":{"application/json":{"posted":[{"day":1,"fuzzyDate":1,"month":1,"total":1,"year":1}],"trashed":[{"day":1,"fuzzyDate":1,"month":1,"total":1,"year":1}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/transactions/load":{"post":{"tags":["Transactions"],"description":"Load transactions by id","operationId":"loadTransactions","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"200":{"description":"A TransactionList response","schema":{"$ref":"#/definitions/TransactionList"},"examples":{"application/json":{"account":"string","cursor":"string","items":[{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/transactions/merge":{"patch":{"tags":["Transactions"],"description":"Merge two transactions. The first item is primary and the second is secondary. Scalar precedence is submitted primary, submitted secondary, persisted primary, then persisted secondary. Collections are unioned and deduplicated; lifecycle remains server-managed.","operationId":"mergeTransactions","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/transactions/post":{"patch":{"tags":["Transactions"],"description":"Post a transaction into accounts","operationId":"postTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/transactions/post/batch":{"patch":{"tags":["Transactions"],"description":"Batch post transactions","operationId":"postTransactionsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/remove":{"patch":{"tags":["Transactions"],"description":"Remove a transaction, sending to trash","operationId":"removeTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"deprecated":true,"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/restore":{"patch":{"tags":["Transactions"],"description":"Restore a transaction from trash","operationId":"restoreTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"deprecated":true,"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/trash":{"patch":{"tags":["Transactions"],"description":"Trash a transaction","operationId":"trashTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/transactions/trash/batch":{"patch":{"tags":["Transactions"],"description":"Batch trash transactions","operationId":"trashTransactionsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"trashChecked","in":"query","description":"True to also trash checked transactions","required":false,"type":"boolean"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/uncheck":{"patch":{"tags":["Transactions"],"description":"Uncheck a transaction","operationId":"uncheckTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/books/{bookId}/transactions/uncheck/batch":{"patch":{"tags":["Transactions"],"description":"Batch uncheck a transactions","operationId":"uncheckTransactionsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/untrash":{"patch":{"tags":["Transactions"],"description":"Untrash a transaction","operationId":"untrashTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"Transaction","required":true,"schema":{"$ref":"#/definitions/Transaction"}}],"responses":{"200":{"description":"A TransactionOperation response","schema":{"$ref":"#/definitions/TransactionOperation"},"examples":{"application/json":{"accounts":[{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"}],"transaction":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":2}}}},"/v5/books/{bookId}/transactions/untrash/batch":{"patch":{"tags":["Transactions"],"description":"Batch untrash transactions","operationId":"untrashTransactionsBatch","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"in":"body","name":"TransactionList","required":true,"schema":{"$ref":"#/definitions/TransactionList"}}],"responses":{"204":{"description":"Successful response with no content."},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}],"x-google-quota":{"metricCosts":{"requests":3}}}},"/v5/books/{bookId}/transactions/{id}":{"get":{"tags":["Transactions"],"description":"Get a transaction","operationId":"getTransaction","parameters":[{"name":"bookId","in":"path","description":"The id of the book. Same bookId url param on Bkper","required":true,"type":"string"},{"name":"id","in":"path","description":"The transaction id","required":true,"type":"string"}],"responses":{"200":{"description":"A Transaction response","schema":{"$ref":"#/definitions/Transaction"},"examples":{"application/json":{"agentId":"string","agentLogo":"string","agentLogoDark":"string","agentName":"string","amount":"1234.56","checked":true,"createdAt":"1592000000000","createdBy":"string","creditAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"date":"2024-01-15","dateFormatted":"string","dateValue":1,"debitAccount":{"agentId":"string","archived":true,"balance":"string","balanceVerified":true,"createdAt":"1592000000000","credit":true,"groups":[],"hasTransactionPosted":true,"id":"string","name":"string","normalizedName":"string","permanent":true,"properties":{"key":"value"},"type":"ASSET","updatedAt":"1592000000000"},"description":"string","draft":true,"files":[{"agentId":"string","content":"string","contentType":"string","createdAt":"1592000000000","id":"string","name":"string","properties":{"key":"value"},"size":1,"updatedAt":"1592000000000","url":"string"}],"id":"string","posted":true,"properties":{"key":"value"},"remoteIds":["string"],"tags":["string"],"trashed":true,"updatedAt":"1592000000000","urls":["string"]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/collections":{"get":{"tags":["Collections"],"operationId":"listCollections","responses":{"200":{"description":"A CollectionList response","schema":{"$ref":"#/definitions/CollectionList"},"examples":{"application/json":{"items":[{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["Collections"],"operationId":"createCollection","parameters":[{"in":"body","name":"Collection","required":true,"schema":{"$ref":"#/definitions/Collection"}}],"responses":{"200":{"description":"A Collection response","schema":{"$ref":"#/definitions/Collection"},"examples":{"application/json":{"agentId":"string","books":[{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":null,"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"put":{"tags":["Collections"],"operationId":"updateCollection","parameters":[{"in":"body","name":"Collection","required":true,"schema":{"$ref":"#/definitions/Collection"}}],"responses":{"200":{"description":"A Collection response","schema":{"$ref":"#/definitions/Collection"},"examples":{"application/json":{"agentId":"string","books":[{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":null,"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/collections/{id}":{"delete":{"tags":["Collections"],"operationId":"deleteCollection","parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"A BookList response","schema":{"$ref":"#/definitions/BookList"},"examples":{"application/json":{"items":[{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/collections/{id}/books/add":{"patch":{"tags":["Collections"],"operationId":"addBooksToCollection","parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"BookList","required":true,"schema":{"$ref":"#/definitions/BookList"}}],"responses":{"200":{"description":"A BookList response","schema":{"$ref":"#/definitions/BookList"},"examples":{"application/json":{"items":[{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/collections/{id}/books/remove":{"patch":{"tags":["Collections"],"operationId":"removeBooksFromCollection","parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"BookList","required":true,"schema":{"$ref":"#/definitions/BookList"}}],"responses":{"200":{"description":"A BookList response","schema":{"$ref":"#/definitions/BookList"},"examples":{"application/json":{"items":[{"accounts":[],"agentId":"string","autoPost":true,"closingDate":"2024-01-15","collection":{"agentId":"string","books":[],"createdAt":"1592000000000","id":"string","name":"string","ownerUsername":"string","permission":"OWNER","updatedAt":"1592000000000"},"createdAt":"1592000000000","datePattern":"dd/MM/yyyy","decimalSeparator":"DOT","fractionDigits":1,"groups":[],"id":"string","lastUpdateMs":"1592000000000","lockDate":"2024-01-15","logoUrl":"string","name":"string","ownerName":"string","pageSize":1,"period":"MONTH","periodStartMonth":"JANUARY","permission":"OWNER","properties":{"key":"value"},"timeZone":"string","timeZoneOffset":1,"totalTransactions":1,"totalTransactionsCurrentMonth":1,"totalTransactionsCurrentYear":1,"updatedAt":"1592000000000","visibility":"PUBLIC"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/templates":{"get":{"tags":["Templates"],"description":"List Templates","operationId":"listTemplates","responses":{"200":{"description":"A TemplateList response","schema":{"$ref":"#/definitions/TemplateList"},"examples":{"application/json":{"items":[{"bookId":"string","bookLink":"string","category":"string","description":"string","imageUrl":"string","name":"string","sheetsLink":"string","timesUsed":1}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user":{"get":{"tags":["User"],"description":"Retrieve the current user","operationId":"getUser","responses":{"200":{"description":"A User response","schema":{"$ref":"#/definitions/User"},"examples":{"application/json":{"avatarUrl":"string","bankConnections":true,"billingAdminEmail":"string","billingEnabled":true,"daysLeftInTrial":1,"domain":{"id":"string","name":"string"},"email":"string","free":true,"fullName":"string","givenName":"string","hash":"string","hostedDomain":"string","id":"string","name":"string","plan":"string","planAmount":1,"planCurrency":"string","planCycle":"MONTHLY","planOverdue":true,"startedTrial":true,"totalTransactionsThisMonth":1,"totalTransactionsThisYear":1,"username":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user/billing":{"get":{"tags":["User"],"description":"Retrieve the user billing information","operationId":"getBilling","responses":{"200":{"description":"A Billing response","schema":{"$ref":"#/definitions/Billing"},"examples":{"application/json":{"adminEmail":"string","daysLeftInTrial":1,"email":"string","enabled":true,"hostedDomain":"string","plan":"string","planOverdue":true,"startedTrial":true,"totalTransactionsThisMonth":1,"totalTransactionsThisYear":1,"transactionsAverage":1,"transactionsCapacity":1}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user/billing/checkout":{"get":{"tags":["User"],"description":"Retrieve the user billing checkout url for a plan","operationId":"getBillingCheckout","parameters":[{"name":"plan","in":"query","required":true,"type":"string"},{"name":"cycle","in":"query","required":false,"type":"string"},{"name":"successUrl","in":"query","required":true,"type":"string"},{"name":"cancelUrl","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"A Url response","schema":{"$ref":"#/definitions/Url"},"examples":{"application/json":{"url":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user/billing/counts":{"get":{"tags":["User"],"description":"List user billing transaction counts for last 12 months","operationId":"listBillingCounts","responses":{"200":{"description":"A Counts response","schema":{"$ref":"#/definitions/Counts"},"examples":{"application/json":{"posted":[{"day":1,"fuzzyDate":1,"month":1,"total":1,"year":1}],"trashed":[{"day":1,"fuzzyDate":1,"month":1,"total":1,"year":1}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user/billing/portal":{"get":{"tags":["User"],"description":"Retrieve the user billing portal url","operationId":"getBillingPortal","parameters":[{"name":"returnUrl","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"A Url response","schema":{"$ref":"#/definitions/Url"},"examples":{"application/json":{"url":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user/connections":{"get":{"tags":["User"],"description":"List a connection","operationId":"listConnections","responses":{"200":{"description":"A ConnectionList response","schema":{"$ref":"#/definitions/ConnectionList"},"examples":{"application/json":{"items":[{"agentId":"string","createdAt":"1592000000000","dateAddedMs":"string","email":"string","id":"string","logo":"string","name":"string","properties":{"key":"value"},"type":"APP","updatedAt":"1592000000000","userId":"string","uuid":"string"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"post":{"tags":["User"],"description":"Create a connection","operationId":"createConnection","parameters":[{"in":"body","name":"Connection","required":true,"schema":{"$ref":"#/definitions/Connection"}}],"responses":{"200":{"description":"A Connection response","schema":{"$ref":"#/definitions/Connection"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","dateAddedMs":"string","email":"string","id":"string","logo":"string","name":"string","properties":{"key":"value"},"type":"APP","updatedAt":"1592000000000","userId":"string","uuid":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"put":{"tags":["User"],"description":"Update a connection","operationId":"updateConnection","parameters":[{"in":"body","name":"Connection","required":true,"schema":{"$ref":"#/definitions/Connection"}}],"responses":{"200":{"description":"A Connection response","schema":{"$ref":"#/definitions/Connection"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","dateAddedMs":"string","email":"string","id":"string","logo":"string","name":"string","properties":{"key":"value"},"type":"APP","updatedAt":"1592000000000","userId":"string","uuid":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user/connections/{id}":{"get":{"tags":["User"],"description":"Retrieve a connection by id","operationId":"getConnection","parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"A Connection response","schema":{"$ref":"#/definitions/Connection"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","dateAddedMs":"string","email":"string","id":"string","logo":"string","name":"string","properties":{"key":"value"},"type":"APP","updatedAt":"1592000000000","userId":"string","uuid":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]},"delete":{"tags":["User"],"description":"Delete a connection","operationId":"deleteConnection","parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"A Connection response","schema":{"$ref":"#/definitions/Connection"},"examples":{"application/json":{"agentId":"string","createdAt":"1592000000000","dateAddedMs":"string","email":"string","id":"string","logo":"string","name":"string","properties":{"key":"value"},"type":"APP","updatedAt":"1592000000000","userId":"string","uuid":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/user/connections/{id}/integrations":{"get":{"tags":["User"],"description":"List integrations by connection","operationId":"listConnectionIntegrations","parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"A IntegrationList response","schema":{"$ref":"#/definitions/IntegrationList"},"examples":{"application/json":{"items":[{"addedBy":"string","agentId":"string","bookId":"string","connectionId":"string","createdAt":"1592000000000","dateAddedMs":"string","id":"string","lastUpdateMs":"string","logo":"string","logoDark":"string","name":"string","normalizedName":"string","properties":{"key":"value"},"updatedAt":"1592000000000","userId":"string"}]}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}},"/v5/users/{idOrUsername}":{"get":{"tags":["Users"],"description":"Retrieve public user identity by immutable id or username. Id takes precedence. No login required.","operationId":"getUserProfile","parameters":[{"name":"idOrUsername","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"A UserProfile response","schema":{"$ref":"#/definitions/UserProfile"},"examples":{"application/json":{"avatarUrl":"string","id":"string","name":"string","username":"string"}}},"default":{"description":"An error response from the Bkper API or its public API proxy.","schema":{"$ref":"#/definitions/ApiError"}}},"security":[]}}},"securityDefinitions":{"api_key":{"type":"apiKey","name":"key","in":"query"},"google_oauth2":{"type":"oauth2","authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","flow":"implicit","scopes":{"https://www.googleapis.com/auth/userinfo.email":"View your email address"},"x-google-issuer":"https://accounts.google.com","x-google-jwks_uri":"https://www.googleapis.com/oauth2/v1/certs","x-google-audiences":"360398463400-b1fellc2p4jg55chv79ta8rdss1d76e7.apps.googleusercontent.com"}},"definitions":{"Account":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"archived":{"type":"boolean","description":"Archived accounts are kept for history"},"balance":{"type":"string","description":"The running balance of the account at the transaction date. Only present when the account is part of a transaction response filtered by account. NOT the current account balance. To get current balances, use the Balances endpoint: GET /books/{bookId}/balances"},"balanceVerified":{"type":"boolean","description":"Whether the account balance has been verified/audited"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"credit":{"type":"boolean","description":"Credit nature or Debit otherwise"},"groups":{"type":"array","description":"The groups of the account","items":{"$ref":"#/definitions/Group"}},"hasTransactionPosted":{"type":"boolean","description":"Whether the account has any transactions posted"},"id":{"type":"string","description":"The unique id that identifies the Account in the Book"},"name":{"type":"string","description":"The name of the Account"},"normalizedName":{"type":"string","description":"The name of the Account, lowercase, without spaces or special characters"},"permanent":{"type":"boolean","description":"Permanent are such as bank accounts, customers or the like"},"properties":{"type":"object","description":"The key/value custom properties of the Account","additionalProperties":{"type":"string"}},"type":{"type":"string","description":"The type of the account","enum":["ASSET","LIABILITY","INCOMING","OUTGOING"]},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"}}},"AccountBalances":{"type":"object","properties":{"archived":{"type":"boolean"},"balances":{"type":"array","items":{"$ref":"#/definitions/Balance"}},"credit":{"type":"boolean"},"cumulativeBalance":{"type":"string"},"cumulativeCredit":{"type":"string"},"cumulativeDebit":{"type":"string"},"empty":{"type":"boolean"},"name":{"type":"string"},"normalizedName":{"type":"string"},"periodBalance":{"type":"string"},"periodCredit":{"type":"string"},"periodDebit":{"type":"string"},"permanent":{"type":"boolean"},"properties":{"type":"object","additionalProperties":{"type":"string"}}}},"AccountList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Account"}}}},"Agent":{"type":"object","properties":{"id":{"type":"string","description":"The agent id"},"logo":{"type":"string","description":"The agent logo. Public url or Base64 encoded"},"logoDark":{"type":"string","description":"The agent logo on dark mode. Public url or Base64 encoded"},"name":{"type":"string","description":"The agent name"}}},"App":{"type":"object","properties":{"apiVersion":{"type":"string","description":"The API version of the event payload","enum":["v0","v1","v2","v3","v4","v5"]},"clientId":{"type":"string","description":"The Google OAuth Client ID"},"clientSecret":{"type":"string","description":"The Google OAuth Client Secret"},"connectable":{"type":"boolean","description":"Whether this app is connectable by a user"},"deprecated":{"type":"boolean","description":"Whether the app is deprecated"},"description":{"type":"string","description":"The App description"},"developers":{"type":"string","description":"The developers (usernames and domain patterns), comma or space separated"},"events":{"type":"array","description":"Event types the App listen to","items":{"type":"string","enum":["FILE_CREATED","FILE_UPDATED","FILE_DELETED","TRANSACTION_CREATED","TRANSACTION_UPDATED","TRANSACTION_DELETED","TRANSACTION_POSTED","TRANSACTION_CHECKED","TRANSACTION_UNCHECKED","TRANSACTION_RESTORED","ACCOUNT_CREATED","ACCOUNT_UPDATED","ACCOUNT_DELETED","QUERY_CREATED","QUERY_UPDATED","QUERY_DELETED","GROUP_CREATED","GROUP_UPDATED","GROUP_DELETED","COMMENT_CREATED","COMMENT_DELETED","COLLABORATOR_ADDED","COLLABORATOR_UPDATED","COLLABORATOR_REMOVED","INTEGRATION_CREATED","INTEGRATION_UPDATED","INTEGRATION_DELETED","BOOK_CREATED","BOOK_AUDITED","BOOK_UPDATED","BOOK_DELETED"]}},"filePatterns":{"type":"array","description":"File patterns the App handles - wildcard accepted. E.g. *.pdf, *-bank.csv","items":{"type":"string"}},"id":{"type":"string","description":"The unique agent id of the App - this can't be changed after created"},"installable":{"type":"boolean","description":"Whether this app is installable in a book"},"logoUrl":{"type":"string","description":"The App logo url"},"logoUrlDark":{"type":"string","description":"The App logo url in dark mode"},"menuOpenMode":{"type":"string","description":"How the app menu opens. Default to SIDEBAR","enum":["SIDEBAR","EXPANDED","NEW_TAB"]},"menuPopupHeight":{"type":"string","description":"Deprecated"},"menuPopupWidth":{"type":"string","description":"Deprecated"},"menuText":{"type":"string","description":"The contex menu text - default to the App name"},"menuUrl":{"type":"string","description":"The context menu url"},"menuUrlDev":{"type":"string","description":"The context menu url in dev mode"},"name":{"type":"string","description":"The App name"},"ownerEmail":{"type":"string","description":"The owner user email"},"ownerId":{"type":"string","description":"The owner user id"},"ownerLogoUrl":{"type":"string","description":"The owner company logo url"},"ownerName":{"type":"string","description":"The owner company name"},"ownerWebsite":{"type":"string","description":"The owner company website url"},"propertiesSchema":{"$ref":"#/definitions/AppPropertiesSchema"},"published":{"type":"boolean","description":"Whether this app is already published"},"readme":{"type":"string","description":"The readme.md file as string"},"readmeMd":{"type":"string","description":"The readme.md file as raw markdown string"},"repoPrivate":{"type":"boolean","description":"Whether the code repository is private"},"repoUrl":{"type":"string","description":"The code repository url"},"scopes":{"type":"array","description":"The Google OAuth Scopes used by the app","items":{"type":"string"}},"users":{"type":"string","description":"The users (usernames and domain patterns) to enable the App while not yet published"},"webhookUrl":{"type":"string","description":"The Webhook endpoint URL to listen for book events"},"webhookUrlDev":{"type":"string","description":"The Webhook endpoint URL to listen for book events in dev mode"},"website":{"type":"string","description":"The App website url"}}},"AppList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/App"}}}},"AppPropertiesSchema":{"type":"object","properties":{"account":{"$ref":"#/definitions/AppPropertySchema"},"book":{"$ref":"#/definitions/AppPropertySchema"},"group":{"$ref":"#/definitions/AppPropertySchema"},"transaction":{"$ref":"#/definitions/AppPropertySchema"}}},"AppPropertySchema":{"type":"object","properties":{"keys":{"type":"array","description":"The property keys schema","items":{"type":"string"}},"values":{"type":"array","description":"The property values schema","items":{"type":"string"}}}},"Backlog":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}}},"Balance":{"type":"object","properties":{"cumulativeBalance":{"type":"string"},"cumulativeCredit":{"type":"string"},"cumulativeDebit":{"type":"string"},"day":{"type":"integer","format":"int32"},"fuzzyDate":{"type":"integer","format":"int32"},"month":{"type":"integer","format":"int32"},"periodBalance":{"type":"string"},"periodCredit":{"type":"string"},"periodDebit":{"type":"string"},"year":{"type":"integer","format":"int32"}}},"Balances":{"type":"object","properties":{"accountBalances":{"type":"array","items":{"$ref":"#/definitions/AccountBalances"}},"balancesUrl":{"type":"string"},"groupBalances":{"type":"array","items":{"$ref":"#/definitions/GroupBalances"}},"nextRange":{"type":"string"},"periodicity":{"type":"string","enum":["DAILY","MONTHLY","YEARLY"]},"previousRange":{"type":"string"},"range":{"type":"string"},"rangeBeginLabel":{"type":"string"},"rangeEndLabel":{"type":"string"}}},"Billing":{"type":"object","properties":{"adminEmail":{"type":"string","description":"The billing admin email for the user's billing account"},"daysLeftInTrial":{"type":"integer","format":"int32","description":"How many days the user has left in the trial period"},"email":{"type":"string","description":"The user's email address"},"enabled":{"type":"boolean","description":"True if billing is enabled for the user"},"hostedDomain":{"type":"string","description":"The user hosted domain"},"plan":{"type":"string","description":"The user's current plan"},"planOverdue":{"type":"boolean","description":"True if subscription payment is overdue"},"startedTrial":{"type":"boolean","description":"True if the user has started the trial period"},"totalTransactionsThisMonth":{"type":"integer","format":"int64","description":"User-level total transactions this month"},"totalTransactionsThisYear":{"type":"integer","format":"int64","description":"User-level total transactions this year"},"transactionsAverage":{"type":"integer","format":"int64","description":"Authoritative rounded-up rolling monthly average of posted transactions for the current plan"},"transactionsCapacity":{"type":"integer","format":"int64","description":"Confirmed average monthly transaction capacity for the current plan"}}},"Book":{"type":"object","properties":{"accounts":{"type":"array","description":"The book Accounts","items":{"$ref":"#/definitions/Account"}},"agentId":{"type":"string","description":"The id of agent that created the resource"},"autoPost":{"type":"boolean","description":"Tells if the Book has auto post enabled"},"closingDate":{"type":"string","description":"The book closing date, in ISO format yyyy-MM-dd. Transactions on or before this date are closed for the period"},"collection":{"$ref":"#/definitions/Collection"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"datePattern":{"type":"string","description":"The date pattern of the Book. Example: dd/MM/yyyy"},"decimalSeparator":{"type":"string","description":"The decimal separator of the Book","enum":["DOT","COMMA"]},"fractionDigits":{"type":"integer","format":"int32","description":"The number of fraction digits (decimal places) of the Book. E.g. 2 for ####.##, 4 for ####.####"},"groups":{"type":"array","description":"The book account Groups","items":{"$ref":"#/definitions/Group"}},"id":{"type":"string","description":"The unique id that identifies the Book in the system. Found at bookId url param"},"lastUpdateMs":{"type":"string","description":"The last update date of the Book, in milliseconds"},"lockDate":{"type":"string","description":"The book lock date, in ISO format yyyy-MM-dd. Transactions on or before this date are locked"},"logoUrl":{"type":"string","description":"The logo URL of the book owner's custom domain"},"name":{"type":"string","description":"The name of the Book"},"ownerName":{"type":"string","description":"The Book owner username"},"pageSize":{"type":"integer","format":"int32","description":"The transactions pagination page size"},"period":{"type":"string","description":"The period slice for balances visualization","enum":["MONTH","QUARTER","YEAR"]},"periodStartMonth":{"type":"string","description":"The start month when YEAR period set","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"]},"permission":{"type":"string","description":"The Permission the current user has in the Book","enum":["OWNER","EDITOR","POSTER","RECORDER","VIEWER","NONE"]},"properties":{"type":"object","description":"The key/value custom properties of the Book","additionalProperties":{"type":"string"}},"timeZone":{"type":"string","description":"The time zone of the Book, in IANA format. E.g. America/New_York, Europe/London"},"timeZoneOffset":{"type":"integer","format":"int32","description":"The time zone offset of the Book, in minutes"},"totalTransactions":{"type":"integer","format":"int64","description":"The total transactions posted"},"totalTransactionsCurrentMonth":{"type":"integer","format":"int64","description":"The total transactions posted on current month"},"totalTransactionsCurrentYear":{"type":"integer","format":"int64","description":"The total transactions posted on current year"},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"},"visibility":{"type":"string","description":"The Visibility of the Book","enum":["PUBLIC","PRIVATE"]}}},"BookList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Book"}}}},"BotResponse":{"type":"object","properties":{"agentId":{"type":"string"},"createdAt":{"type":"string"},"message":{"type":"string"},"type":{"type":"string","enum":["INFO","WARNING","ERROR"]}}},"Collaborator":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"avatarUrl":{"type":"string","description":"The Collaborator public avatar url"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"email":{"type":"string","description":"The email of the Collaborator"},"id":{"type":"string","description":"The unique id that identifies the Collaborator in the Book"},"permission":{"type":"string","description":"The permission the Collaborator has in the Book","enum":["OWNER","EDITOR","POSTER","RECORDER","VIEWER","NONE"]},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"}}},"CollaboratorPayloadCollection":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/Collaborator"}}},"description":"An ordered list of Collaborator"},"Collection":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"books":{"type":"array","description":"The Books contained in the Collection","items":{"$ref":"#/definitions/Book"}},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"id":{"type":"string","description":"The unique id of the Collection"},"name":{"type":"string","description":"The name of the Collection"},"ownerUsername":{"type":"string","description":"The username of the Collection owner"},"permission":{"type":"string","description":"The permission the current user has in the Collection. E.g. OWNER, EDITOR, NONE","enum":["OWNER","EDITOR","POSTER","RECORDER","VIEWER","NONE"]},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"}}},"CollectionList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Collection"}}}},"Connection":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"dateAddedMs":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"logo":{"type":"string"},"name":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"type":{"type":"string","enum":["APP","BANK"]},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"},"userId":{"type":"string"},"uuid":{"type":"string"}}},"ConnectionList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Connection"}}}},"Count":{"type":"object","properties":{"day":{"type":"integer","format":"int32"},"fuzzyDate":{"type":"integer","format":"int32"},"month":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"year":{"type":"integer","format":"int32"}}},"Counts":{"type":"object","properties":{"posted":{"type":"array","items":{"$ref":"#/definitions/Count"}},"trashed":{"type":"array","items":{"$ref":"#/definitions/Count"}}}},"Domain":{"type":"object","properties":{"id":{"type":"string","description":"The unique id of the domain"},"name":{"type":"string","description":"The domain name"}}},"Event":{"type":"object","properties":{"agent":{"$ref":"#/definitions/Agent"},"book":{"$ref":"#/definitions/Book"},"bookId":{"type":"string","description":"The id of the Book associated to the Event"},"botResponses":{"type":"array","description":"The list of bot responses associated to the Event","items":{"$ref":"#/definitions/BotResponse"}},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"createdOn":{"type":"string","format":"date-time","description":"The creation date time on RFC3339 format"},"data":{"$ref":"#/definitions/EventData"},"id":{"type":"string","description":"The unique id that identifies the Event"},"resource":{"type":"string","description":"The resource associated to the Event"},"type":{"type":"string","description":"The type of the Event","enum":["FILE_CREATED","FILE_UPDATED","FILE_DELETED","TRANSACTION_CREATED","TRANSACTION_UPDATED","TRANSACTION_DELETED","TRANSACTION_POSTED","TRANSACTION_CHECKED","TRANSACTION_UNCHECKED","TRANSACTION_RESTORED","ACCOUNT_CREATED","ACCOUNT_UPDATED","ACCOUNT_DELETED","QUERY_CREATED","QUERY_UPDATED","QUERY_DELETED","GROUP_CREATED","GROUP_UPDATED","GROUP_DELETED","COMMENT_CREATED","COMMENT_DELETED","COLLABORATOR_ADDED","COLLABORATOR_UPDATED","COLLABORATOR_REMOVED","INTEGRATION_CREATED","INTEGRATION_UPDATED","INTEGRATION_DELETED","BOOK_CREATED","BOOK_AUDITED","BOOK_UPDATED","BOOK_DELETED"]},"user":{"$ref":"#/definitions/User"}}},"EventData":{"type":"object","properties":{"object":{"type":"object"},"previousAttributes":{"type":"object","description":"The object previous attributes when updated","additionalProperties":{"type":"string"}}}},"EventList":{"type":"object","properties":{"cursor":{"type":"string","description":"The cursor, for pagination"},"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Event"}}}},"File":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"content":{"type":"string","description":"The file content Base64 encoded"},"contentType":{"type":"string","description":"The file content type"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"id":{"type":"string","description":"The unique id that identifies the file in the book"},"name":{"type":"string","description":"The file name"},"properties":{"type":"object","description":"The key/value custom properties of the File","additionalProperties":{"type":"string"}},"size":{"type":"integer","format":"int64","description":"The file size in bytes"},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"},"url":{"type":"string","description":"The file serving url"}}},"FileList":{"type":"object","properties":{"cursor":{"type":"string","description":"The cursor, for pagination"},"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/File"}}}},"Group":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"credit":{"type":"boolean","description":"Whether the group has credit nature"},"hasAccounts":{"type":"boolean","description":"Whether the group has any accounts"},"hasGroups":{"type":"boolean","description":"Whether the group has any children groups"},"hidden":{"type":"boolean","description":"Whether the group is hidden on the transactions main menu"},"id":{"type":"string","description":"The unique id that identifies the Group in the Book"},"locked":{"type":"boolean","description":"Whether the group is locked by the Book owner"},"mixed":{"type":"boolean","description":"Whether the group has mixed types of accounts"},"name":{"type":"string","description":"The name of the Group"},"normalizedName":{"type":"string","description":"The name of the Group, lowercase, without spaces or special characters"},"parent":{"$ref":"#/definitions/Group"},"permanent":{"type":"boolean","description":"Whether the group is permanent"},"properties":{"type":"object","description":"The key/value custom properties of the Group","additionalProperties":{"type":"string"}},"type":{"type":"string","description":"The type of the accounts in the group. E.g. ASSET, LIABILITY, INCOMING, OUTGOING","enum":["ASSET","LIABILITY","INCOMING","OUTGOING"]},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"}}},"GroupBalances":{"type":"object","properties":{"accountBalances":{"type":"array","items":{"$ref":"#/definitions/AccountBalances"}},"balances":{"type":"array","items":{"$ref":"#/definitions/Balance"}},"credit":{"type":"boolean"},"cumulativeBalance":{"type":"string"},"cumulativeCredit":{"type":"string"},"cumulativeDebit":{"type":"string"},"groupBalances":{"type":"array","items":{"$ref":"#/definitions/GroupBalances"}},"name":{"type":"string"},"normalizedName":{"type":"string"},"periodBalance":{"type":"string"},"periodCredit":{"type":"string"},"periodDebit":{"type":"string"},"permanent":{"type":"boolean"},"properties":{"type":"object","additionalProperties":{"type":"string"}}}},"GroupList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Group"}}}},"Integration":{"type":"object","properties":{"addedBy":{"type":"string"},"agentId":{"type":"string","description":"The id of agent that created the resource"},"bookId":{"type":"string"},"connectionId":{"type":"string"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"dateAddedMs":{"type":"string"},"id":{"type":"string"},"lastUpdateMs":{"type":"string"},"logo":{"type":"string"},"logoDark":{"type":"string"},"name":{"type":"string"},"normalizedName":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"},"userId":{"type":"string"}}},"IntegrationList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Integration"}}}},"Query":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"id":{"type":"string","description":"The unique id that identifies the saved Query in the Book"},"query":{"type":"string","description":"The Query string to be executed"},"title":{"type":"string","description":"The title of the saved Query"},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"}}},"QueryList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Query"}}}},"Template":{"type":"object","properties":{"bookId":{"type":"string"},"bookLink":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"imageUrl":{"type":"string"},"name":{"type":"string"},"sheetsLink":{"type":"string"},"timesUsed":{"type":"integer","format":"int32"}}},"TemplateList":{"type":"object","properties":{"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Template"}}}},"Transaction":{"type":"object","properties":{"agentId":{"type":"string","description":"The id of agent that created the resource"},"agentLogo":{"type":"string","description":"The logo of the agent that created the transaction"},"agentLogoDark":{"type":"string","description":"The logo in dark mode, of the agent that created the transaction"},"agentName":{"type":"string","description":"The name of the agent that created the transaction"},"amount":{"type":"string","description":"The amount on format ####.##"},"checked":{"type":"boolean","description":"Whether the transaction is checked"},"createdAt":{"type":"string","description":"The creation timestamp, in milliseconds"},"createdBy":{"type":"string","description":"The actor username that created the transaction"},"creditAccount":{"$ref":"#/definitions/Account"},"date":{"type":"string","description":"The date on ISO format yyyy-MM-dd"},"dateFormatted":{"type":"string","description":"The date on format of the Book"},"dateValue":{"type":"integer","format":"int32","description":"The date number representation on format YYYYMMDD"},"debitAccount":{"$ref":"#/definitions/Account"},"description":{"type":"string","description":"The transaction description"},"draft":{"type":"boolean","description":"Whether the transaction is a draft"},"files":{"type":"array","description":"The files attached to the transaction","items":{"$ref":"#/definitions/File"}},"id":{"type":"string","description":"The unique id that identifies the transaction in the book"},"posted":{"type":"boolean","description":"Whether the transaction is already posted on accounts, otherwise is a draft"},"properties":{"type":"object","description":"The key/value custom properties of the Transaction","additionalProperties":{"type":"string"}},"remoteIds":{"type":"array","description":"The transaction remote ids, to avoid duplication","items":{"type":"string"}},"tags":{"type":"array","description":"The transaction #hashtags","items":{"type":"string"}},"trashed":{"type":"boolean","description":"Whether the transaction is trashed"},"updatedAt":{"type":"string","description":"The last update timestamp, in milliseconds"},"urls":{"type":"array","description":"The transaction urls","items":{"type":"string"}}}},"TransactionList":{"type":"object","properties":{"account":{"type":"string","description":"The account id when filtering by a single account. E.g. account='Bank'"},"cursor":{"type":"string","description":"The cursor, for pagination"},"items":{"type":"array","description":"List items","items":{"$ref":"#/definitions/Transaction"}}}},"TransactionOperation":{"type":"object","properties":{"accounts":{"type":"array","description":"The affected accounts","items":{"$ref":"#/definitions/Account"}},"transaction":{"$ref":"#/definitions/Transaction"}}},"Url":{"type":"object","properties":{"url":{"type":"string"}}},"User":{"type":"object","properties":{"avatarUrl":{"type":"string","description":"The user public avatar url"},"bankConnections":{"type":"boolean","description":"True if user already had any bank connection"},"billingAdminEmail":{"type":"string","description":"The billing admin email for this user's billing account"},"billingEnabled":{"type":"boolean","description":"True if billing is enabled for the user"},"daysLeftInTrial":{"type":"integer","format":"int32","description":"How many days left in trial"},"domain":{"$ref":"#/definitions/Domain"},"email":{"type":"string","description":"The user email"},"free":{"type":"boolean","description":"True if user is in the free plan"},"fullName":{"type":"string","description":"The user full name"},"givenName":{"type":"string","description":"The user given name"},"hash":{"type":"string","description":"The user hash"},"hostedDomain":{"type":"string","description":"The user hosted domain"},"id":{"type":"string","description":"The user unique id"},"name":{"type":"string","description":"The user display name"},"plan":{"type":"string","description":"The user plan"},"planAmount":{"type":"integer","format":"int64","description":"The confirmed recurring plan total in currency minor units"},"planCurrency":{"type":"string","description":"The confirmed recurring plan currency"},"planCycle":{"type":"string","description":"The user plan billing cycle","enum":["MONTHLY","YEARLY"]},"planOverdue":{"type":"boolean","description":"True if subscription payment is overdue"},"startedTrial":{"type":"boolean","description":"True if user started trial"},"totalTransactionsThisMonth":{"type":"integer","format":"int64","description":"User-level total transactions this month"},"totalTransactionsThisYear":{"type":"integer","format":"int64","description":"User-level total transactions this year"},"username":{"type":"string","description":"The Bkper username of the user"}}},"UserProfile":{"type":"object","properties":{"avatarUrl":{"type":"string","description":"The public avatar URL"},"id":{"type":"string","description":"The immutable user id"},"name":{"type":"string","description":"The public display name"},"username":{"type":"string","description":"The current Bkper username"}}},"ApiError":{"type":"object","description":"A JSON error response. API operation errors use the nested `error` object. Public API proxy errors use the Problem Details fields.","properties":{"error":{"type":"object","required":["code","message"],"properties":{"errors":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"reason":{"type":"string"},"message":{"type":"string"}}}},"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string"},"code":{"type":"string"}}}},"x-google-management":{"metrics":[{"name":"requests","valueType":"INT64","metricKind":"GAUGE","displayName":"Requests"}],"quota":{"limits":[{"name":"requests","metric":"requests","values":{"STANDARD":60},"unit":"1/min/{project}"}]}},"externalDocs":{"description":"Bkper REST API developer guide","url":"https://bkper.com/docs/platform/scripts/rest-api"},"security":[{"google_oauth2":["https://www.googleapis.com/auth/userinfo.email"]}]}