{"files":{"SKILL.md":"---\nname: assess-api\ndescription: \"Assess API skill. Use when working with Assess for data, companies. Covers 20 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Assess API\nAPI version: 1.0\n\n## Auth\nApiKey Authorization in header\n\n## Base URL\nhttps://api.codat.io\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status -- get data integrity status\n3. POST /data/companies/{companyId}/assess/excel -- create first excel\n\n## Endpoints\n20 endpoints across 2 groups. See references/api-spec.lap for full details.\n\n### Data\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status | Get data integrity status |\n| GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries | Get data integrity summary |\n| GET | /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details | List data type data integrity |\n| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue | Get commerce revenue metrics |\n| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders | Get orders report |\n| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds | Get refunds report |\n| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention | Get customer retention metrics |\n| GET | /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue | Get lifetime value metric |\n| GET | /data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing | Get marketing metrics report |\n| POST | /data/companies/{companyId}/assess/excel | Generate Excel report |\n| GET | /data/companies/{companyId}/assess/excel | Get Excel report status |\n| GET | /data/companies/{companyId}/assess/excel/download | Download Excel report |\n\n### Companies\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /companies/{companyId}/reports/enhancedProfitAndLoss/accounts | Get enhanced profit and loss accounts |\n| GET | /companies/{companyId}/reports/enhancedBalanceSheet/accounts | Get enhanced balance sheet accounts |\n| GET | /companies/{companyId}/reports/enhancedCashFlow/transactions | Get enhanced cash flow report |\n| GET | /companies/{companyId}/reports/enhancedInvoices | Get enhanced invoices report |\n| POST | /companies/{companyId}/reports/liabilities/loans/transactions | Generate loan transactions report |\n| GET | /companies/{companyId}/reports/liabilities/loans/transactions | List loan transactions |\n| POST | /companies/{companyId}/reports/liabilities/loans | Generate loan summaries report |\n| GET | /companies/{companyId}/reports/liabilities/loans | Get loan summaries |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all status?\" -> GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status\n- \"Search summaries?\" -> GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries\n- \"Search details?\" -> GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details\n- \"List all accounts?\" -> GET /companies/{companyId}/reports/enhancedProfitAndLoss/accounts\n- \"Search transactions?\" -> GET /companies/{companyId}/reports/enhancedCashFlow/transactions\n- \"Search enhancedInvoices?\" -> GET /companies/{companyId}/reports/enhancedInvoices\n- \"List all revenue?\" -> GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue\n- \"List all orders?\" -> GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders\n- \"List all refunds?\" -> GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds\n- \"List all customerRetention?\" -> GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention\n- \"List all lifetimeValue?\" -> GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue\n- \"List all marketing?\" -> GET /data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing\n- \"Create a excel?\" -> POST /data/companies/{companyId}/assess/excel\n- \"List all excel?\" -> GET /data/companies/{companyId}/assess/excel\n- \"List all download?\" -> GET /data/companies/{companyId}/assess/excel/download\n- \"Create a transaction?\" -> POST /companies/{companyId}/reports/liabilities/loans/transactions\n- \"List all transactions?\" -> GET /companies/{companyId}/reports/liabilities/loans/transactions\n- \"Create a loan?\" -> POST /companies/{companyId}/reports/liabilities/loans\n- \"List all loans?\" -> GET /companies/{companyId}/reports/liabilities/loans\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Assess API\n@base https://api.codat.io\n@version 1.0\n@auth ApiKey Authorization in header\n@endpoints 20\n@toc data(12), companies(8)\n\n@group data\n@endpoint GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status\n@desc Get data integrity status\n@returns(200) {metadata: [map]} # OK\n@errors {401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries\n@desc Get data integrity summary\n@optional {query: str # Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).}\n@returns(200) {summaries: [map]} # OK\n@errors {400: Your `query` parameter was not correctly formed, 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details\n@desc List data type data integrity\n@optional {page: int(int32)=1 # Page number. [Read more](https://docs.codat.io/using-the-api/paging)., pageSize: int(int32)=100 # Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)., query: str # Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)., orderBy: str # Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).}\n@returns(200) OK\n@errors {400: Your `query` parameter was not correctly formed, 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endgroup\n\n@group companies\n@endpoint GET /companies/{companyId}/reports/enhancedProfitAndLoss/accounts\n@desc Get enhanced profit and loss accounts\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.}\n@optional {numberOfPeriods: int # The number of periods to return. If not provided, 12 periods will be used as the default value.}\n@returns(200) {reportInfo: map{currency: str(ISO4217), reportName: str, companyName: str, generatedDate: str}, reportItems: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /companies/{companyId}/reports/enhancedBalanceSheet/accounts\n@desc Get enhanced balance sheet accounts\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.}\n@optional {numberOfPeriods: int # The number of periods to return. If not provided, 12 periods will be used as the default value.}\n@returns(200) {reportInfo: map{currency: str(ISO4217), reportName: str, companyName: str, generatedDate: str}, reportItems: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /companies/{companyId}/reports/enhancedCashFlow/transactions\n@desc Get enhanced cash flow report\n@optional {page: int(int32)=1 # Page number. [Read more](https://docs.codat.io/using-the-api/paging)., pageSize: int(int32)=100 # Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)., query: str # Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).}\n@returns(200) {reportInfo: map{pageNumber: int, pageSize: int, totalResults: int, reportName: str, companyName: str, generatedDate: str}, dataSources: [map], reportItems: [map]} # OK\n@errors {400: Your `query` parameter was not correctly formed, 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /companies/{companyId}/reports/enhancedInvoices\n@desc Get enhanced invoices report\n@optional {page: int(int32)=1 # Page number. [Read more](https://docs.codat.io/using-the-api/paging)., pageSize: int(int32)=100 # Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)., query: str # Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).}\n@returns(200) {reportInfo: map{pageNumber: int, pageSize: int, totalResults: int, reportName: str, companyName: str, generatedDate: str}, reportItems: [map]} # OK\n@errors {400: Your `query` parameter was not correctly formed, 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endgroup\n\n@group data\n@endpoint GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue\n@desc Get commerce revenue metrics\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month., periodLength: int # The number of months per period. E.g. 2 = 2 months per period., numberOfPeriods: int # The number of periods to return. There will be no pagination as a query parameter., periodUnit: str(Day/Week/Month/Year) # The period unit of time returned.}\n@optional {includeDisplayNames: bool # Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.}\n@returns(200) {reportInfo: map, dimensions: [map], measures: [map], reportData: [map], errors: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders\n@desc Get orders report\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month., periodLength: int # The number of months per period. E.g. 2 = 2 months per period., numberOfPeriods: int # The number of periods to return. There will be no pagination as a query parameter., periodUnit: str(Day/Week/Month/Year) # The period unit of time returned.}\n@optional {includeDisplayNames: bool # Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.}\n@returns(200) {reportInfo: map, dimensions: [map], measures: [map], reportData: [map], errors: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds\n@desc Get refunds report\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month., periodLength: int # The number of months per period. E.g. 2 = 2 months per period., numberOfPeriods: int # The number of periods to return. There will be no pagination as a query parameter., periodUnit: str(Day/Week/Month/Year) # The period unit of time returned.}\n@optional {includeDisplayNames: bool # Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.}\n@returns(200) {reportInfo: map, dimensions: [map], measures: [map], reportData: [map], errors: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention\n@desc Get customer retention metrics\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month., periodLength: int # The number of months per period. E.g. 2 = 2 months per period., numberOfPeriods: int # The number of periods to return. There will be no pagination as a query parameter., periodUnit: str(Day/Week/Month/Year) # The period unit of time returned.}\n@optional {includeDisplayNames: bool # Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.}\n@returns(200) {reportInfo: map, dimensions: [map], measures: [map], reportData: [map], errors: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue\n@desc Get lifetime value metric\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month., periodLength: int # The number of months per period. E.g. 2 = 2 months per period., numberOfPeriods: int # The number of periods to return. There will be no pagination as a query parameter., periodUnit: str(Day/Week/Month/Year) # The period unit of time returned.}\n@optional {includeDisplayNames: bool # Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.}\n@returns(200) {reportInfo: map, dimensions: [map], measures: [map], reportData: [map], errors: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing\n@desc Get marketing metrics report\n@required {reportDate: str # The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month., periodLength: int # The number of months per period. E.g. 2 = 2 months per period., numberOfPeriods: int # The number of periods to return. There will be no pagination as a query parameter., periodUnit: str(Day/Week/Month/Year) # The period unit of time returned.}\n@optional {includeDisplayNames: bool # Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable., showInputValues: bool # If set to true, then the system includes the input values within the response.}\n@returns(200) {reportInfo: map, dimensions: [map], measures: [map], reportData: [map], errors: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint POST /data/companies/{companyId}/assess/excel\n@desc Generate Excel report\n@required {reportType: str(assess/audit/enhancedFinancials/enhancedInvoices/enhancedCashFlow) # The type of report you want to generate and download.}\n@returns(200) {lastGenerated: str, inProgress: bool, queued: str, success: bool, errorMessage: str, lastInvocationId: str, reportType: str, fileSize: int?} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/assess/excel\n@desc Get Excel report status\n@required {reportType: str(assess/audit/enhancedFinancials/enhancedInvoices/enhancedCashFlow) # The type of report you want to generate and download.}\n@returns(200) {lastGenerated: str, inProgress: bool, queued: str, success: bool, errorMessage: str, lastInvocationId: str, reportType: str, fileSize: int?} # OK\n@errors {400: Your `query` parameter was not correctly formed, 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /data/companies/{companyId}/assess/excel/download\n@desc Download Excel report\n@required {reportType: str(assess/audit/enhancedFinancials/enhancedInvoices/enhancedCashFlow) # The type of report you want to generate and download.}\n@returns(200) OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endgroup\n\n@group companies\n@endpoint POST /companies/{companyId}/reports/liabilities/loans/transactions\n@desc Generate loan transactions report\n@returns(202) Accepted\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /companies/{companyId}/reports/liabilities/loans/transactions\n@desc List loan transactions\n@returns(200) {reportInfo: map{pageNumber: int, pageSize: int, totalResults: int, reportName: str, companyName: str, generatedDate: str}, reportItems: [map]} # OK\n@errors {400: The request made is not valid., 401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint POST /companies/{companyId}/reports/liabilities/loans\n@desc Generate loan summaries report\n@returns(202) Accepted\n@errors {401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endpoint GET /companies/{companyId}/reports/liabilities/loans\n@desc Get loan summaries\n@returns(200) {reportInfo: map{reportName: str, companyName: str, generatedDate: str}, reportItems: [map]} # OK\n@errors {401: Your API request was not properly authorized., 402: An account limit has been exceeded. The type of limit is described in the error property:  - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io., 403: You are using an outdated API key or a key not associated with that resource., 404: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted., 429: Too many requests were made in a given amount of time. Wait a short period and then try again., 500: There is a problem with our server. Please try again later., 503: The Codat API is temporarily offline for maintenance. Please try again later.}\n\n@endgroup\n\n@end\n"}}