{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:codat-banking/list-account-balances":{"get":{"operationId":"finance_codat_banking_list_account_balances","summary":"List account balances","description":"GET /companies/{companyId}/connections/{connectionId}/data/banking-accountBalances","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-banking/list-accounts":{"get":{"operationId":"finance_codat_banking_list_accounts","summary":"List accounts","description":"GET /companies/{companyId}/connections/{connectionId}/data/banking-accounts","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-banking/list-transaction-categories":{"get":{"operationId":"finance_codat_banking_list_transaction_categories","summary":"List all transaction categories","description":"GET /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-banking/list-transactions":{"get":{"operationId":"finance_codat_banking_list_transactions","summary":"List transactions","description":"GET /companies/{companyId}/connections/{connectionId}/data/banking-transactions","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:codat-banking/list-bank-transactions":{"get":{"operationId":"finance_codat_banking_list_bank_transactions","summary":"List banking transactions","description":"GET /companies/{companyId}/data/banking-transactions","tags":["finance"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}