{"openapi":"3.0.1","info":{"title":"Codat API","description":"[See our Updates](https:\/\/docs.codat.io\/updates)","version":"v1"},"paths":{"\/data\/companies\/{companyId}\/assess\/dataTypes\/{dataType}\/dataIntegrity\/status":{"get":{"tags":["Assess"],"summary":"Gets match status for a given company and datatype.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Metadata.MatchMetadataResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/assess\/dataTypes\/{dataType}\/dataIntegrity\/summaries":{"get":{"tags":["Assess"],"summary":"Gets match summary for a given company and datatype, optionally restricted by a Codat query string.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Summary.MatchSummariesResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/assess\/dataTypes\/{dataType}\/dataIntegrity\/details":{"get":{"tags":["Assess"],"summary":"Gets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Details.TransactionDetailsPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/connections\/{connectionId}\/assess\/commerceMetrics\/revenue":{"get":{"tags":["Assess"],"summary":"Gets the revenue and revenue growth for a specific company connection, over one or more periods of time.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"numberOfPeriods","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodUnit","in":"query","required":true,"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Commerce.Metrics.PeriodUnit"}},{"name":"includeDisplayNames","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.Report"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/connections\/{connectionId}\/assess\/commerceMetrics\/orders":{"get":{"tags":["Assess"],"summary":"Gets the order information for a specific company connection, over one or more periods of time.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"numberOfPeriods","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodUnit","in":"query","required":true,"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Commerce.Metrics.PeriodUnit"}},{"name":"includeDisplayNames","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.Report"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/connections\/{connectionId}\/assess\/commerceMetrics\/refunds":{"get":{"tags":["Assess"],"summary":"Gets the refunds information for a specific company connection, over one or more periods of time.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"numberOfPeriods","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodUnit","in":"query","required":true,"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Commerce.Metrics.PeriodUnit"}},{"name":"includeDisplayNames","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.Report"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/connections\/{connectionId}\/assess\/commerceMetrics\/customerRetention":{"get":{"tags":["Assess"],"summary":"Gets the customer retention metrics for a specific company connection, over one or more periods of time.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"numberOfPeriods","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodUnit","in":"query","required":true,"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Commerce.Metrics.PeriodUnit"}},{"name":"includeDisplayNames","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.Report"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/connections\/{connectionId}\/assess\/commerceMetrics\/lifetimeValue":{"get":{"tags":["Assess"],"summary":"Gets the lifetime value metric for a specific company connection, over one or more periods of time.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"numberOfPeriods","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodUnit","in":"query","required":true,"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Commerce.Metrics.PeriodUnit"}},{"name":"includeDisplayNames","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.Report"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/assess\/excel":{"post":{"tags":["Assess"],"summary":"Request an Excel report for download.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportType","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Assess.AssessExcelMeta"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"get":{"tags":["Assess"],"summary":"Returns the status of the latest report requested.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportType","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Assess.AssessExcelMeta"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/data\/companies\/{companyId}\/assess\/excel\/download":{"get":{"tags":["Assess"],"summary":"Download the Excel report to a local drive.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportType","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/enhancedCashFlow\/transactions":{"get":{"tags":["Assess"],"summary":"Gets a list of banking transactions and their categories.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.CashFlowTransactionsReport"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/enhancedProfitAndLoss\/accounts":{"get":{"tags":["Assess"],"summary":"Gets a list of accounts with account categories per statement period, specific to profit and loss","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"numberOfPeriods","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Financials.Statements.EnhancedFinancialStatement"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/enhancedBalanceSheet\/accounts":{"get":{"tags":["Assess"],"summary":"Gets a list of accounts with account categories per statement period, specific to balance sheet","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"numberOfPeriods","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Financials.Statements.EnhancedFinancialStatement"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/enhancedInvoices":{"get":{"tags":["Assess"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Reports.InvoicesReport"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/liabilities\/loans":{"post":{"tags":["Assess"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"sourceType","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"get":{"tags":["Assess"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"sourceType","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.LoanSummaryReport"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/liabilities\/loans\/transactions":{"post":{"tags":["Assess"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"sourceType","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"get":{"tags":["Assess"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"sourceType","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.LoanTransactionsReport"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies":{"get":{"tags":["Companies"],"summary":"Fetch a list of all companies metadata with accounting links on the Codat platform","parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}},{"name":"tags","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.CompanyPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Companies"],"summary":"Initiate the process of onboarding a new company on the Codat platform","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.AddCompanyModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.Company"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}":{"put":{"tags":["Companies"],"summary":"Update a company with a new name and optional description","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.UpdateCompanyModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.Company"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"patch":{"tags":["Companies"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.UpdatePartialCompanyModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.Company"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"delete":{"tags":["Companies"],"summary":"Deletes a company, this is not reversible.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"get":{"tags":["Companies"],"summary":"Fetch metadata on a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.Company"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/settings":{"get":{"tags":["Companies"],"summary":"Fetch settings on a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.CompanySettings"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"put":{"tags":["Companies"],"summary":"Update settings on a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.CompanySettings"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.CompanySettings"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/syncSettings":{"get":{"tags":["Companies"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.CompanySyncSettings"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Companies"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.CompanySyncSettings"}}}},"responses":{"204":{"description":"No Content"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/products\/{productKey}":{"delete":{"tags":["Companies"],"summary":"Delete company product key from company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"put":{"tags":["Companies"],"summary":"Add company product key to company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections":{"get":{"tags":["Connection"],"summary":"Retrieve all data sources connected to a single company, including their connection statuses","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnectionPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Connection"],"summary":"Connect a data source to a company","description":"Creates a data connection in PendingAuth status for the specified company and integration.\r\nIn the request body, specify the four-digit platformKey of the integration to link the company to as a text string.\r\nUse GET \/integrations to view all platformKeys. \r\n**Note: the required request body for this endpoint has been recently changed; see details [here](https:\/\/docs.codat.io\/updates\/220825-string-request-deprecation).**","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"platformKey":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnection"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}":{"get":{"tags":["Connection"],"summary":"Retrieve a single data source connected to a single company, including its connection status","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnection"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"delete":{"tags":["Connection"],"summary":"Disconnect and delete a data source from a company","description":"This revokes and removes a data connection from being listed as a company's connection(s).","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"boolean"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"patch":{"tags":["Connection"],"summary":"Disconnect a data source from a company","description":"This revokes a company\u2019s access to a data source, but the data connection is still listed as a part of a company's\r\ndata connection(s). The status value in the request body should be \"Unlinked\" (case sensitive). Data connections\r\ncan only be unlinked if in the Linked or Deauthorized state.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnection"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/authorization":{"put":{"tags":["Connection"],"summary":"Put authorization information for a single data source connected to a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnection"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/connectionInfo\/bankFeedAccounts":{"get":{"tags":["Connection"],"summary":"Get BankFeed BankAccounts for a single data source connected to a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"put":{"tags":["Connection"],"summary":"Put BankFeed BankAccounts for a single data source connected to a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccount"}}}}},"responses":{"200":{"description":"Success"}},"deprecated":true,"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Connection"],"summary":"Post a BankFeed BankAccount for a single data source connected to a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccount"}}}},"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/connectionInfo\/bankFeedAccounts\/{bankAccountId}":{"patch":{"tags":["Connection"],"summary":"Update a single BankFeed BankAccount for a single data source connected to a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccount"}}}},"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"delete":{"tags":["Connection"],"summary":"Delete a single BankFeed BankAccount for a single data source connected to a single company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/connectionInfo\/bankFeedAccounts\/credentials":{"post":{"tags":["Connection"],"summary":"Create bank feed credentials","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"delete":{"tags":["Connection"],"summary":"Delete bank feed credentials","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/bankFeedAccounts\/mapping":{"get":{"tags":["Connection"],"summary":"List bank feed source accounts and current and potential target accounts.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Connection"],"summary":"Create bank feed bank account mapping","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccountMapping"}}}},"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/bankFeeds\/info":{"get":{"tags":["Connection"],"summary":"Get company specific bank feeds related information","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/products\/{productIdentifier}\/refresh":{"post":{"tags":["Companies"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productIdentifier","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/all":{"post":{"tags":["Data"],"summary":"Initiates the process of capturing a new data snapshot for a company","description":"Initiates the synchronisation for all possible data types supported by the linked data sources","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/queue\/{dataType}":{"post":{"tags":["Data"],"summary":"Initiates the process of capturing a data snapshot of a specified type for a company","description":"Initiates the synchronisation for a specified data type","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z-]*$","type":"string"}},{"name":"connectionId","in":"query","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DataSet"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/history":{"get":{"tags":["Data"],"summary":"Fetch a list of all data snapshots captured for a company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DataSetPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/history\/{datasetId}":{"get":{"tags":["Data"],"summary":"Fetch metadata on a single data synchronisation","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"datasetId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DataSet"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/dataStatus":{"get":{"tags":["DataStatus"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DataStatus"}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/accountTransactions":{"get":{"tags":["AccountTransactions"],"summary":"Gets the account transactions for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountTransactionPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/accountTransactions\/{accountTransactionId}":{"get":{"tags":["AccountTransactions"],"summary":"Gets the specified account transaction for a given company and connection.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountTransactionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountTransaction"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/accounts":{"get":{"tags":["Accounts"],"summary":"Gets the latest chart of accounts for a company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/accounts\/{accountId}":{"get":{"tags":["Accounts"],"summary":"Gets a single account corresponding to the supplied Id","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.AccountResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/accounts":{"post":{"tags":["Accounts"],"summary":"Posts an individual account for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Account"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/billCreditNotes":{"get":{"tags":["BillCreditNotes"],"summary":"Gets a list of all bill credit notes for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNotePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/billCreditNotes\/{billCreditNoteId}":{"get":{"tags":["BillCreditNotes"],"summary":"Gets a single billCreditNote corresponding to the supplied Id","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billCreditNoteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNote"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/billCreditNotes":{"post":{"tags":["BillCreditNotes"],"summary":"Posts a new billCreditNote to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNote"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNotePushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/billCreditNotes\/{billCreditNoteId}":{"put":{"tags":["BillCreditNotes"],"summary":"Posts an updated billCreditNote to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billCreditNoteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNote"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNotePushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/billCreditNotes\/{billCreditNoteId}\/attachment":{"post":{"tags":["BillCreditNotes"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billCreditNoteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/billPayments":{"get":{"tags":["BillPayments"],"summary":"Gets the latest billPayments for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPaymentPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/billPayments\/{billPaymentId}":{"get":{"tags":["BillPayments"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billPaymentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPayment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/billPayments":{"post":{"tags":["BillPayments"],"summary":"Posts a new bill payment to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPayment"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPaymentPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/billPayments\/{billPaymentId}":{"delete":{"tags":["BillPayments"],"summary":"Delete a single billPayment","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billPaymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"boolean"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/bills":{"get":{"tags":["Bills"],"summary":"Gets the latest bills for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/bills\/{billId}":{"get":{"tags":["Bills"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Bill"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/bills":{"post":{"tags":["Bills"],"summary":"Posts a new bill to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Bill"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/bills\/{billId}":{"put":{"tags":["Bills"],"summary":"Posts an updated bill to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Bill"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"delete":{"tags":["Bills"],"summary":"Delete a single bill","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"boolean"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/bills\/{billId}\/attachments":{"get":{"tags":["Bills"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/bills\/{billId}\/attachments\/{attachmentId}":{"get":{"tags":["Bills"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/bills\/{billId}\/attachments\/{attachmentId}\/download":{"get":{"tags":["Bills"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/bills\/{billId}\/attachments":{"post":{"tags":["Bills"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"billId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/creditNotes":{"get":{"tags":["CreditNotes"],"summary":"Gets a list of all credit notes for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNotePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/creditNotes\/{creditNoteId}":{"get":{"tags":["CreditNotes"],"summary":"Gets a single creditNote corresponding to the supplied Id","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"creditNoteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNote"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/creditNotes":{"post":{"tags":["CreditNotes"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNote"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNotePushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/creditNotes\/{creditNoteId}":{"put":{"tags":["CreditNotes"],"summary":"Posts an updated credit note to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"creditNoteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNote"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNotePushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/customers":{"get":{"tags":["Customers"],"summary":"Gets the latest customers for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/customers\/{customerId}":{"get":{"tags":["Customers"],"summary":"Gets a single customer corresponding to the supplied Id","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Customer"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/customers":{"post":{"tags":["Customers"],"summary":"Posts an individual customer for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Customer"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/customers\/{customerId}":{"put":{"tags":["Customers"],"summary":"Posts an updated customer for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Customer"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/customers\/{customerId}\/attachments":{"get":{"tags":["Customers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/customers\/{customerId}\/attachments\/{attachmentId}":{"get":{"tags":["Customers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/customers\/{customerId}\/attachments\/{attachmentId}\/download":{"get":{"tags":["Customers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directCosts":{"get":{"tags":["DirectCosts"],"summary":"Gets the direct costs for the company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectCostPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directCosts\/{directCostId}":{"get":{"tags":["DirectCosts"],"summary":"Gets the specified direct cost for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directCostId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectCost"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/directCosts":{"post":{"tags":["DirectCosts"],"summary":"Posts a new direct cost to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectCost"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectCostPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/directCosts\/{directCostId}\/attachment":{"post":{"tags":["DirectCosts"],"summary":"Posts a new direct cost attachment for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directCostId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directCosts\/{directCostId}\/attachments\/{attachmentId}":{"get":{"tags":["DirectCosts"],"summary":"Gets the specified direct cost attachment for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directCostId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directCosts\/{directCostId}\/attachments\/{attachmentId}\/download":{"get":{"tags":["DirectCosts"],"summary":"Downloads an attachment for the specified direct cost for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directCostId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directCosts\/{directCostId}\/attachments":{"get":{"tags":["DirectCosts"],"summary":"Gets all attachments for the specified direct cost for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directCostId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/directCosts\/{directCostId}":{"delete":{"tags":["DirectCosts"],"summary":"Delete a single directCost","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directCostId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"boolean"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directIncomes":{"get":{"tags":["DirectIncomes"],"summary":"Gets the direct incomes for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectIncomePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directIncomes\/{directIncomeId}":{"get":{"tags":["DirectIncomes"],"summary":"Gets the specified direct income for a given company and connection.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directIncomeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectIncome"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/directIncomes":{"post":{"tags":["DirectIncomes"],"summary":"Posts a new direct income to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectIncome"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectIncomePushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/directIncomes\/{directIncomeId}\/attachment":{"post":{"tags":["DirectIncomes"],"summary":"Posts a new direct income attachment for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directIncomeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directIncomes\/{directIncomeId}\/attachments\/{attachmentId}":{"get":{"tags":["DirectIncomes"],"summary":"Gets the specified direct income attachment for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directIncomeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directIncomes\/{directIncomeId}\/attachments\/{attachmentId}\/download":{"get":{"tags":["DirectIncomes"],"summary":"Downloads an attachment for the specified direct income for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directIncomeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/directIncomes\/{directIncomeId}\/attachments":{"get":{"tags":["DirectIncomes"],"summary":"Gets all attachments for the specified direct income for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"directIncomeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/employees":{"get":{"tags":["Employees"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.EmployeePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/employees\/{employeeId}":{"get":{"tags":["Employees"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Employee"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/financials\/balanceSheet":{"get":{"tags":["Financials"],"summary":"Gets the latest balance sheet for a company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodsToCompare","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"startMonth","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.BalanceSheetResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/financials\/profitAndLoss":{"get":{"tags":["Financials"],"summary":"Gets the latest profit and loss for a company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodsToCompare","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"startMonth","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.ProfitAndLossResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/financials\/cashFlowStatement":{"get":{"tags":["Financials"],"summary":"Gets the latest cash flow statement for a company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"periodLength","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"periodsToCompare","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"startMonth","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.CashFlowStatementResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/info":{"get":{"tags":["Info"],"summary":"Gets the latest basic info for a company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CompanyDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Info"],"summary":"Initiates the process of synchronising basic info for a company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DataSet"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/invoices":{"get":{"tags":["Invoices"],"summary":"Gets the latest invoices for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoicePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/invoices\/{invoiceId}":{"get":{"tags":["Invoices"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Invoice"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/invoices\/{invoiceId}\/pdf":{"get":{"tags":["Invoices"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/invoices\/{invoiceId}\/attachments":{"get":{"tags":["Invoices"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/invoices\/{invoiceId}\/attachments\/{attachmentId}":{"get":{"tags":["Invoices"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/invoices\/{invoiceId}\/attachments\/{attachmentId}\/download":{"get":{"tags":["Invoices"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/invoices":{"post":{"tags":["Invoices"],"summary":"Posts a new invoice to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Invoice"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoicePushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/invoices\/{invoiceId}":{"put":{"tags":["Invoices"],"summary":"Posts an updated invoice to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Invoice"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoicePushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/invoices\/{invoiceId}\/attachment":{"post":{"tags":["Invoices"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/itemReceipts":{"get":{"tags":["ItemReceipts"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemReceiptPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/itemReceipts\/{itemReceiptId}":{"get":{"tags":["ItemReceipts"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemReceiptId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemReceipt"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/items":{"get":{"tags":["Items"],"summary":"Gets the items for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/items\/{itemId}":{"get":{"tags":["Items"],"summary":"Gets the specified item for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Item"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/items":{"post":{"tags":["Items"],"summary":"Posts a new item to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Item"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/journalEntries":{"get":{"tags":["JournalEntries"],"summary":"Gets the latest journal entries for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalEntryPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/journalEntries\/{journalEntryId}":{"get":{"tags":["JournalEntries"],"summary":"Gets a single JournalEntry corresponding to the supplied Id","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"journalEntryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalEntry"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/journalEntries":{"post":{"tags":["JournalEntries"],"summary":"Posts a new journalEntry to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalEntry"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalEntryPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/journals":{"get":{"tags":["Journals"],"summary":"Gets the latest journals for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/journals\/{journalId}":{"get":{"tags":["Journals"],"summary":"Gets a single journal corresponding to the supplied Id","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"journalId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Journal"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/journals":{"post":{"tags":["Journals"],"summary":"Posts a new journal to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Journal"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/paymentMethods":{"get":{"tags":["PaymentMethods"],"summary":"Gets the payment methods for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentMethodPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/paymentMethods\/{paymentMethodId}":{"get":{"tags":["PaymentMethods"],"summary":"Gets the specified payment method for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentMethodId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentMethod"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/payments":{"get":{"tags":["Payments"],"summary":"Gets the latest payments for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/payments\/{paymentId}":{"get":{"tags":["Payments"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Payment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/payments":{"get":{"tags":["Payments"],"summary":"Gets the latest payments for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}},{"name":"linkType","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/payments":{"post":{"tags":["Payments"],"summary":"Posts a new payment to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Payment"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/purchaseOrders":{"get":{"tags":["PurchaseOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrderPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/purchaseOrders\/{purchaseOrderId}":{"get":{"tags":["PurchaseOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"purchaseOrderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrder"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/purchaseOrders":{"post":{"tags":["PurchaseOrders"],"summary":"Posts a new purchase order to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrder"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrderPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/purchaseOrders\/{purchaseOrderId}":{"put":{"tags":["PurchaseOrders"],"summary":"Posts an updated purchase order to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"purchaseOrderId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrder"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrderPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/purchaseOrders\/{purchaseOrderId}\/pdf":{"get":{"tags":["PurchaseOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"purchaseOrderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/purchaseOrders\/{purchaseOrderId}\/attachments":{"get":{"tags":["PurchaseOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"purchaseOrderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/purchaseOrders\/{purchaseOrderId}\/attachments\/{attachmentId}":{"get":{"tags":["PurchaseOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"purchaseOrderId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/purchaseOrders\/{purchaseOrderId}\/attachments\/{attachmentId}\/download":{"get":{"tags":["PurchaseOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"purchaseOrderId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/salesOrders":{"get":{"tags":["SalesOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SalesOrderPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/salesOrders\/{salesOrderId}":{"get":{"tags":["SalesOrders"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"salesOrderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SalesOrder"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/suppliers":{"get":{"tags":["Suppliers"],"summary":"Gets the latest suppliers for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/suppliers\/{supplierId}":{"get":{"tags":["Suppliers"],"summary":"Gets a single supplier corresponding to the supplied Id","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Supplier"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/suppliers":{"post":{"tags":["Suppliers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Supplier"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/suppliers\/{supplierId}":{"put":{"tags":["Suppliers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Supplier"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/suppliers\/{supplierId}\/attachments":{"get":{"tags":["Suppliers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/suppliers\/{supplierId}\/attachments\/{attachmentId}":{"get":{"tags":["Suppliers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/suppliers\/{supplierId}\/attachments\/{attachmentId}\/download":{"get":{"tags":["Suppliers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierId","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/taxRates":{"get":{"tags":["TaxRates"],"summary":"Gets the latest tax rates for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRatePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/taxRates\/{taxRateId}":{"get":{"tags":["TaxRates"],"summary":"Gets the specified tax rate for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taxRateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRate"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/trackingCategories":{"get":{"tags":["TrackingCategories"],"summary":"Gets the latest tracking categories for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.TrackingCategoryPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/trackingCategories\/{trackingCategoryId}":{"get":{"tags":["TrackingCategories"],"summary":"Gets the specified tracking categories for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"trackingCategoryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.TrackingCategoryTree"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/transfers":{"get":{"tags":["Transfers"],"summary":"Gets the transfers for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TransferPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/transfers\/{transferId}":{"get":{"tags":["Transfers"],"summary":"Gets the specified transfer for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"transferId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Transfer"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/transfers":{"post":{"tags":["Transfers"],"summary":"Posts a new transfer to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Transfer"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TransferPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/transfers\/{transferId}\/attachment":{"post":{"tags":["Transfers"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"transferId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/banking-accountBalances":{"get":{"tags":["BankingAccountBalances"],"summary":"Gets a list of balances for a bank account including end-of-day batch balance or running balances per transaction.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountBalancePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/banking-accounts":{"get":{"tags":["BankingAccounts"],"summary":"Gets a list of all bank accounts of the SMB, with rich data like balances, account numbers and institutions holding\r\nthe accounts.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/banking-accounts\/{accountId}":{"get":{"tags":["BankingAccounts"],"summary":"Gets a specified bank account for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.Account"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/bankAccounts":{"get":{"tags":["BankAccounts"],"summary":"Gets the list of bank accounts for a given connection","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccountPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/bankAccounts\/{accountId}":{"get":{"tags":["BankAccounts"],"summary":"Gets the bank account with a given ID","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccount"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/bankAccounts\/{accountId}\/bankTransactions":{"get":{"tags":["BankAccounts"],"summary":"Gets bank transactions for a given bank account ID","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankTransactionPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/options\/bankAccounts\/{accountId}\/bankTransactions":{"get":{"tags":["BankAccounts"],"summary":"Gets the options of pushing bank account transactions.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/bankAccounts":{"post":{"tags":["BankAccounts"],"summary":"Posts a new bank account to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"allowSyncOnPushComplete","in":"query","schema":{"type":"boolean","default":true}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccount"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccountPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/bankAccounts\/{bankAccountId}":{"put":{"tags":["BankAccounts"],"summary":"Posts an updated bank account to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"forceUpdate","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccount"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccountPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/push\/bankAccounts\/{accountId}\/bankTransactions":{"post":{"tags":["BankAccounts"],"summary":"Posts bank transactions to the accounting package for a given company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"allowSyncOnPushComplete","in":"query","schema":{"type":"boolean","default":true}},{"name":"timeoutInMinutes","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Controllers.Data.Accounting.BankTransactionsToPush"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankTransactionsPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/bankAccounts\/{accountId}":{"get":{"tags":["BankAccounts"],"summary":"Gets the bank account for given account ID.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankStatementAccount"}}}}},"deprecated":true,"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/bankAccounts\/{accountId}\/transactions":{"get":{"tags":["BankAccounts"],"summary":"Gets the latest bank transactions for given account ID and company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankStatementLinePagedResponse"}}}}},"deprecated":true,"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/banking-transactionCategories":{"get":{"tags":["BankingTransactionCategories"],"summary":"Gets a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction\r\nactivity.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.TransactionCategoryPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/banking-transactionCategories\/{transactionCategoryId}":{"get":{"tags":["BankingTransactionCategories"],"summary":"Gets a specified bank transaction category for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"transactionCategoryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.TransactionCategory"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/banking-transactions":{"get":{"tags":["BankingTransactions"],"summary":"Gets a list of transactions incurred by a bank account.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.TransactionPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/banking-transactions":{"get":{"tags":["BankingTransactions"],"summary":"Gets a list of transactions incurred by a company across all bank accounts.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.TransactionPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/banking-transactions\/{transactionId}":{"get":{"tags":["BankingTransactions"],"summary":"Gets a specified bank transaction for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.Transaction"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-customers":{"get":{"tags":["CommerceCustomers"],"summary":"Gets the latest commerce customers for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.CustomerPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-customers\/{customerId}":{"get":{"tags":["CommerceCustomers"],"summary":"Gets the specified commerce customer for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Customer"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-disputes":{"get":{"tags":["CommerceDisputes"],"summary":"Gets the latest commerce disputes for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.DisputePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-disputes\/{disputeId}":{"get":{"tags":["CommerceDisputes"],"summary":"Gets the specified commerce dispute for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Dispute"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-info":{"get":{"tags":["CommerceInfo"],"summary":"Gets the latest basic info for a commerce company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.CompanyInfo"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-locations":{"get":{"tags":["CommerceLocations"],"summary":"Gets the latest commerce locations for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.LocationPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-locations\/{locationId}":{"get":{"tags":["CommerceLocations"],"summary":"Gets the specified commerce location for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"locationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Location"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-orders":{"get":{"tags":["CommerceOrders"],"summary":"Gets the latest commerce orders for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.OrderPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-orders\/{orderId}":{"get":{"tags":["CommerceOrders"],"summary":"Gets the specified commerce order for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Order"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-paymentMethods":{"get":{"tags":["CommercePaymentMethods"],"summary":"Gets a list of all payment methods from a data connection","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentMethodPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-paymentMethods\/{paymentMethodId}":{"get":{"tags":["CommercePaymentMethods"],"summary":"Gets the details of an individual payment method.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentMethodId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentMethod"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-payments":{"get":{"tags":["CommercePayments"],"summary":"Gets the latest commerce payments for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-payments\/{paymentId}":{"get":{"tags":["CommercePayments"],"summary":"Gets the specified commerce payment for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-productCategories":{"get":{"tags":["CommerceProductCategories"],"summary":"Gets the latest commerce product categories for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductCategoryPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-productCategories\/{productId}":{"get":{"tags":["CommerceProductCategories"],"summary":"Gets the specified commerce product category for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductCategory"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-products":{"get":{"tags":["CommerceProducts"],"summary":"Gets the latest commerce products for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-products\/{productId}":{"get":{"tags":["CommerceProducts"],"summary":"Gets the specified commerce product for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Product"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-transactions":{"get":{"tags":["CommerceTransactions"],"summary":"Gets the latest commerce transactions for a company, with pagination","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.TransactionPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/data\/commerce-transactions\/{transactionId}":{"get":{"tags":["CommerceTransactions"],"summary":"Gets the specified commerce transaction for a given company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"transactionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Transaction"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/data\/datasetLogs\/{datasetId}":{"get":{"tags":["DatasetLogs"],"summary":"Gets dataset messages for a given dataset","description":"This endpoint has been deprecated and removed. The functionality is no longer available.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"datasetId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/options\/{dataType}":{"get":{"tags":["Push"],"summary":"Gets the push options for the given data type","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/push":{"get":{"tags":["Push"],"summary":"Gets paged push operation records","parameters":[{"name":"companyId","in":"path","description":"Company Id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","description":"Page","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Page size","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","description":"Data query","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order by property (ascending)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/System.ObjectPushOperationPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/push\/{pushOperationKey}":{"get":{"tags":["Push"],"summary":"Gets a single push operation record","parameters":[{"name":"companyId","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"pushOperationKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/System.ObjectPushOperation"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/dataTypes\/{dataType}\/options":{"get":{"tags":["DataTypes"],"summary":"Gets all available push options for the given data type","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.PushOptionsAggregate"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/dataTypes\/{dataType}\/options\/POST":{"get":{"tags":["DataTypes"],"summary":"Gets the POST push options for the given data type","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/dataTypes\/{dataType}\/options\/PUT":{"get":{"tags":["DataTypes"],"summary":"Gets the PUT push options for the given data type","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/files":{"get":{"tags":["Files"],"summary":"View all files uploaded by a specified company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.FileMetadataModel"}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/files\/download":{"get":{"tags":["Files"],"summary":"Download all files for a company. You can specify a date to download specific files for.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/connections\/{connectionId}\/files":{"post":{"tags":["Files"],"summary":"Upload files for a company","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"connectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/integrations\/credentials\/{platformKey}":{"delete":{"tags":["Integrations"],"summary":"Delete credentials used to authenticate with an accounting platform","parameters":[{"name":"platformKey","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]*$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","additionalProperties":{}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"get":{"tags":["Integrations"],"summary":"Fetch credentials required to authenticate with an accounting platform.","description":"Used to determine presence and version of credentials. Due to masking the credentials returned cannot be used\r\nto access the API.","parameters":[{"name":"platformKey","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]*$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","additionalProperties":{}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"put":{"tags":["Integrations"],"summary":"Update credentials required to authenticate with an accounting platform","parameters":[{"name":"platformKey","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]*$","type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","additionalProperties":{}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/integrations":{"get":{"tags":["Integrations"],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.PlatformSourceModelPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/integrations\/{platformKey}":{"get":{"tags":["Integrations"],"parameters":[{"name":"platformKey","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]*$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.PlatformSourceModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/integrations\/{platformKey}\/branding":{"get":{"tags":["Integrations"],"parameters":[{"name":"platformKey","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]*$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/integrations\/bankSettings":{"get":{"tags":["Integrations"],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.BankingSettingsModels_BankSettingsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"put":{"tags":["Integrations"],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.BankingSettingsModels_BankSettingsDataset"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.BankingSettingsModels_BankSettingsDataset"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/integrations\/{platformKey}\/enabled":{"put":{"tags":["Integrations"],"parameters":[{"name":"platformKey","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]*$","type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.EnabledArgs"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.PlatformSourceModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/products\/{productId}":{"get":{"tags":["Products"],"summary":"Get a single product by product ID","parameters":[{"name":"productId","in":"path","description":"GUID of the product","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.ClientProduct"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"put":{"tags":["Products"],"summary":"Update product status by product ID","parameters":[{"name":"productId","in":"path","description":"GUID of the product","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Product object with status to update","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.Parameters.UpdateClientProduct"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.ClientProduct"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/products":{"get":{"tags":["Products"],"summary":"Get product list","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.ClientProduct"}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/products\/{productKey}\/settings":{"get":{"tags":["Products"],"summary":"Get all settings for a product","parameters":[{"name":"productKey","in":"path","description":"Key for the product","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","additionalProperties":{}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Products"],"parameters":[{"name":"productKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/products\/{productKey}\/setting\/definitions":{"get":{"tags":["Products"],"parameters":[{"name":"productKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.ProductSettingWithValue"}}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/products\/{productId}\/supportedIntegrations":{"get":{"tags":["Products"],"summary":"Get supported integrations list by product ID","parameters":[{"name":"productId","in":"path","description":"GUID of the product","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.ProductIntegrationSupport"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/profile":{"get":{"tags":["Profile"],"summary":"Fetch your organisations company profile","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.ProfileModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"put":{"tags":["Profile"],"summary":"Update your organisations company profile","description":"If you are using the Codat 'link site' this information will be visible there.","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.ProfileModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.ProfileModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/profile\/masked":{"get":{"tags":["Profile"],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.ProfileModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/profile\/syncSettings":{"get":{"tags":["Profile"],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.ClientSyncSettingsModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Profile"],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.ClientSyncSettings"}}}},"responses":{"200":{"description":"Success"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/profile\/syncSettings\/{dataType}":{"put":{"tags":["Profile"],"parameters":[{"name":"dataType","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.ClientSyncSettingsSinglePutModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.SyncSettings.SyncSettingModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/agedDebtor\/available":{"get":{"tags":["Reports"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"boolean"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/agedCreditor\/available":{"get":{"tags":["Reports"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"boolean"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/agedDebtor":{"get":{"tags":["Reports"],"summary":"Gets the aged debtor report for a company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"numberOfPeriods","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"periodLengthDays","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedDebtorOutstandingICollectionReport"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/agedCreditor":{"get":{"tags":["Reports"],"summary":"Gets the aged creditor report for a company.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"reportDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"numberOfPeriods","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"periodLengthDays","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedCreditorOutstandingICollectionReport"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/companies\/{companyId}\/reports\/events":{"get":{"tags":["Reports"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fromDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.CompanyEventStream"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/rules":{"get":{"tags":["Rules"],"summary":"Fetch a list of rules","parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.RulePagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"post":{"tags":["Rules"],"summary":"Subscribe to a rule","requestBody":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.AddRuleModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.Rule"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/rules\/{ruleId}":{"put":{"tags":["Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.Rule"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.Rule"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"get":{"tags":["Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.Rule"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"delete":{"tags":["Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/rules\/alerts":{"get":{"tags":["Rules"],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"companyId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.AlertModelPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/rules\/{ruleId}\/alerts":{"get":{"tags":["Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"query","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.AlertModelPagedResponse"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/rules\/alerts\/{alertId}":{"get":{"tags":["Rules"],"parameters":[{"name":"alertId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.AlertModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/settings":{"get":{"tags":["Settings"],"summary":"Fetch your settings","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.ClientSettingsModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"patch":{"tags":["Settings"],"summary":"Update your settings","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.ClientSettingsPatchModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.ClientSettingsModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}},"\/settings\/integrations\/{integrationId}":{"get":{"tags":["Settings"],"summary":"Fetch your organisations integration settings","parameters":[{"name":"integrationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationSettingsModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]},"patch":{"tags":["Settings"],"summary":"Update your organisations integration settings","parameters":[{"name":"integrationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationSettingsPatchModel"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationSettingsModel"}}}}},"security":[{"CodatLogin":[]},{"Auth0Login":[]},{"APIKeyAuth":[]}]}}},"components":{"schemas":{"Codat.Assess.DataContracts.CashFlow.Transactions.AccountRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.AccountsDataSource":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.CashFlowReportBankingAccount"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.BankingAccountIdentifiers":{"type":"object","properties":{"type":{"type":"string","nullable":true},"subType":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"bankCode":{"type":"string","nullable":true},"iban":{"type":"string","nullable":true},"bic":{"type":"string","nullable":true},"maskedAccountNumber":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.CashFlowReportBankingAccount":{"type":"object","properties":{"sourceRef":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.SourceRef"},"id":{"type":"string","nullable":true},"platformName":{"type":"string","nullable":true},"accountProvider":{"type":"string","nullable":true},"accountName":{"type":"string","nullable":true},"accountType":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"currentBalance":{"type":"number","format":"double"},"identifiers":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.BankingAccountIdentifiers"}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.CashFlowReportBankingTransaction":{"type":"object","properties":{"sourceRef":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.SourceRef"},"accountRef":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.AccountRef"},"id":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"transactionCategory":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.TransactionCategory"},"platformName":{"type":"string","nullable":true},"counterpartyNames":{"type":"array","items":{"type":"string"},"nullable":true},"balance":{"type":"number","format":"double","nullable":true},"modifiedDate":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.CashFlowTransactionsReport":{"type":"object","properties":{"reportInfo":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Common.PagedReportInfo"},"dataSources":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.AccountsDataSource"},"nullable":true},"reportItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.TransactionsDataSource"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.SourceRef":{"type":"object","properties":{"sourceType":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.SourceType"}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.SourceType":{"enum":["Banking"],"type":"string"},"Codat.Assess.DataContracts.CashFlow.Transactions.TransactionCategory":{"type":"object","properties":{"confidence":{"type":"number","format":"double","nullable":true},"levels":{"type":"array","items":{"type":"string"},"nullable":true},"confidences":{"type":"array","items":{"type":"number","format":"double"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.CashFlow.Transactions.TransactionsDataSource":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.CashFlow.Transactions.CashFlowReportBankingTransaction"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Commerce.Metrics.PeriodUnit":{"enum":["Day","Week","Month","Year"],"type":"string"},"Codat.Assess.DataContracts.Common.PagedReportInfo":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"reportName":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"generatedDate":{"type":"string","format":"date-time"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"warnings":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Common.ReportInfo":{"type":"object","properties":{"reportName":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"generatedDate":{"type":"string","format":"date-time"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"warnings":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Financials.Statements.AccountCategory":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"status":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Financials.Statements.AccountCategoryStatus"},"levels":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Financials.Statements.AccountCategoryLevel"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Financials.Statements.AccountCategoryLevel":{"type":"object","properties":{"levelName":{"type":"string","nullable":true},"confidence":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Financials.Statements.AccountCategoryStatus":{"enum":["Confirmed","Suggested"],"type":"string"},"Codat.Assess.DataContracts.Financials.Statements.EnhancedFinancialStatement":{"type":"object","properties":{"reportInfo":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Financials.Statements.FinancialStatementReportInfo"},"reportItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Financials.Statements.FinancialStatementReportItem"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Financials.Statements.FinancialStatementReportInfo":{"type":"object","properties":{"currency":{"type":"string","nullable":true},"reportName":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"generatedDate":{"type":"string","format":"date-time"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"warnings":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Financials.Statements.FinancialStatementReportItem":{"type":"object","properties":{"date":{"type":"string","nullable":true},"balance":{"type":"number","format":"double"},"accountId":{"type":"string","nullable":true},"accountName":{"type":"string","nullable":true},"accountCategory":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Financials.Statements.AccountCategory"}},"additionalProperties":false},"Codat.Assess.DataContracts.Loans.IntegrationType":{"enum":["Accounting","Banking","Commerce"],"type":"string"},"Codat.Assess.DataContracts.Loans.LoanItem":{"type":"object","properties":{"loanRef":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.RecordRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.RecordRef"},"date":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"transactionType":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"lender":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Loans.LoanRecordRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"dataConnectionId":{"type":"string","nullable":true},"integrationType":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.IntegrationType"},"recordRefType":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Loans.LoanSummary":{"type":"object","properties":{"recordRef":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.LoanRecordRef"},"description":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true},"totalDrawdowns":{"type":"number","format":"double"},"totalRepayments":{"type":"number","format":"double"},"balance":{"type":"number","format":"double","nullable":true},"lender":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Loans.LoanSummaryReport":{"type":"object","properties":{"reportInfo":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Common.ReportInfo"},"reportItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.LoanSummary"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Loans.LoanTransactionsReport":{"type":"object","properties":{"reportInfo":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Common.PagedReportInfo"},"reportItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Loans.LoanItem"},"nullable":true}},"additionalProperties":false},"Codat.Assess.DataContracts.Loans.RecordRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"dataConnectionId":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.ClientProduct":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"isDefault":{"type":"boolean"},"key":{"type":"string","nullable":true},"hasSettings":{"type":"boolean"},"isCustom":{"type":"boolean"}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.ClientSyncSettings":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid"},"settings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.SyncSetting"},"nullable":true},"overridesDefaults":{"type":"boolean"}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.CompanySettings":{"type":"object","properties":{"companyId":{"type":"string","format":"uuid"},"offlineConnectorInstall":{"type":"boolean","nullable":true},"oneTimeSync":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.CompanySyncSettings":{"type":"object","properties":{"companyId":{"type":"string","format":"uuid"},"settings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.SyncSetting"},"nullable":true},"overridesDefaults":{"type":"boolean"}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.Parameters.UpdateClientProduct":{"type":"object","properties":{"status":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.ProductIntegrationSupport":{"type":"object","properties":{"productName":{"type":"string","nullable":true},"productId":{"type":"string","format":"uuid"},"supportedIntegrations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Contract.SupportedIntegration"},"nullable":true}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.ProductSettingWithValue":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productId":{"type":"string","format":"uuid"},"key":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"dataType":{"$ref":"#\/components\/schemas\/Codat.Clients.Api.Client.Enums.ProductSettingsDataType"},"mandatory":{"type":"boolean"},"clientVisible":{"type":"boolean"},"selectOptions":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"nullable":true},"defaultValue":{"nullable":true}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.SupportedIntegration":{"type":"object","properties":{"name":{"type":"string","nullable":true},"platformKey":{"type":"string","nullable":true},"countries":{"type":"array","items":{"type":"string"},"nullable":true},"note":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Clients.Api.Client.Contract.SyncSetting":{"type":"object","properties":{"dataType":{"type":"string","nullable":true},"fetchOnFirstLink":{"type":"boolean"},"syncSchedule":{"type":"integer","format":"int32"},"syncOrder":{"type":"integer","format":"int32"},"syncFromUtc":{"type":"string","format":"date-time","nullable":true},"syncFromWindow":{"type":"integer","format":"int32","nullable":true},"monthsToSync":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"Codat.Clients.Api.Client.Enums.ProductSettingsDataType":{"enum":["TextInput","TextArea","MaskedTextInput","Switch","Checkbox","DateInput","IPFFileUpload","MultiSelect"],"type":"string"},"Codat.DataContracts.Datasets.Account":{"required":["isBankAccount","status","type"],"type":"object","properties":{"id":{"type":"string","nullable":true},"nominalCode":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"fullyQualifiedCategory":{"type":"string","nullable":true},"fullyQualifiedName":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"currentBalance":{"type":"number","format":"double","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountType"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountStatus"},"isBankAccount":{"type":"boolean"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"validDatatypeLinks":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ValidDatatypeLinks"},"nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Account"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Account"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountStatus":{"enum":["Unknown","Active","Archived","Pending"],"type":"string"},"Codat.DataContracts.Datasets.AccountTransaction":{"type":"object","properties":{"id":{"type":"string","nullable":true},"transactionId":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"bankAccountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"date":{"type":"string","format":"date-time"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountTransactionStatus"},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"lines":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountTransactionLine"},"nullable":true},"totalAmount":{"type":"number","format":"double"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountTransactionLine":{"type":"object","properties":{"description":{"type":"string","nullable":true},"recordRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"amount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountTransactionPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountTransaction"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountTransactionStatus":{"enum":["Unknown","Unreconciled","Reconciled","Void"],"type":"string"},"Codat.DataContracts.Datasets.AccountType":{"enum":["Unknown","Asset","Expense","Income","Liability","Equity"],"type":"string"},"Codat.DataContracts.Datasets.AccountsPayableIsBilledToType":{"enum":["Unknown","NotApplicable","Customer","Project"],"type":"string"},"Codat.DataContracts.Datasets.AccountsPayableTracking":{"required":["categoryRefs","isBilledTo","isRebilledTo","recordRefs"],"type":"object","properties":{"categoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"deprecated":true},"recordRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"}},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerRef"},"invoiceTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"projectRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ProjectRef"},"isBilledTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsPayableIsBilledToType"},"isRebilledTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsPayableIsBilledToType"}},"additionalProperties":false},"Codat.DataContracts.Datasets.AccountsReceivableIsBilledToType":{"enum":["Unknown","NotApplicable","Project"],"type":"string"},"Codat.DataContracts.Datasets.AccountsReceivableTracking":{"required":["categoryRefs","isBilledTo","isRebilledTo"],"type":"object","properties":{"categoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"deprecated":true},"recordRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"nullable":true},"projectRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ProjectRef"},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerRef"},"isBilledTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsReceivableIsBilledToType"},"isRebilledTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsReceivableIsBilledToType"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Address":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AddressType"},"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AddressType":{"enum":["Unknown","Billing","Delivery"],"type":"string"},"Codat.DataContracts.Datasets.AgedCreditorOutstanding":{"type":"object","properties":{"supplierId":{"type":"string","nullable":true},"supplierName":{"type":"string","nullable":true},"agedCurrencyOutstanding":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedCurrencyOutstanding"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AgedCreditorOutstandingICollectionReport":{"required":["data","generated","reportDate"],"type":"object","properties":{"generated":{"type":"string","format":"date-time"},"reportDate":{"type":"string","format":"date-time"},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedCreditorOutstanding"}}},"additionalProperties":false},"Codat.DataContracts.Datasets.AgedCurrencyOutstanding":{"type":"object","properties":{"currency":{"type":"string","nullable":true},"agedOutstandingAmounts":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedOutstandingAmount"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AgedDebtorOutstanding":{"type":"object","properties":{"customerId":{"type":"string","nullable":true},"customerName":{"type":"string","nullable":true},"agedCurrencyOutstanding":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedCurrencyOutstanding"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AgedDebtorOutstandingICollectionReport":{"required":["data","generated","reportDate"],"type":"object","properties":{"generated":{"type":"string","format":"date-time"},"reportDate":{"type":"string","format":"date-time"},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedDebtorOutstanding"}}},"additionalProperties":false},"Codat.DataContracts.Datasets.AgedOutstandingAmount":{"type":"object","properties":{"fromDate":{"type":"string","format":"date-time","nullable":true},"toDate":{"type":"string","format":"date-time"},"amount":{"type":"number","format":"double"},"details":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AgedOutstandingAmountDetail"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AgedOutstandingAmountDetail":{"type":"object","properties":{"name":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Allocation":{"type":"object","properties":{"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"allocatedOnDate":{"type":"string","format":"date-time","nullable":true},"totalAmount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.AttachmentsDataset":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AttachmentsDataset_Attachment"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.AttachmentsDataset_Attachment":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"contentType":{"type":"string","nullable":true},"dateCreated":{"type":"string","format":"date-time","nullable":true},"fileSize":{"type":"integer","format":"int32","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"includeWhenSent":{"type":"boolean"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BalanceSheet":{"required":["netAssets"],"type":"object","properties":{"date":{"type":"string","format":"date-time"},"assets":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"liabilities":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"netAssets":{"type":"number","format":"double"},"equity":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankAccount":{"type":"object","properties":{"id":{"type":"string","nullable":true},"accountName":{"type":"string","nullable":true},"accountType":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccountType"},"nominalCode":{"type":"string","nullable":true},"sortCode":{"type":"string","nullable":true},"accountNumber":{"type":"string","nullable":true},"iBan":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"balance":{"type":"number","format":"double","nullable":true},"institution":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccountStatus"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"},"availableBalance":{"type":"number","format":"double","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"overdraftLimit":{"type":"number","format":"double","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankAccountPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccount"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankAccountPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankAccount"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankAccountStatus":{"enum":["Unknown","Active","Archived","Pending"],"type":"string"},"Codat.DataContracts.Datasets.BankAccountType":{"enum":["Unknown","Credit","Debit"],"type":"string"},"Codat.DataContracts.Datasets.BankStatementAccount":{"type":"object","properties":{"id":{"type":"string","nullable":true},"accountName":{"type":"string","nullable":true},"fromDate":{"type":"string","format":"date-time"},"toDate":{"type":"string","format":"date-time"},"nominalCode":{"type":"string","nullable":true},"sortCode":{"type":"string","nullable":true},"accountNumber":{"type":"string","nullable":true},"iban":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"balance":{"type":"number","format":"double","nullable":true},"availableBalance":{"type":"number","format":"double","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"overdraftLimit":{"type":"number","format":"double","nullable":true},"institution":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankStatementLine":{"required":["amount","balance","date","reconciled","transactionType"],"type":"object","properties":{"id":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"counterparty":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"reconciled":{"type":"boolean"},"amount":{"type":"number","format":"double"},"balance":{"type":"number","format":"double"},"transactionType":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TransactionType"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankStatementLinePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankStatementLine"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankTransaction":{"type":"object","properties":{"id":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"clearedOnDate":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"counterparty":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"reconciled":{"type":"boolean"},"amount":{"type":"number","format":"double","nullable":true},"balance":{"type":"number","format":"double","nullable":true},"transactionType":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TransactionType"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankTransactionPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankTransaction"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankTransactions":{"type":"object","properties":{"accountId":{"type":"string","nullable":true},"transactions":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankStatementLine"},"nullable":true},"lastBatch":{"type":"boolean","nullable":true},"contractVersion":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BankTransactionsPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BankTransactions"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.Account":{"required":["accountName","accountNumbers","accountType","balance","currency","id","identifiers","institution","name","type"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"informalName":{"type":"string","nullable":true},"holder":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountType"},"balance":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountBalanceAmounts"},"identifiers":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountIdentifiers"},"currency":{"minLength":1,"type":"string"},"institution":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountInstitution"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.AccountBalance":{"required":["accountId","balance","date"],"type":"object","properties":{"accountId":{"minLength":1,"type":"string"},"balance":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountBalanceAmounts"},"date":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.AccountBalanceAmounts":{"required":["current"],"type":"object","properties":{"available":{"type":"number","format":"double","nullable":true},"current":{"type":"number","format":"double"},"limit":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.AccountBalancePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.AccountBalance"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.AccountIdentifiers":{"required":["type"],"type":"object","properties":{"type":{"minLength":1,"type":"string"},"subtype":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"bankCode":{"type":"string","nullable":true},"iban":{"type":"string","nullable":true},"bic":{"type":"string","nullable":true},"maskedAccountNumber":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.AccountInstitution":{"required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.AccountPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.Account"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.AccountType":{"enum":["Unknown","Credit","Debit"],"type":"string"},"Codat.DataContracts.Datasets.Banking.BankingTransactionCode":{"enum":["Unknown","Fee","Payment","Cash","Transfer","Interest","Cashback","Cheque","DirectDebit","Purchase","StandingOrder","Adjustment","Credit","Other","NotSupported"],"type":"string"},"Codat.DataContracts.Datasets.Banking.Transaction":{"required":["accountId","currency","id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"accountId":{"minLength":1,"type":"string"},"description":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"currency":{"minLength":1,"type":"string"},"postedDate":{"type":"string","format":"date-time"},"authorizedDate":{"type":"string","format":"date-time","nullable":true},"code":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.BankingTransactionCode"},"merchantName":{"type":"string","nullable":true},"transactionCategoryRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.TransactionCategoryRef"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.TransactionCategory":{"required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"parentId":{"type":"string","nullable":true},"hasChildren":{"type":"boolean"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.TransactionCategoryStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.TransactionCategoryPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.TransactionCategory"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.TransactionCategoryRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Banking.TransactionCategoryStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.Banking.TransactionPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Banking.Transaction"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Bill":{"required":["issueDate","status","subTotal","taxAmount","totalAmount"],"type":"object","properties":{"id":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"supplierRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierRef"},"purchaseOrderRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrderRef"},"nullable":true},"issueDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time","nullable":true},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillLineItem"},"nullable":true},"withholdingTax":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.WithholdingTax"},"nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillStatus"},"subTotal":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"amountDue":{"type":"number","format":"double","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"note":{"type":"string","nullable":true},"paymentAllocations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DetailedPaymentAllocation"},"nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillCreditNote":{"required":["discountPercentage","remainingCredit","status","subTotal","totalAmount","totalDiscount","totalTaxAmount"],"type":"object","properties":{"id":{"type":"string","nullable":true},"billCreditNoteNumber":{"type":"string","nullable":true},"supplierRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierRef"},"withholdingTax":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.WithholdingTax"},"nullable":true},"totalAmount":{"type":"number","format":"double"},"totalDiscount":{"type":"number","format":"double"},"subTotal":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"discountPercentage":{"type":"number","format":"double"},"remainingCredit":{"type":"number","format":"double"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNoteStatus"},"issueDate":{"type":"string","format":"date-time"},"allocatedOnDate":{"type":"string","format":"date-time","nullable":true},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNoteLineItem"},"nullable":true},"paymentAllocations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DetailedPaymentAllocation"},"nullable":true},"createdFromRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"},"note":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillCreditNoteLineItem":{"required":["quantity","unitAmount"],"type":"object","properties":{"description":{"type":"string","nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"unitOfMeasurement":{"type":"string","nullable":true},"discountAmount":{"type":"number","format":"double","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"taxAmount":{"type":"number","format":"double","nullable":true},"totalAmount":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"discountPercentage":{"type":"number","format":"double","nullable":true},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"createdFromLineRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SharedTypes.RecordLineRef"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsPayableTracking"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillCreditNotePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNote"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillCreditNotePushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillCreditNote"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillItem":{"type":"object","properties":{"description":{"type":"string","nullable":true},"unitPrice":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillLineItem":{"required":["quantity","unitAmount"],"type":"object","properties":{"lineNumber":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"unitOfMeasurement":{"type":"string","nullable":true},"discountAmount":{"type":"number","format":"double","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"taxAmount":{"type":"number","format":"double","nullable":true},"totalAmount":{"type":"number","format":"double","nullable":true},"discountPercentage":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"purchaseOrderLineRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SharedTypes.RecordLineRef"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsPayableTracking"},"isDirectCost":{"type":"boolean"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Bill"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillPayment":{"required":["date"],"type":"object","properties":{"id":{"type":"string","nullable":true},"supplierRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierRef"},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"totalAmount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"date":{"type":"string","format":"date-time"},"note":{"type":"string","nullable":true},"paymentMethodRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentMethodRef"},"lines":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPaymentLine"},"nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"reference":{"type":"string","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillPaymentLine":{"required":["amount"],"type":"object","properties":{"amount":{"type":"number","format":"double"},"links":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPaymentLineLink"},"nullable":true},"allocatedOnDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillPaymentLineLink":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPaymentLinkType"},"id":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillPaymentLinkType":{"enum":["Unknown","Unlinked","Bill","Other","CreditNote","BillPayment","PaymentOnAccount","Refund","ManualJournal","Discount"],"type":"string"},"Codat.DataContracts.Datasets.BillPaymentPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPayment"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillPaymentPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillPayment"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Bill"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.BillStatus":{"enum":["Unknown","Open","PartiallyPaid","Paid","Void","Draft"],"type":"string"},"Codat.DataContracts.Datasets.CashFlowStatement":{"type":"object","properties":{"fromDate":{"type":"string","format":"date-time"},"toDate":{"type":"string","format":"date-time"},"cashReceipts":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"cashPayments":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"}},"additionalProperties":false},"Codat.DataContracts.Datasets.CashFlowStatementReportingBasis":{"enum":["Unknown","Accrual","Cash"],"type":"string"},"Codat.DataContracts.Datasets.CashFlowStatementReportingData":{"enum":["Unknown","Indirect","Direct"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.AccountBalance":{"type":"object","properties":{"available":{"type":"number","format":"double","nullable":true},"pending":{"type":"number","format":"double","nullable":true},"reserved":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.Address":{"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.AddressType"},"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.AddressType":{"enum":["Unknown","Billing","Delivery","Order","Inventory"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.AncestorRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.CompanyInfo":{"type":"object","properties":{"companyName":{"type":"string","nullable":true},"commercePlatformRef":{"type":"string","nullable":true},"companyLegalName":{"type":"string","nullable":true},"addresses":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Address"},"nullable":true},"phoneNumbers":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Phone"},"nullable":true},"webLinks":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.WebLink"},"nullable":true},"registrationNumber":{"type":"string","nullable":true},"baseCurrency":{"type":"string","nullable":true},"accountBalances":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.AccountBalance"},"nullable":true},"sourceUrls":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"createdDate":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.Customer":{"type":"object","properties":{"id":{"type":"string","nullable":true},"customerName":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"defaultCurrency":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"addresses":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Address"},"nullable":true},"note":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.CustomerPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Customer"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.CustomerRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.DiscountAllocation":{"type":"object","properties":{"name":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.Dispute":{"type":"object","properties":{"id":{"type":"string","nullable":true},"disputedTransactions":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.TransactionSourceRef"},"nullable":true},"totalAmount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.DisputeStatus"},"reason":{"type":"string","nullable":true},"dueDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.DisputePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Dispute"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.DisputeStatus":{"enum":["Unknown","Won","Lost","Accepted","Processing","ChargeRefunded","EvidenceRequired","InquiryEvidenceRequired","InquiryProcessing","InquiryClosed","WaitingThirdParty"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.Inventory":{"type":"object","properties":{"totalQuantity":{"type":"number","format":"double","nullable":true},"locations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.InventoryLocation"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.InventoryLocation":{"type":"object","properties":{"quantity":{"type":"number","format":"double"},"locationRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.LocationRef"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ItemType":{"enum":["Unknown","Product","GiftCard","CustomAmount","GenericRefund","Reversal"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.Location":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"address":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Address"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.LocationPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Location"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.LocationRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.Order":{"type":"object","properties":{"id":{"type":"string","nullable":true},"orderNumber":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"closedDate":{"type":"string","format":"date-time","nullable":true},"totalAmount":{"type":"number","format":"double"},"totalRefund":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"totalDiscount":{"type":"number","format":"double"},"totalGratuity":{"type":"number","format":"double"},"orderLineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.OrderLineItem"},"nullable":true},"payments":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentRef"},"nullable":true},"serviceCharges":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ServiceCharge"},"nullable":true},"locationRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.LocationRef"},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.CustomerRef"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.OrderLineItem":{"type":"object","properties":{"id":{"type":"string","nullable":true},"quantity":{"type":"number","format":"double"},"taxPercentage":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"unitPrice":{"type":"number","format":"double"},"taxes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.TaxComponentAllocation"},"nullable":true},"productRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductRef"},"productVariantRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductRef"},"discountAllocations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.DiscountAllocation"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.OrderPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Order"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.Payment":{"type":"object","properties":{"id":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"paymentMethodRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentMethodRef"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentStatus"},"paymentProvider":{"type":"string","nullable":true},"dueDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.PaymentMethod":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentMethodStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.PaymentMethodPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentMethod"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.PaymentMethodRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.PaymentMethodStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.PaymentPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Payment"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.PaymentRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentType"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PaymentStatus"},"paymentProvider":{"type":"string","nullable":true},"dueDate":{"type":"string","format":"date-time","nullable":true},"createdDate":{"type":"string","format":"date-time","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.PaymentStatus":{"enum":["Unknown","Pending","Authorized","Paid","Failed","Cancelled"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.PaymentType":{"enum":["Unknown","Cash","Card","Invoice","OnlineCard","Swish","Vipps","Mobile","StoreCredit","Paypal","Custom","Prepaid"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.Phone":{"type":"object","properties":{"number":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PhoneType"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.PhoneType":{"enum":["Unknown","Primary","Landline","Mobile","Fax"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.PlatformTransactionType":{"enum":["Unknown","Payment","Refund","Payout","FailedPayout","Transfer","PaymentFee","PaymentFeeRefund"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.Product":{"type":"object","properties":{"id":{"type":"string","nullable":true},"categorization":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"productCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductCategoryRef"},"nullable":true},"isGiftCard":{"type":"boolean"},"variants":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductVariant"},"nullable":true},"createdDate":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductStatus"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ProductCategory":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"ancestorRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.AncestorRef"},"nullable":true},"hasChildren":{"type":"boolean"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ProductCategoryPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductCategory"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ProductCategoryRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ProductPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Product"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ProductRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ProductStatus":{"enum":["Unknown","Published","Unpublished"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.ProductVariant":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"quantity":{"type":"number","format":"double","deprecated":true},"isTaxEnabled":{"type":"boolean"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"unitOfMeasure":{"type":"string","nullable":true},"vatPercentage":{"type":"number","format":"double"},"prices":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ProductVariantPrice"},"nullable":true},"inventory":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Inventory"},"shippingRequired":{"type":"boolean"},"createdDate":{"type":"string","format":"date-time"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ProductVariantPrice":{"type":"object","properties":{"currency":{"type":"string","nullable":true},"unitPrice":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ServiceCharge":{"type":"object","properties":{"description":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"taxPercentage":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"taxes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.TaxComponentAllocation"},"nullable":true},"quantity":{"type":"integer","format":"int32"},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.ServiceChargeType"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.ServiceChargeType":{"enum":["Unknown","Generic","Shipping","Overpayment"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.TaxComponentAllocation":{"type":"object","properties":{"taxComponentRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.TaxComponentRef"},"taxAmount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.TaxComponentRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.Transaction":{"type":"object","properties":{"id":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.PlatformTransactionType"},"subType":{"type":"string","nullable":true},"transactionSourceRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.TransactionSourceRef"},"createdDate":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.TransactionPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.Transaction"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.TransactionRefType":{"enum":["Unknown","Fee","Order","Payment","ServiceCharge"],"type":"string"},"Codat.DataContracts.Datasets.Commerce.TransactionSourceRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.TransactionRefType"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.WebLink":{"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Commerce.WebLinkType"},"url":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Commerce.WebLinkType":{"enum":["Unknown","Website","Social"],"type":"string"},"Codat.DataContracts.Datasets.CompanyDataset":{"type":"object","properties":{"companyName":{"type":"string","nullable":true},"accountingPlatformRef":{"type":"string","nullable":true},"companyLegalName":{"type":"string","nullable":true},"addresses":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Address"},"nullable":true},"phoneNumbers":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Phone"},"nullable":true},"webLinks":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.WebLink"},"nullable":true},"ledgerLockDate":{"type":"string","format":"date-time","nullable":true},"registrationNumber":{"type":"string","nullable":true},"taxNumber":{"type":"string","nullable":true},"financialYearStartDate":{"type":"string","format":"date-time","nullable":true},"baseCurrency":{"type":"string","nullable":true},"sourceUrls":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"createdDate":{"type":"string","format":"date-time","nullable":true},"contractVersion":{"type":"string","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Contact":{"required":["status"],"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Phone"},"nullable":true},"address":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Address"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.ContactRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"dataType":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.CreditNote":{"required":["discountPercentage","remainingCredit","status","subTotal","totalAmount","totalDiscount","totalTaxAmount"],"type":"object","properties":{"id":{"type":"string","nullable":true},"creditNoteNumber":{"type":"string","nullable":true},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerRef"},"withholdingTax":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.WithholdingTax"},"nullable":true},"totalAmount":{"type":"number","format":"double"},"totalDiscount":{"type":"number","format":"double"},"subTotal":{"type":"number","format":"double"},"additionalTaxAmount":{"type":"number","format":"double"},"additionalTaxPercentage":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"discountPercentage":{"type":"number","format":"double"},"remainingCredit":{"type":"number","format":"double"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNoteStatus"},"issueDate":{"type":"string","format":"date-time"},"allocatedOnDate":{"type":"string","format":"date-time","nullable":true},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNoteLineItem"},"nullable":true},"paymentAllocations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DetailedPaymentAllocation"},"nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"note":{"type":"string","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.CreditNoteLineItem":{"required":["quantity","unitAmount"],"type":"object","properties":{"description":{"type":"string","nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"discountAmount":{"type":"number","format":"double","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"taxAmount":{"type":"number","format":"double","nullable":true},"totalAmount":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"discountPercentage":{"type":"number","format":"double","nullable":true},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsReceivableTracking"},"isDirectIncome":{"type":"boolean"}},"additionalProperties":false},"Codat.DataContracts.Datasets.CreditNotePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNote"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.CreditNotePushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CreditNote"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.CreditNoteStatus":{"enum":["Unknown","Draft","Submitted","Paid","Void","PartiallyPaid"],"type":"string"},"Codat.DataContracts.Datasets.Customer":{"required":["status"],"type":"object","properties":{"id":{"type":"string","nullable":true},"customerName":{"type":"string","nullable":true},"contactName":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"defaultCurrency":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"addresses":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Address"},"nullable":true},"contacts":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Contact"},"nullable":true},"registrationNumber":{"type":"string","nullable":true},"taxNumber":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.CustomerPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Customer"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.CustomerPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Customer"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.CustomerRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"companyName":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.CustomerStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.DataInterfaces.SupplementalData":{"type":"object","properties":{"content":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.DetailedPaymentAllocation":{"required":["allocation","payment"],"type":"object","properties":{"payment":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentAllocationPayment"},"allocation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Allocation"}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectCost":{"required":["currency","issueDate","lineItems","paymentAllocations","subTotal","taxAmount","totalAmount"],"type":"object","properties":{"id":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"contactRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ContactRef"},"issueDate":{"type":"string","format":"date-time"},"currency":{"minLength":1,"type":"string"},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectCostLineItem"}},"paymentAllocations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DetailedPaymentAllocation"}},"subTotal":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectCostLineItem":{"required":["quantity","unitAmount"],"type":"object","properties":{"description":{"type":"string","nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"discountAmount":{"type":"number","format":"double","nullable":true},"discountPercentage":{"type":"number","format":"double","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"taxAmount":{"type":"number","format":"double","nullable":true},"totalAmount":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoiceableTracking"}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectCostPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectCost"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectCostPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectCost"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectIncome":{"required":["currency","issueDate","lineItems","paymentAllocations","subTotal","taxAmount","totalAmount"],"type":"object","properties":{"id":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"contactRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ContactRef"},"issueDate":{"type":"string","format":"date-time"},"currency":{"minLength":1,"type":"string"},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectIncomeLineItem"}},"paymentAllocations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DetailedPaymentAllocation"}},"subTotal":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectIncomeLineItem":{"required":["quantity","unitAmount"],"type":"object","properties":{"description":{"type":"string","nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"discountAmount":{"type":"number","format":"double","nullable":true},"discountPercentage":{"type":"number","format":"double","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"taxAmount":{"type":"number","format":"double","nullable":true},"totalAmount":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectIncomePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectIncome"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.DirectIncomePushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DirectIncome"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Employee":{"type":"object","properties":{"id":{"type":"string","nullable":true},"employeeName":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"defaultCurrency":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.EmployeeStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"}},"additionalProperties":false},"Codat.DataContracts.Datasets.EmployeePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Employee"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.EmployeeStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.FromAccount":{"type":"object","properties":{"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"currency":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Invoice":{"required":["amountDue","issueDate","status","totalAmount","totalTaxAmount"],"type":"object","properties":{"id":{"type":"string","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerRef"},"salesOrderRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"nullable":true},"issueDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"paidOnDate":{"type":"string","format":"date-time","nullable":true},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoiceLineItem"},"nullable":true},"paymentAllocations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DetailedPaymentAllocation"},"nullable":true},"withholdingTax":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.WithholdingTax"},"nullable":true},"totalDiscount":{"type":"number","format":"double","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"additionalTaxAmount":{"type":"number","format":"double"},"additionalTaxPercentage":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"amountDue":{"type":"number","format":"double"},"discountPercentage":{"type":"number","format":"double","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoiceStatus"},"note":{"type":"string","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.InvoiceItem":{"type":"object","properties":{"description":{"type":"string","nullable":true},"unitPrice":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"}},"additionalProperties":false},"Codat.DataContracts.Datasets.InvoiceLineItem":{"required":["quantity","unitAmount"],"type":"object","properties":{"description":{"type":"string","nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"discountAmount":{"type":"number","format":"double","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"taxAmount":{"type":"number","format":"double","nullable":true},"totalAmount":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"discountPercentage":{"type":"number","format":"double","nullable":true},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountsReceivableTracking"},"isDirectIncome":{"type":"boolean"}},"additionalProperties":false},"Codat.DataContracts.Datasets.InvoicePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Invoice"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.InvoicePushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Invoice"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.InvoiceStatus":{"enum":["Unknown","Draft","Submitted","PartiallyPaid","Paid","Void"],"type":"string"},"Codat.DataContracts.Datasets.InvoiceableTracking":{"required":["recordRefs"],"type":"object","properties":{"recordRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"}},"invoiceTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"}},"additionalProperties":false},"Codat.DataContracts.Datasets.InvoicingStatus":{"enum":["Unknown","PartiallyInvoiced","Invoiced","NotInvoiced"],"type":"string"},"Codat.DataContracts.Datasets.Item":{"required":["isBillItem","isInvoiceItem","itemStatus","type"],"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"itemStatus":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemStatus"},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemType"},"isBillItem":{"type":"boolean"},"billItem":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BillItem"},"isInvoiceItem":{"type":"boolean"},"invoiceItem":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoiceItem"},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.ItemPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Item"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.ItemPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Item"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.ItemReceipt":{"type":"object","properties":{"id":{"type":"string","nullable":true},"supplierRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierRef"},"purchaseOrderRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrderRef"},"nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemReceiptStatus"},"note":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"receivedDate":{"type":"string","format":"date-time","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemReceiptLine"},"nullable":true},"subTotal":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.ItemReceiptLine":{"type":"object","properties":{"lineNumber":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"unitOfMeasurement":{"type":"string","nullable":true},"subTotal":{"type":"number","format":"double","nullable":true},"totalAmount":{"type":"number","format":"double","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"purchaseOrderLineRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SharedTypes.RecordLineRef"},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Tracking"}},"additionalProperties":false},"Codat.DataContracts.Datasets.ItemReceiptPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemReceipt"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.ItemReceiptStatus":{"enum":["Unknown","Draft","Received","Rejected","Void"],"type":"string"},"Codat.DataContracts.Datasets.ItemRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.ItemStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.ItemType":{"enum":["Unknown","Inventory","NonInventory","Service"],"type":"string"},"Codat.DataContracts.Datasets.Journal":{"type":"object","properties":{"id":{"type":"string","nullable":true},"journalCode":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true},"hasChildren":{"type":"boolean"},"createdOn":{"type":"string","format":"date-time","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalEntry":{"type":"object","properties":{"id":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"postedOn":{"type":"string","format":"date-time","nullable":true},"createdOn":{"type":"string","format":"date-time","nullable":true},"updatedOn":{"type":"string","format":"date-time","nullable":true},"journalRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalRef"},"journalLines":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalLine"},"nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"recordRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalEntryPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalEntry"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalEntryPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.JournalEntry"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalLine":{"required":["netAmount"],"type":"object","properties":{"description":{"type":"string","nullable":true},"netAmount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"transactionAmount":{"type":"number","format":"double","nullable":true},"transactionCurrency":{"type":"string","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Tracking"},"contactRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ContactRef"}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Journal"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Journal"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.JournalStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.Metadata":{"type":"object","properties":{"isDeleted":{"type":"boolean","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Payment":{"required":["date"],"type":"object","properties":{"id":{"type":"string","nullable":true},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerRef"},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"paymentMethodRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentMethodRef"},"totalAmount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"date":{"type":"string","format":"date-time"},"note":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentLine"},"nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"reference":{"type":"string","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentAllocationPayment":{"type":"object","properties":{"id":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"paidOnDate":{"type":"string","format":"date-time"},"totalAmount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentLine":{"required":["amount"],"type":"object","properties":{"amount":{"type":"number","format":"double"},"links":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentLineLink"},"nullable":true},"allocatedOnDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentLineLink":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentLinkType"},"id":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentLinkType":{"enum":["Unknown","Unlinked","Invoice","CreditNote","Other","Refund","Payment","PaymentOnAccount","ManualJournal","Discount"],"type":"string"},"Codat.DataContracts.Datasets.PaymentMethod":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentMethodType"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentMethodStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentMethodPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PaymentMethod"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentMethodRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentMethodStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.PaymentMethodType":{"enum":["Unknown","Cash","Check","CreditCard","DebitCard","BankTransfer","Other"],"type":"string"},"Codat.DataContracts.Datasets.PaymentPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Payment"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PaymentPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Payment"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Phone":{"required":["type"],"type":"object","properties":{"number":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PhoneType"}},"additionalProperties":false},"Codat.DataContracts.Datasets.PhoneType":{"enum":["Unknown","Primary","Landline","Mobile","Fax"],"type":"string"},"Codat.DataContracts.Datasets.ProfitAndLossReport":{"required":["grossProfit","netOperatingProfit","netOtherIncome","netProfit"],"type":"object","properties":{"fromDate":{"type":"string","format":"date-time"},"toDate":{"type":"string","format":"date-time"},"income":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"costOfSales":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"grossProfit":{"type":"number","format":"double"},"expenses":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"netOperatingProfit":{"type":"number","format":"double"},"otherExpenses":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"otherIncome":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"netOtherIncome":{"type":"number","format":"double"},"netProfit":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.ProfitAndLossReportingType":{"enum":["Unknown","Accrual","Cash"],"type":"string"},"Codat.DataContracts.Datasets.ProjectRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PurchaseOrder":{"type":"object","properties":{"id":{"type":"string","nullable":true},"purchaseOrderNumber":{"type":"string","nullable":true},"issueDate":{"type":"string","format":"date-time"},"paymentDueDate":{"type":"string","format":"date-time","nullable":true},"expectedDeliveryDate":{"type":"string","format":"date-time","nullable":true},"deliveryDate":{"type":"string","format":"date-time","nullable":true},"note":{"type":"string","nullable":true},"shipTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ShipTo"},"supplierRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierRef"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrderStatus"},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrderLineItem"},"nullable":true},"totalDiscount":{"type":"number","format":"double"},"subTotal":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"createdBy":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SharedTypes.User"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"}},"additionalProperties":false},"Codat.DataContracts.Datasets.PurchaseOrderLineItem":{"type":"object","properties":{"lineNumber":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"unitOfMeasurement":{"type":"string","nullable":true},"discountAmount":{"type":"number","format":"double"},"discountPercentage":{"type":"number","format":"double"},"subTotal":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"totalAmount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.PurchaseOrderPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrder"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PurchaseOrderPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.PurchaseOrder"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PurchaseOrderRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"purchaseOrderNumber":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.PurchaseOrderStatus":{"enum":["Unknown","Draft","Open","Closed","Void"],"type":"string"},"Codat.DataContracts.Datasets.RecordRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"dataType":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.ReportLine":{"required":["value"],"type":"object","properties":{"accountId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"value":{"type":"number","format":"double"},"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ReportLine"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.SalesOrder":{"type":"object","properties":{"id":{"type":"string","nullable":true},"salesOrderNumber":{"type":"string","nullable":true},"customerPurchaseOrderNumber":{"type":"string","nullable":true},"issueDate":{"type":"string","format":"date-time"},"expectedDeliveryDate":{"type":"string","format":"date-time","nullable":true},"note":{"type":"string","nullable":true},"shipTo":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ShipTo"},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CustomerRef"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SalesOrderStatus"},"invoicingStatus":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.InvoicingStatus"},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SalesOrderLineItem"},"nullable":true},"totalDiscount":{"type":"number","format":"double"},"subTotal":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"totalAmount":{"type":"number","format":"double"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"}},"additionalProperties":false},"Codat.DataContracts.Datasets.SalesOrderLineItem":{"type":"object","properties":{"description":{"type":"string","nullable":true},"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.AccountRef"},"itemRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ItemRef"},"tracking":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Tracking"},"unitAmount":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"discountAmount":{"type":"number","format":"double"},"discountPercentage":{"type":"number","format":"double"},"subTotal":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"totalAmount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.SalesOrderPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SalesOrder"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.SalesOrderStatus":{"enum":["Unknown","Draft","Open","Closed","Void"],"type":"string"},"Codat.DataContracts.Datasets.SharedTypes.RecordLineRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"dataType":{"type":"string","nullable":true},"lineNumber":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.SharedTypes.User":{"type":"object","properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.ShipTo":{"type":"object","properties":{"contact":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ShipToContact"},"address":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Address"}},"additionalProperties":false},"Codat.DataContracts.Datasets.ShipToContact":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.Supplier":{"required":["status"],"type":"object","properties":{"id":{"type":"string","nullable":true},"supplierName":{"type":"string","nullable":true},"contactName":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"addresses":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Address"},"nullable":true},"registrationNumber":{"type":"string","nullable":true},"taxNumber":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.SupplierStatus"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"defaultCurrency":{"type":"string","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.SupplierPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Supplier"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.SupplierPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Supplier"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.SupplierRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"supplierName":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.SupplierStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.TaxInfo":{"required":["taxAmount","taxRateRef"],"type":"object","properties":{"taxRateRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateRef"},"taxAmount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.TaxRate":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateStatus"},"effectiveTaxRate":{"type":"number","format":"double","nullable":true},"totalTaxRate":{"type":"number","format":"double","nullable":true},"components":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRateComponent"},"nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"validDatatypeLinks":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ValidDatatypeLinks"},"nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.TaxRateComponent":{"required":["isCompound"],"type":"object","properties":{"name":{"type":"string","nullable":true},"rate":{"type":"number","format":"double","nullable":true},"isCompound":{"type":"boolean"}},"additionalProperties":false},"Codat.DataContracts.Datasets.TaxRatePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TaxRate"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.TaxRateRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true},"effectiveTaxRate":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.TaxRateStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.ToAccount":{"type":"object","properties":{"accountRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"currency":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Datasets.Tracking":{"type":"object","properties":{"recordRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.TrackingCategoryRef":{"required":["id"],"type":"object","properties":{"id":{"minLength":1,"type":"string"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.TrackingCategoryStatus":{"enum":["Unknown","Active","Archived"],"type":"string"},"Codat.DataContracts.Datasets.TransactionType":{"enum":["Unknown","Credit","Debit","Int","Div","Fee","SerChg","Dep","Atm","Pos","Xfer","Check","Payment","Cash","DirectDep","DirectDebit","RepeatPmt","Other"],"type":"string"},"Codat.DataContracts.Datasets.Transfer":{"type":"object","properties":{"id":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"contactRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ContactRef"},"date":{"type":"string","format":"date-time"},"from":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.FromAccount"},"to":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ToAccount"},"trackingCategoryRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryRef"},"nullable":true},"depositedRecordRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.RecordRef"},"nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.DataContracts.Datasets.TransferPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Transfer"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.TransferPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Transfer"},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.TransferStatus":{"enum":["Unknown","Unreconciled","Reconciled","Void"],"type":"string"},"Codat.DataContracts.Datasets.ValidDatatypeLinks":{"type":"object","properties":{"property":{"type":"string","nullable":true},"links":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.WebLink":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.WebLinkType"},"url":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Datasets.WebLinkType":{"enum":["Unknown","Website","Social"],"type":"string"},"Codat.DataContracts.Datasets.WithholdingTax":{"required":["amount","name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"amount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataContracts.Push.OptionType":{"enum":["Array","Object","String","Number","Boolean","DateTime","File","MultiPart"],"type":"string"},"Codat.DataContracts.Push.PushChangeType":{"enum":["Unknown","Created","Modified","Deleted","AttachmentUploaded","AttachmentDeleted"],"type":"string"},"Codat.DataContracts.Push.PushFieldValidation":{"required":["details","field"],"type":"object","properties":{"field":{"minLength":1,"type":"string"},"details":{"minLength":1,"type":"string"},"ref":{"type":"string","format":"uri","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Push.PushOperationChange":{"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushChangeType"},"recordRef":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationRecordRef"},"attachmentId":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Push.PushOperationRecordRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"dataType":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Push.PushOption":{"required":["description","displayName","required","type"],"type":"object","properties":{"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.OptionType"},"displayName":{"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"properties":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"},"nullable":true},"options":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOptionChoice"},"nullable":true},"required":{"type":"boolean"},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushValidationInfo"},"rel":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Push.PushOptionChoice":{"required":["description","displayName","required","type","value"],"type":"object","properties":{"value":{"minLength":1,"type":"string"},"type":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.OptionType"},"displayName":{"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"properties":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"},"nullable":true},"options":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOptionChoice"},"nullable":true},"required":{"type":"boolean"},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushValidationInfo"},"rel":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Push.PushValidationInfo":{"type":"object","properties":{"warnings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushFieldValidation"},"nullable":true},"information":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushFieldValidation"},"nullable":true}},"additionalProperties":false},"Codat.DataContracts.Responses.HalLink":{"type":"object","properties":{"href":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Validation.ValidationItem":{"type":"object","properties":{"itemId":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"validatorName":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataContracts.Validation.ValidationResult":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationItem"},"nullable":true},"warnings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationItem"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Details.TransactionDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"connectionId":{"type":"string"},"id":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true},"matches":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Details.TransactionDetails"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Details.TransactionDetailsPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Details.TransactionDetails"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Metadata.MatchAmountInfo":{"type":"object","properties":{"min":{"type":"number","format":"double","nullable":true},"max":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Metadata.MatchConnectionIds":{"type":"object","properties":{"source":{"type":"array","items":{"type":"string"},"nullable":true},"target":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Metadata.MatchDateInfo":{"type":"object","properties":{"minDate":{"type":"string","format":"date-time","nullable":true},"maxDate":{"type":"string","format":"date-time","nullable":true},"minOverlappingDate":{"type":"string","format":"date-time","nullable":true},"maxOverlappingDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Metadata.MatchMetadata":{"type":"object","properties":{"type":{"type":"string","nullable":true},"statusInfo":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Metadata.MatchStatusInfo"},"connectionIds":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Metadata.MatchConnectionIds"},"amounts":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Metadata.MatchAmountInfo"},"dates":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Metadata.MatchDateInfo"}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Metadata.MatchMetadataResponse":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Metadata.MatchMetadata"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Metadata.MatchStatusInfo":{"type":"object","properties":{"lastMatched":{"type":"string","format":"date-time","nullable":true},"currentStatus":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Metadata.RunStatus"},"statusMessage":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Metadata.RunStatus":{"enum":["Unknown","DoesNotExist","Error","Processing","CompleteWithWarning","Complete"],"type":"string"},"Codat.DataIntegrity.Contracts.Reports.BankingTransactionRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"dataConnectionId":{"type":"string","format":"uuid"},"accountId":{"type":"string","nullable":true},"accountName":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Reports.CustomerRef":{"type":"object","properties":{"id":{"type":"string","nullable":true},"customerName":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Reports.Invoice":{"type":"object","properties":{"id":{"type":"string","nullable":true},"invoiceNumber":{"type":"string","nullable":true},"customerRef":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Reports.CustomerRef"},"issueDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"totalAmount":{"type":"number","format":"double"},"amountDue":{"type":"number","format":"double"},"paidOnDate":{"type":"string","format":"date-time","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"payments":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Reports.Payment"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Reports.InvoicesReport":{"type":"object","properties":{"reportInfo":{"$ref":"#\/components\/schemas\/Codat.Assess.DataContracts.Common.PagedReportInfo"},"reportItems":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Reports.Invoice"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Reports.Payment":{"type":"object","properties":{"id":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"paymentType":{"type":"string","nullable":true},"amount":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true},"currencyRate":{"type":"number","format":"double","nullable":true},"bankingTransactionRefs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Reports.BankingTransactionRef"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Summary.MatchAmountSummary":{"type":"object","properties":{"matchPercentage":{"type":"number","format":"double"},"unmatched":{"type":"number","format":"double"},"matched":{"type":"number","format":"double"},"total":{"type":"number","format":"double"},"currency":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Summary.MatchCountSummary":{"type":"object","properties":{"matchPercentage":{"type":"number","format":"double"},"unmatched":{"type":"integer","format":"int32"},"matched":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Summary.MatchSummariesResponse":{"type":"object","properties":{"summaries":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Summary.MatchSummary"},"nullable":true}},"additionalProperties":false},"Codat.DataIntegrity.Contracts.Summary.MatchSummary":{"type":"object","properties":{"type":{"type":"string","nullable":true},"byAmount":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Summary.MatchAmountSummary"},"byCount":{"$ref":"#\/components\/schemas\/Codat.DataIntegrity.Contracts.Summary.MatchCountSummary"}},"additionalProperties":false},"Codat.Public.Api.Controllers.Data.Accounting.BankStatementLineToPush":{"required":["amount","balance","date","reconciled","transactionType"],"type":"object","properties":{"id":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true},"counterparty":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"reconciled":{"type":"boolean"},"amount":{"type":"number","format":"double"},"balance":{"type":"number","format":"double"},"transactionType":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TransactionType"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false,"description":"DTO for deserializing bank statement lines with DateTimeOffset.\r\nThe Date property is received as DateTimeOffset to preserve the local time portion,\r\nwhich is then converted to DateTime (stripping the offset) during mapping to BankStatementLine.\r\nThis avoids timezone conversion issues without modifying global serializer settings."},"Codat.Public.Api.Controllers.Data.Accounting.BankTransactionsToPush":{"type":"object","properties":{"accountId":{"type":"string","nullable":true},"transactions":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Controllers.Data.Accounting.BankStatementLineToPush"},"nullable":true},"lastBatch":{"type":"boolean","nullable":true},"contractVersion":{"type":"string","nullable":true}},"additionalProperties":false,"description":"DTO for deserializing bank transactions from the request body.\r\nUses Codat.Public.Api.Controllers.Data.Accounting.BankStatementLineToPush to receive the Date as DateTimeOffset,\r\nallowing the offset\/timezone to be stripped without modifying global serializer settings."},"Codat.Public.Api.Models.Assess.AssessExcelMeta":{"type":"object","properties":{"lastGenerated":{"type":"string","format":"date-time","nullable":true},"inProgress":{"type":"boolean"},"queued":{"type":"string","format":"date-time"},"success":{"type":"boolean"},"errorMessage":{"type":"string","nullable":true},"lastInvocationId":{"type":"string","format":"uuid"},"reportType":{"type":"string","nullable":true},"fileSize":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.BankingSettingsModels_BankIntegration":{"type":"object","properties":{"name":{"type":"string","nullable":true},"integrationGuid":{"type":"string","format":"uuid","nullable":true},"selected":{"type":"boolean"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.BankingSettingsModels_BankSetting":{"type":"object","properties":{"name":{"type":"string","nullable":true},"sourceGuid":{"type":"string","format":"uuid"},"bankIntegrations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.BankingSettingsModels_BankIntegration"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.BankingSettingsModels_BankSettingsDataset":{"type":"object","properties":{"bankSettings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.BankingSettingsModels_BankSetting"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.ClientSettingsModel":{"type":"object","properties":{"oneTimeSync":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.ClientSettingsPatchModel":{"type":"object","properties":{"oneTimeSync":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.ClientSyncSettingsModel":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid"},"settings":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.SyncSettings.SyncSettingModel"},"nullable":true},"overridesDefaults":{"type":"boolean"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.ClientSyncSettingsSinglePutModel":{"type":"object","properties":{"fetchOnFirstLink":{"type":"boolean"},"syncSchedule":{"type":"integer","format":"int32"},"syncFromUtc":{"type":"string","format":"date-time","nullable":true},"syncFromWindow":{"type":"integer","format":"int32","nullable":true},"monthsToSync":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel":{"type":"object","properties":{"logo":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_LogoModel"},"button":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_ButtonModel"},"sourceId":{"type":"string","format":"uuid"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel_ButtonModel":{"type":"object","properties":{"default":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_DefaultModel"},"hover":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_HoverModel"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel_DefaultModel":{"type":"object","properties":{"image":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_ImageModel"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel_FullModel":{"type":"object","properties":{"image":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_ImageModel"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel_HoverModel":{"type":"object","properties":{"image":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_ImageModel"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel_ImageModel":{"type":"object","properties":{"src":{"type":"string","nullable":true},"alt":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel_LogoModel":{"type":"object","properties":{"full":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_FullModel"},"square":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_SquareModel"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationBrandingModel_SquareModel":{"type":"object","properties":{"image":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Clients.IntegrationBrandingModel_ImageModel"}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationSettingsModel":{"type":"object","properties":{"integrationId":{"type":"string","format":"uuid"},"oneTimeSync":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Clients.IntegrationSettingsPatchModel":{"type":"object","properties":{"oneTimeSync":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.AddCompanyModel":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"description":{"type":"string","nullable":true},"platformType":{"type":"string","nullable":true},"products":{"type":"array","items":{"type":"string"},"nullable":true},"tags":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.Company":{"required":["dataConnections","id","name","platform","redirect"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"minLength":1,"type":"string"},"description":{"type":"string","nullable":true},"platform":{"minLength":1,"type":"string"},"redirect":{"minLength":1,"type":"string"},"lastSync":{"type":"string","format":"date-time","nullable":true},"dataConnections":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnection"}},"created":{"type":"string","format":"date-time","nullable":true},"createdByUserName":{"type":"string","nullable":true},"products":{"type":"array","items":{"type":"string"},"nullable":true},"tags":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"referenceParentCompany":{"$ref":"#\/components\/schemas\/Codat.Webhooks.Publisher.Client.Models.CompanyReference"},"referenceSubsidiaryCompanies":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Webhooks.Publisher.Client.Models.CompanyReference"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.CompanyEventStream":{"required":["companyId","data"],"type":"object","properties":{"companyId":{"type":"string","format":"uuid"},"from":{"type":"string","format":"date-time","nullable":true},"to":{"type":"string","format":"date-time","nullable":true},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.CompanyEventStreamItem"}}},"additionalProperties":false},"Codat.Public.Api.Models.Company.CompanyEventStreamItem":{"required":["description","eventTimeUtc","type"],"type":"object","properties":{"type":{"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"eventTimeUtc":{"type":"string","format":"date-time"}},"additionalProperties":false},"Codat.Public.Api.Models.Company.CompanyPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.Company"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.CompanySettings":{"required":["companyId","offlineConnectorInstall"],"type":"object","properties":{"companyId":{"type":"string","format":"uuid"},"offlineConnectorInstall":{"type":"boolean"}},"additionalProperties":false},"Codat.Public.Api.Models.Company.DataConnection":{"required":["id","integrationId","linkUrl","platformName","sourceId"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"integrationId":{"type":"string","format":"uuid"},"integrationKey":{"type":"string","nullable":true},"sourceId":{"type":"string","format":"uuid"},"platformName":{"minLength":1,"type":"string"},"linkUrl":{"minLength":1,"type":"string"},"status":{"type":"string","nullable":true},"lastSync":{"type":"string","format":"date-time","nullable":true},"created":{"type":"string","format":"date-time","nullable":true},"sourceType":{"type":"string","nullable":true},"dataConnectionErrors":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnectionError"},"nullable":true},"connectionInfo":{"type":"object","additionalProperties":{},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.DataConnectionError":{"type":"object","properties":{"statusCode":{"type":"string","nullable":true},"statusText":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"erroredOnUtc":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"status":{"type":"string","nullable":true},"resolvedOnUtc":{"type":"string","format":"date-time","nullable":true},"errorLastSeenAtUtc":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.DataConnectionPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Company.DataConnection"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.PatchDataConnectionModel":{"type":"object","properties":{"status":{"type":"string","nullable":true},"connectionInfo":{"type":"object","additionalProperties":{},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.ProfileModel":{"type":"object","properties":{"name":{"type":"string","nullable":true},"logoUrl":{"type":"string","nullable":true},"iconUrl":{"type":"string","nullable":true},"redirectUrl":{"type":"string","nullable":true},"whiteListUrls":{"type":"array","items":{"type":"string"},"nullable":true},"alertAuthHeader":{"type":"string","nullable":true},"confirmCompanyName":{"type":"boolean"}},"additionalProperties":false},"Codat.Public.Api.Models.Company.UpdateCompanyModel":{"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"tags":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Company.UpdatePartialCompanyModel":{"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"tags":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.AccountResponse":{"type":"object","properties":{"id":{"type":"string","nullable":true},"nominalCode":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"fullyQualifiedCategory":{"type":"string","nullable":true},"fullyQualifiedName":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"currentBalance":{"type":"number","format":"double","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.AccountTypeResponse"},"status":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.AccountStatusResponse"},"isBankAccount":{"type":"boolean"},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","format":"date-time","nullable":true},"validDatatypeLinks":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.ValidDatatypeLinksResponse"},"nullable":true},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.Public.Api.Models.Data.AccountStatusResponse":{"enum":["Unknown","Active","Archived","Pending"],"type":"string"},"Codat.Public.Api.Models.Data.AccountTypeResponse":{"enum":["Unknown","Asset","Expense","Income","Liability","Equity"],"type":"string"},"Codat.Public.Api.Models.Data.BalanceSheetResponse":{"required":["currency","reports"],"type":"object","properties":{"currency":{"minLength":1,"type":"string"},"reports":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.BalanceSheet"}},"mostRecentAvailableMonth":{"type":"string","format":"date-time","nullable":true},"earliestAvailableMonth":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.CashFlowStatementResponse":{"required":["currency","reportBasis","reportInput","reports"],"type":"object","properties":{"reports":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CashFlowStatement"}},"reportBasis":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CashFlowStatementReportingBasis"},"reportInput":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.CashFlowStatementReportingData"},"currency":{"minLength":1,"type":"string"},"mostRecentAvailableMonth":{"type":"string","format":"date-time","nullable":true},"earliestAvailableMonth":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.DataSet":{"required":["companyId","connectionId","id","isCompleted","isErrored","isPaused","progress","requested","status"],"type":"object","properties":{"datasetLogsUrl":{"type":"string","nullable":true},"id":{"type":"string","format":"uuid"},"companyId":{"type":"string","format":"uuid"},"connectionId":{"type":"string","format":"uuid"},"dataType":{"type":"string","nullable":true},"status":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DatasetStatus"},"statusDescription":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"errorMessageDisplay":{"type":"string","nullable":true},"errorMessageLinks":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DatasetErrorMessageLinks"},"requested":{"type":"string","format":"date-time"},"completed":{"type":"string","format":"date-time","nullable":true},"progress":{"type":"integer","format":"int32"},"isCompleted":{"type":"boolean"},"isErrored":{"type":"boolean"},"isPaused":{"type":"boolean"},"validationinformationUrl":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.DataSetPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.DataSet"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.DataStatus":{"required":["dataType"],"type":"object","properties":{"dataType":{"minLength":1,"type":"string"},"lastSuccessfulSync":{"type":"string","format":"date-time","nullable":true},"currentStatus":{"type":"string","nullable":true},"latestSyncId":{"type":"string","format":"uuid","nullable":true},"latestSuccessfulSyncId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.DatasetErrorMessageLinks":{"type":"object","properties":{"reconnect":{"type":"string","nullable":true},"helpHub":{"type":"string","nullable":true},"docs":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.DatasetStatus":{"enum":["Initial","Queued","Fetching","MapQueued","Mapping","Complete","FetchError","MapError","InternalError","ProcessingQueued","Processing","ProcessingError","ValidationQueued","Validating","ValidationError","AuthError","Cancelled","NotSupported","RateLimitError","PermissionsError","PrerequisiteNotMet"],"type":"string"},"Codat.Public.Api.Models.Data.ProfitAndLossResponse":{"required":["currency","reportBasis","reports"],"type":"object","properties":{"reports":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ProfitAndLossReport"}},"reportBasis":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.ProfitAndLossReportingType"},"currency":{"minLength":1,"type":"string"},"mostRecentAvailableMonth":{"type":"string","format":"date-time","nullable":true},"earliestAvailableMonth":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.PushOptionsAggregate":{"type":"object","properties":{"put":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"},"post":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOption"}},"additionalProperties":false},"Codat.Public.Api.Models.Data.TrackingCategory":{"type":"object","properties":{"id":{"type":"string","description":"The identifier for the item, unique per tracking category","nullable":true},"parentId":{"type":"string","description":"The identifier for this item's immediate parent","nullable":true},"modifiedDate":{"type":"string","description":"The date the record was last updated in the system cache","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","description":"The date the record was last changed in the originating system","format":"date-time","nullable":true},"name":{"type":"string","description":"The name of the tracking category","nullable":true},"hasChildren":{"type":"boolean","description":"Boolean value indicating whether this category has SubCategories"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryStatus"},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false,"description":"Details of a category used for tracking transactions"},"Codat.Public.Api.Models.Data.TrackingCategoryPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.TrackingCategory"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Data.TrackingCategoryTree":{"type":"object","properties":{"subCategories":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Data.TrackingCategoryTree"},"nullable":true},"id":{"type":"string","description":"The identifier for the item, unique per tracking category","nullable":true},"parentId":{"type":"string","description":"The identifier for this item's immediate parent","nullable":true},"modifiedDate":{"type":"string","description":"The date the record was last updated in the system cache","format":"date-time","nullable":true},"sourceModifiedDate":{"type":"string","description":"The date the record was last changed in the originating system","format":"date-time","nullable":true},"name":{"type":"string","description":"The name of the tracking category","nullable":true},"hasChildren":{"type":"boolean","description":"Boolean value indicating whether this category has SubCategories"},"status":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.TrackingCategoryStatus"},"metadata":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.Metadata"},"supplementalData":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Datasets.DataInterfaces.SupplementalData"}},"additionalProperties":false},"Codat.Public.Api.Models.Data.ValidDatatypeLinksResponse":{"type":"object","properties":{"property":{"type":"string","nullable":true},"links":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.DataConnectionArgs":{"type":"object","properties":{"platformKey":{"type":"string","nullable":true},"connectionInfo":{"type":"object","additionalProperties":{},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.FileMetadataModel":{"type":"object","properties":{"fileName":{"type":"string","nullable":true},"displayName":{"type":"string","nullable":true},"sourceType":{"type":"string","nullable":true},"uploaded":{"type":"string","format":"date-time"},"platformKey":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"sessionId":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.PlatformCredentials.DataProvidedBy":{"enum":["Unknown","Codat","Client"],"type":"string"},"Codat.Public.Api.Models.PlatformCredentials.DatatypeFeatures":{"type":"object","properties":{"datatype":{"type":"string","nullable":true},"supportedFeatures":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.SupportedFeatureState"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.PlatformCredentials.EnabledArgs":{"type":"object","properties":{"enabled":{"type":"boolean"}},"additionalProperties":false},"Codat.Public.Api.Models.PlatformCredentials.IntegrationSupportedEnvironments":{"enum":["Unknown","SandboxOnly","LiveOnly","LiveAndSandbox"],"type":"string"},"Codat.Public.Api.Models.PlatformCredentials.PlatformSourceModel":{"type":"object","properties":{"key":{"type":"string","nullable":true},"logoUrl":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"enabled":{"type":"boolean"},"sourceId":{"type":"string","format":"uuid"},"integrationId":{"type":"string","format":"uuid"},"sourceType":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.SourceType"},"isOfflineConnector":{"type":"boolean"},"isBeta":{"type":"boolean"},"supportedEnvironments":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.IntegrationSupportedEnvironments"},"linkedConnectionsCount":{"type":"integer","format":"int32"},"totalConnectionsCount":{"type":"integer","format":"int32"},"dataProvidedBy":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.DataProvidedBy"},"datatypeFeatures":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.DatatypeFeatures"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.PlatformCredentials.PlatformSourceModelPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.PlatformCredentials.PlatformSourceModel"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.PlatformCredentials.SourceType":{"enum":["Unknown","Accounting","Banking","BankFeed","Commerce","Expense","Other"],"type":"string"},"Codat.Public.Api.Models.PlatformCredentials.SupportedFeatureState":{"type":"object","properties":{"featureType":{"type":"string","nullable":true},"featureState":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Rules.AddRuleModel":{"required":["companyId","type"],"type":"object","properties":{"companyId":{"type":"string","description":"Leave the companyID blank to create a rule that applies to all companies","format":"uuid"},"type":{"minLength":1,"type":"string"},"notifiers":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.Notifiers"}},"additionalProperties":false},"Codat.Public.Api.Models.Rules.AlertModel":{"type":"object","properties":{"companyId":{"type":"string","format":"uuid"},"companyName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"uuid"},"clientName":{"type":"string","nullable":true},"ruleId":{"type":"string","format":"uuid"},"ruleType":{"type":"string","nullable":true},"id":{"type":"string","format":"uuid"},"alertId":{"type":"string","format":"uuid"},"dataConnectionId":{"type":"string","format":"uuid","nullable":true},"message":{"type":"string","nullable":true},"data":{"nullable":true},"raisedOnUtc":{"type":"string","format":"date-time"}},"additionalProperties":false},"Codat.Public.Api.Models.Rules.AlertModelPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.AlertModel"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Rules.Notifiers":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"},"nullable":true},"webhook":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.Rules.Rule":{"required":["id","type"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"minLength":1,"type":"string"},"companyId":{"type":"string","format":"uuid","nullable":true},"notifiers":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.Notifiers"}},"additionalProperties":false},"Codat.Public.Api.Models.Rules.RulePagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.Public.Api.Models.Rules.Rule"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false},"Codat.Public.Api.Models.SyncSettings.SyncSettingModel":{"type":"object","properties":{"dataType":{"type":"string","nullable":true},"fetchOnFirstLink":{"type":"boolean"},"syncSchedule":{"type":"integer","format":"int32"},"syncOrder":{"type":"integer","format":"int32"},"syncFromUtc":{"type":"string","format":"date-time","nullable":true},"syncFromWindow":{"type":"integer","format":"int32","nullable":true},"monthsToSync":{"type":"integer","format":"int32","nullable":true},"isLocked":{"type":"boolean","nullable":true}},"additionalProperties":false},"Codat.StandardReporting.Contracts.IDimension":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"displayName":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.IDimensionItem"},"nullable":true}},"additionalProperties":false},"Codat.StandardReporting.Contracts.IDimensionItem":{"type":"object","properties":{"index":{"type":"integer","format":"int32"}},"additionalProperties":false},"Codat.StandardReporting.Contracts.IReportDataMeasure":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"measureDisplayName":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.StandardReporting.Contracts.Measure":{"type":"object","properties":{"displayName":{"type":"string","nullable":true},"units":{"type":"string","nullable":true},"index":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.StandardReporting.Contracts.Report":{"type":"object","properties":{"reportInfo":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"dimensions":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.IDimension"},"nullable":true},"measures":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.Measure"},"nullable":true},"reportData":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.ReportData"},"nullable":true},"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.ReportError"},"nullable":true}},"additionalProperties":false},"Codat.StandardReporting.Contracts.ReportData":{"type":"object","properties":{"dimension":{"type":"integer","format":"int32"},"dimensionDisplayName":{"type":"string","nullable":true},"item":{"type":"integer","format":"int32"},"itemDisplayName":{"type":"string","nullable":true},"measures":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.IReportDataMeasure"},"nullable":true},"components":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.ReportData"},"nullable":true}},"additionalProperties":false},"Codat.StandardReporting.Contracts.ReportError":{"type":"object","properties":{"message":{"type":"string","nullable":true},"type":{"$ref":"#\/components\/schemas\/Codat.StandardReporting.Contracts.ReportErrorType"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"},"nullable":true},"nullable":true}},"additionalProperties":false},"Codat.StandardReporting.Contracts.ReportErrorType":{"enum":["DatesOutOfRange","DataNotSynced","DataSetNotSupported","DataSyncFailed","DataTypeNotEnabled","UncategorizedAccounts","DataSetNotAvailable","ValidationError"],"type":"string"},"Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccount":{"type":"object","properties":{"id":{"type":"string","nullable":true},"accountName":{"type":"string","nullable":true},"accountType":{"type":"string","nullable":true},"accountNumber":{"type":"string","nullable":true},"sortCode":{"type":"string","nullable":true},"routingInfo":{"$ref":"#\/components\/schemas\/Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccountRoutingInfo"},"currency":{"type":"string","nullable":true},"balance":{"type":"number","format":"double","nullable":true},"accountInfo":{"$ref":"#\/components\/schemas\/Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccountInfo"},"status":{"type":"string","nullable":true},"modifiedDate":{"type":"string","format":"date-time","nullable":true},"feedStartDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccountInfo":{"type":"object","properties":{"description":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"accountOpenDate":{"type":"string","format":"date-time","nullable":true},"availableBalance":{"type":"number","format":"double","nullable":true}},"additionalProperties":false},"Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccountMapping":{"type":"object","properties":{"sourceAccountId":{"type":"string","nullable":true},"targetAccountId":{"type":"string","nullable":true},"feedStartDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"Codat.Standardization.BankFeeds.Accounts.Contract.BankFeedBankAccountRoutingInfo":{"type":"object","properties":{"bankCode":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}},"additionalProperties":false},"Codat.Webhooks.Publisher.Client.Models.CompanyReference":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"tags":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"links":{"$ref":"#\/components\/schemas\/Codat.Webhooks.Publisher.Client.Models.CompanyWebhookLinks"}},"additionalProperties":false},"Codat.Webhooks.Publisher.Client.Models.CompanyWebhookLinks":{"type":"object","properties":{"portal":{"type":"string","nullable":true}},"additionalProperties":false},"System.ObjectPushOperation":{"required":["companyId","dataConnectionKey","pushOperationKey","requestedOnUtc","status","statusCode"],"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Push.PushOperationChange"},"nullable":true},"data":{"nullable":true},"dataType":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid"},"pushOperationKey":{"type":"string","format":"uuid"},"dataConnectionKey":{"type":"string","format":"uuid"},"requestedOnUtc":{"type":"string","format":"date-time"},"completedOnUtc":{"type":"string","format":"date-time","nullable":true},"timeoutInMinutes":{"type":"integer","format":"int32","nullable":true},"timeoutInSeconds":{"type":"integer","format":"int32","nullable":true,"deprecated":true},"status":{"minLength":1,"type":"string"},"errorMessage":{"type":"string","nullable":true},"validation":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Validation.ValidationResult"},"statusCode":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true}},"additionalProperties":false},"System.ObjectPushOperationPagedResponse":{"required":["pageNumber","pageSize","totalResults"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#\/components\/schemas\/System.ObjectPushOperation"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"_links":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/Codat.DataContracts.Responses.HalLink"},"nullable":true}},"additionalProperties":false}},"securitySchemes":{"APIKeyAuth":{"type":"apiKey","description":"The word \"Basic\" followed by a space and your API Key, base64 encoded, which can be found [here](https:\/\/app.codat.io\/#\/profile)","name":"Authorization","in":"header"},"Auth0Login":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https:\/\/authentication.codat.io\/authorize","tokenUrl":"https:\/\/authentication.codat.io\/oauth\/token","scopes":{"access:codatservice":"Resource access: access:codatservice","openid":"Resource access: openid"}}}}}},"security":[{"APIKeyAuth":[]}]}