diff --git a/sync-for-payroll/CodatSyncPayroll/Accounts.cs b/sync-for-payroll/CodatSyncPayroll/Accounts.cs index b0a9ea50b..08b58d0a6 100755 --- a/sync-for-payroll/CodatSyncPayroll/Accounts.cs +++ b/sync-for-payroll/CodatSyncPayroll/Accounts.cs @@ -19,23 +19,84 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Accounts + /// public interface IAccountsSDK { + + /// + /// Create account + /// + /// + /// The *Create account* endpoint creates a new account for a given company's connection.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// **Integration-specific behaviour**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create account model.
+ ///
+ /// Check out our coverage explorer for integrations that support creating an account.
+ /// + /// + /// Task CreateAsync(CreateAccountRequest? request = null); + + /// + /// Get account + /// + /// + /// The *Get account* endpoint returns a single account for a given `accountId`.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// Check out our coverage explorer for integrations that support getting a specific account.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ /// + /// + /// Task GetAsync(GetAccountRequest? request = null); + + /// + /// Get create account model + /// + /// + /// The *Get create account model* endpoint returns the expected data for the request payload when creating an account for a given company and integration.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// **Integration-specific behaviour**
+ ///
+ /// See the *response examples* for integration-specific indicative models.
+ ///
+ /// Check out our coverage explorer for integrations that support creating an account.
+ /// + /// + /// Task GetCreateModelAsync(GetCreateAccountsModelRequest? request = null); + + /// + /// List accounts + /// + /// + /// The *List accounts* endpoint returns a list of accounts for a given company's connection.
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company. + /// + /// Task ListAsync(ListAccountsRequest? request = null); } - /// - /// Accounts - /// public class AccountsSDK: IAccountsSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -50,22 +111,6 @@ public AccountsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu } - /// - /// Create account - /// - /// - /// The *Create account* endpoint creates a new [account](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company's connection. - /// - /// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions. - /// - /// **Integration-specific behaviour** - /// - /// Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-chartOfAccounts-model). - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - /// - /// - /// public async Task CreateAsync(CreateAccountRequest? request = null) { string baseUrl = _serverUrl; @@ -119,20 +164,6 @@ public AccountsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu } - /// - /// Get account - /// - /// - /// The *Get account* endpoint returns a single account for a given `accountId`. - /// - /// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions. - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// - /// public async Task GetAsync(GetAccountRequest? request = null) { string baseUrl = _serverUrl; @@ -181,22 +212,6 @@ public async Task GetAsync(GetAccountRequest? request = null } - /// - /// Get create account model - /// - /// - /// The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company and integration. - /// - /// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions. - /// - /// **Integration-specific behaviour** - /// - /// See the *response examples* for integration-specific indicative models. - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - /// - /// - /// public async Task GetCreateModelAsync(GetCreateAccountsModelRequest? request = null) { string baseUrl = _serverUrl; @@ -245,17 +260,6 @@ public async Task GetCreateModelAsync(GetCreateA } - /// - /// List accounts - /// - /// - /// The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company's connection. - /// - /// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// public async Task ListAsync(ListAccountsRequest? request = null) { string baseUrl = _serverUrl; diff --git a/sync-for-payroll/CodatSyncPayroll/CodatSyncPayroll.csproj b/sync-for-payroll/CodatSyncPayroll/CodatSyncPayroll.csproj index a0fb5c503..5b759fea8 100755 --- a/sync-for-payroll/CodatSyncPayroll/CodatSyncPayroll.csproj +++ b/sync-for-payroll/CodatSyncPayroll/CodatSyncPayroll.csproj @@ -2,11 +2,12 @@ true Codat.Sync.Payroll - 0.4.0 + 1.1.0 Codat net6.0 enable README.md + true diff --git a/sync-for-payroll/CodatSyncPayroll/CodatSyncPayrollSDK.cs b/sync-for-payroll/CodatSyncPayroll/CodatSyncPayrollSDK.cs index 8c3fe2169..6949b96e8 100755 --- a/sync-for-payroll/CodatSyncPayroll/CodatSyncPayrollSDK.cs +++ b/sync-for-payroll/CodatSyncPayroll/CodatSyncPayrollSDK.cs @@ -17,15 +17,72 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Sync for Payroll: The API for Sync for Payroll. <br/> + /// + /// + ///
+ /// Sync for Payroll is an API and a set of supporting tools built to help integrate your customers' payroll data from their HR and payroll platforms into their accounting platforms and to support its reconciliation.
+ ///
+ /// Explore product | See OpenAPI spec
+ ///
+ /// ---
+ ///
+ /// ## Endpoints
+ ///
+ /// | Endpoints | Description |
+ /// |:---------------------|:-----------------------------------------------------------------------------------------------------------|
+ /// | Companies | Create and manage your SMB users' companies. |
+ /// | Connections | Create new and manage existing data connections for a company. |
+ /// | Accounts | Get, create, and update Accounts. |
+ /// | Journal entries | Get, create, and update Journal entries. |
+ /// | Journals | Get, create, and update Journals. |
+ /// | Tracking categories | Get, create, and update Tracking Categories for additional categorization of payroll components. |
+ /// | Company info | View company profile from the source platform. |
+ /// | Manage data | Control how data is retrieved from an integration. | + /// + /// public interface ICodatSyncPayrollSDK { + + /// + /// Accounts + /// public IAccountsSDK Accounts { get; } + + /// + /// Create and manage your Codat companies. + /// public ICompaniesSDK Companies { get; } + + /// + /// View company information fetched from the source platform. + /// public ICompanyInfoSDK CompanyInfo { get; } + + /// + /// Manage your companies&apos; data connections. + /// public IConnectionsSDK Connections { get; } + + /// + /// Journal entries + /// public IJournalEntriesSDK JournalEntries { get; } + + /// + /// Journals + /// public IJournalsSDK Journals { get; } + + /// + /// Asynchronously retrieve data from an integration to refresh data in Codat. + /// public IManageDataSDK ManageData { get; } + + /// + /// Tracking categories + /// public ITrackingCategoriesSDK TrackingCategories { get; } } @@ -33,31 +90,6 @@ public class SDKConfig { } - /// - /// Sync for Payroll: The API for Sync for Payroll. - /// - /// - /// - /// Sync for Payroll is an API and a set of supporting tools built to help integrate your customers' payroll data from their HR and payroll platforms into their accounting platforms and to support its reconciliation. - /// - /// [Explore product](https://docs.codat.io/payroll/overview) | [See OpenAPI spec](https://github.com/codatio/oas) - /// - /// --- - /// - /// ## Endpoints - /// - /// | Endpoints | Description | - /// |:---------------------|:-----------------------------------------------------------------------------------------------------------| - /// | Companies | Create and manage your SMB users' companies. | - /// | Connections | Create new and manage existing data connections for a company. | - /// | Accounts | Get, create, and update Accounts. | - /// | Journal entries | Get, create, and update Journal entries. | - /// | Journals | Get, create, and update Journals. | - /// | Tracking categories | Get, create, and update Tracking Categories for additional categorization of payroll components. | - /// | Company info | View company profile from the source platform. | - /// | Manage data | Control how data is retrieved from an integration. | - /// - /// public class CodatSyncPayrollSDK: ICodatSyncPayrollSDK { public SDKConfig Config { get; private set; } @@ -67,43 +99,19 @@ public class CodatSyncPayrollSDK: ICodatSyncPayrollSDK }; private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; private ISpeakeasyHttpClient _securityClient; - /// - /// Accounts - /// public IAccountsSDK Accounts { get; private set; } - /// - /// Create and manage your Codat companies. - /// public ICompaniesSDK Companies { get; private set; } - /// - /// View company information fetched from the source platform. - /// public ICompanyInfoSDK CompanyInfo { get; private set; } - /// - /// Manage your companies' data connections. - /// public IConnectionsSDK Connections { get; private set; } - /// - /// Journal entries - /// public IJournalEntriesSDK JournalEntries { get; private set; } - /// - /// Journals - /// public IJournalsSDK Journals { get; private set; } - /// - /// Asynchronously retrieve data from an integration to refresh data in Codat. - /// public IManageDataSDK ManageData { get; private set; } - /// - /// Tracking categories - /// public ITrackingCategoriesSDK TrackingCategories { get; private set; } public CodatSyncPayrollSDK(Security? security = null, string? serverUrl = null, ISpeakeasyHttpClient? client = null) diff --git a/sync-for-payroll/CodatSyncPayroll/Companies.cs b/sync-for-payroll/CodatSyncPayroll/Companies.cs index 9d616a582..46147584d 100755 --- a/sync-for-payroll/CodatSyncPayroll/Companies.cs +++ b/sync-for-payroll/CodatSyncPayroll/Companies.cs @@ -19,24 +19,69 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Create and manage your Codat companies. + /// public interface ICompaniesSDK { + + /// + /// Create company + /// + /// + /// Creates a new company that can be used to assign connections to.
+ ///
+ /// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
+ ///
+ /// + /// + /// Task CreateAsync(CompanyRequestBody? request = null); + + /// + /// Delete a company + /// + /// + ///
+ /// Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned. + /// + /// Task DeleteAsync(DeleteCompanyRequest? request = null); + + /// + /// Get company + /// + /// + /// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. + /// + /// Task GetAsync(GetCompanyRequest? request = null); + + /// + /// List companies + /// + /// + /// Returns a list of your companies. The company schema contains a list of connections related to the company. + /// + /// Task ListAsync(ListCompaniesRequest? request = null); + + /// + /// Update company + /// + /// + /// Updates both the name and description of the company. + /// + /// Task UpdateAsync(UpdateCompanyRequest? request = null); } - /// - /// Create and manage your Codat companies. - /// public class CompaniesSDK: ICompaniesSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -51,17 +96,6 @@ public CompaniesSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient sec } - /// - /// Create company - /// - /// - /// Creates a new company that can be used to assign connections to. - /// - /// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`. - /// - /// - /// - /// public async Task CreateAsync(CompanyRequestBody? request = null) { string baseUrl = _serverUrl; @@ -115,14 +149,6 @@ public async Task CreateAsync(CompanyRequestBody? request } - /// - /// Delete a company - /// - /// - /// - /// Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned. - /// - /// public async Task DeleteAsync(DeleteCompanyRequest? request = null) { string baseUrl = _serverUrl; @@ -167,13 +193,6 @@ public async Task DeleteAsync(DeleteCompanyRequest? reque } - /// - /// Get company - /// - /// - /// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. - /// - /// public async Task GetAsync(GetCompanyRequest? request = null) { string baseUrl = _serverUrl; @@ -222,13 +241,6 @@ public async Task GetAsync(GetCompanyRequest? request = null } - /// - /// List companies - /// - /// - /// Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) related to the company. - /// - /// public async Task ListAsync(ListCompaniesRequest? request = null) { string baseUrl = _serverUrl; @@ -277,13 +289,6 @@ public async Task ListAsync(ListCompaniesRequest? request } - /// - /// Update company - /// - /// - /// Updates both the name and description of the company. - /// - /// public async Task UpdateAsync(UpdateCompanyRequest? request = null) { string baseUrl = _serverUrl; diff --git a/sync-for-payroll/CodatSyncPayroll/CompanyInfo.cs b/sync-for-payroll/CodatSyncPayroll/CompanyInfo.cs index b22dea399..3fe5ab540 100755 --- a/sync-for-payroll/CodatSyncPayroll/CompanyInfo.cs +++ b/sync-for-payroll/CodatSyncPayroll/CompanyInfo.cs @@ -19,20 +19,28 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// View company information fetched from the source platform. + /// public interface ICompanyInfoSDK { + + /// + /// Get company accounting profile + /// + /// + /// Gets the latest basic info for a company. + /// + /// Task GetAccountingProfileAsync(GetAccountingProfileRequest? request = null); } - /// - /// View company information fetched from the source platform. - /// public class CompanyInfoSDK: ICompanyInfoSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -47,13 +55,6 @@ public CompanyInfoSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient s } - /// - /// Get company accounting profile - /// - /// - /// Gets the latest basic info for a company. - /// - /// public async Task GetAccountingProfileAsync(GetAccountingProfileRequest? request = null) { string baseUrl = _serverUrl; @@ -84,7 +85,7 @@ public async Task GetAccountingProfileAsync(GetAcc { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.CompanyInformation = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.CompanyInfo = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); } return response; diff --git a/sync-for-payroll/CodatSyncPayroll/Connections.cs b/sync-for-payroll/CodatSyncPayroll/Connections.cs index 4fd0f8596..f0d20935f 100755 --- a/sync-for-payroll/CodatSyncPayroll/Connections.cs +++ b/sync-for-payroll/CodatSyncPayroll/Connections.cs @@ -19,24 +19,67 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Manage your companies&apos; data connections. + /// public interface IConnectionsSDK { + + /// + /// Create connection + /// + /// + /// Creates a connection for the company by providing a valid `platformKey`.
+ ///
+ /// Use the List Integrations endpoint to access valid platform keys. + /// + /// Task CreateAsync(CreateConnectionRequest? request = null); + + /// + /// Delete connection + /// + /// + /// Revoke and remove a connection from a company.
+ /// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. + /// + /// Task DeleteAsync(DeleteConnectionRequest? request = null); + + /// + /// Get connection + /// + /// + /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. + /// + /// Task GetAsync(GetConnectionRequest? request = null); + + /// + /// List connections + /// + /// + /// List the connections for a company. + /// + /// Task ListAsync(ListConnectionsRequest? request = null); + + /// + /// Unlink connection + /// + /// + /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. + /// + /// Task UnlinkAsync(UnlinkConnectionRequest? request = null); } - /// - /// Manage your companies' data connections. - /// public class ConnectionsSDK: IConnectionsSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -51,15 +94,6 @@ public ConnectionsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient s } - /// - /// Create connection - /// - /// - /// Creates a connection for the company by providing a valid `platformKey`. - /// - /// Use the [List Integrations](https://docs.codat.io/sync-for-payroll-api#/operations/list-integrations) endpoint to access valid platform keys. - /// - /// public async Task CreateAsync(CreateConnectionRequest? request = null) { string baseUrl = _serverUrl; @@ -113,14 +147,6 @@ public async Task CreateAsync(CreateConnectionRequest? } - /// - /// Delete connection - /// - /// - /// Revoke and remove a connection from a company. - /// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. - /// - /// public async Task DeleteAsync(DeleteConnectionRequest? request = null) { string baseUrl = _serverUrl; @@ -165,13 +191,6 @@ public async Task DeleteAsync(DeleteConnectionRequest? } - /// - /// Get connection - /// - /// - /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. - /// - /// public async Task GetAsync(GetConnectionRequest? request = null) { string baseUrl = _serverUrl; @@ -220,13 +239,6 @@ public async Task GetAsync(GetConnectionRequest? request } - /// - /// List connections - /// - /// - /// List the connections for a company. - /// - /// public async Task ListAsync(ListConnectionsRequest? request = null) { string baseUrl = _serverUrl; @@ -275,13 +287,6 @@ public async Task ListAsync(ListConnectionsRequest? req } - /// - /// Unlink connection - /// - /// - /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. - /// - /// public async Task UnlinkAsync(UnlinkConnectionRequest? request = null) { string baseUrl = _serverUrl; diff --git a/sync-for-payroll/CodatSyncPayroll/JournalEntries.cs b/sync-for-payroll/CodatSyncPayroll/JournalEntries.cs index be2e5fa6a..5474237a6 100755 --- a/sync-for-payroll/CodatSyncPayroll/JournalEntries.cs +++ b/sync-for-payroll/CodatSyncPayroll/JournalEntries.cs @@ -19,24 +19,123 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Journal entries + /// public interface IJournalEntriesSDK { + + /// + /// Create journal entry + /// + /// + /// The *Create journal entry* endpoint creates a new journal entry for a given company's connection.
+ ///
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ ///
+ /// **Integration-specific behaviour**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create journal entry model.
+ ///
+ /// Check out our coverage explorer for integrations that support creating a journal entry.
+ /// + /// + /// Task CreateAsync(CreateJournalEntryRequest? request = null); + + /// + /// Delete journal entry + /// + /// + /// > **Use with caution**
+ /// >
+ /// >Because journal entries underpin every transaction in an accounting platform, deleting a journal entry can affect every transaction for a given company.
+ /// >
+ /// > **Before you proceed, make sure you understand the implications of deleting journal entries from an accounting perspective.**
+ ///
+ /// The *Delete journal entry* endpoint allows you to delete a specified journal entry from an accounting platform.
+ ///
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ ///
+ /// ### Process
+ /// 1. Pass the `{journalEntryId}` to the *Delete journal entry* endpoint and store the `pushOperationKey` returned.
+ /// 2. Check the status of the delete by checking the status of push operation either via
+ /// 1. Push operation webhook (advised),
+ /// 2. Push operation status endpoint.
+ ///
+ /// A `Success` status indicates that the journal entry object was deleted from the accounting platform.
+ /// 3. (Optional) Check that the journal entry was deleted from the accounting platform.
+ ///
+ /// ### Effect on related objects
+ ///
+ /// Be aware that deleting a journal entry from an accounting platform might cause related objects to be modified. For example, if you delete the journal entry for a paid invoice in QuickBooks Online, the invoice is deleted but the payment against that invoice is not. The payment is converted to a payment on account.
+ ///
+ /// ## Integration specifics
+ /// Integrations that support soft delete do not permanently delete the object in the accounting platform.
+ ///
+ /// | Integration | Soft Deleted |
+ /// |-------------|--------------|
+ /// | QuickBooks Online | Yes |
+ /// + /// + /// Task DeleteAsync(DeleteJournalEntryRequest? request = null); + + /// + /// Get journal entry + /// + /// + /// The *Get journal entry* endpoint returns a single journal entry for a given `journalEntryId`.
+ ///
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ ///
+ /// Check out our coverage explorer for integrations that support getting a specific journal entry.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ /// + /// + /// Task GetAsync(GetJournalEntryRequest? request = null); + + /// + /// Get create journal entry model + /// + /// + /// The *Get create journal entry model* endpoint returns the expected data for the request payload when creating a journal entry for a given company and integration.
+ ///
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ ///
+ /// **Integration-specific behaviour**
+ ///
+ /// See the *response examples* for integration-specific indicative models.
+ ///
+ /// Check out our coverage explorer for integrations that support creating a journal entry.
+ /// + /// + /// Task GetCreateModelAsync(GetCreateJournalEntryModelRequest? request = null); + + /// + /// List journal entries + /// + /// + /// The *List journal entries* endpoint returns a list of journal entries for a given company's connection.
+ ///
+ /// Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ /// + /// + /// Task ListAsync(ListJournalEntriesRequest? request = null); } - /// - /// Journal entries - /// public class JournalEntriesSDK: IJournalEntriesSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -51,22 +150,6 @@ public JournalEntriesSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClien } - /// - /// Create journal entry - /// - /// - /// The *Create journal entry* endpoint creates a new [journal entry](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) for a given company's connection. - /// - /// [Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. - /// - /// **Integration-specific behaviour** - /// - /// Required data may vary by integration. To see what data to post, first call [Get create journal entry model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-journalEntries-model). - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support creating a journal entry. - /// - /// - /// public async Task CreateAsync(CreateJournalEntryRequest? request = null) { string baseUrl = _serverUrl; @@ -120,42 +203,6 @@ public JournalEntriesSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClien } - /// - /// Delete journal entry - /// - /// - /// > **Use with caution** - /// > - /// >Because journal entries underpin every transaction in an accounting platform, deleting a journal entry can affect every transaction for a given company. - /// > - /// > **Before you proceed, make sure you understand the implications of deleting journal entries from an accounting perspective.** - /// - /// The *Delete journal entry* endpoint allows you to delete a specified journal entry from an accounting platform. - /// - /// [Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. - /// - /// ### Process - /// 1. Pass the `{journalEntryId}` to the *Delete journal entry* endpoint and store the `pushOperationKey` returned. - /// 2. Check the status of the delete by checking the status of push operation either via - /// 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised), - /// 2. [Push operation status endpoint](https://docs.codat.io/sync-for-payroll-api#/operations/get-push-operation). - /// - /// A `Success` status indicates that the journal entry object was deleted from the accounting platform. - /// 3. (Optional) Check that the journal entry was deleted from the accounting platform. - /// - /// ### Effect on related objects - /// - /// Be aware that deleting a journal entry from an accounting platform might cause related objects to be modified. For example, if you delete the journal entry for a paid invoice in QuickBooks Online, the invoice is deleted but the payment against that invoice is not. The payment is converted to a payment on account. - /// - /// ## Integration specifics - /// Integrations that support soft delete do not permanently delete the object in the accounting platform. - /// - /// | Integration | Soft Deleted | - /// |-------------|--------------| - /// | QuickBooks Online | Yes | - /// - /// - /// public async Task DeleteAsync(DeleteJournalEntryRequest? request = null) { string baseUrl = _serverUrl; @@ -204,20 +251,6 @@ public async Task DeleteAsync(DeleteJournalEntryRequ } - /// - /// Get journal entry - /// - /// - /// The *Get journal entry* endpoint returns a single journal entry for a given `journalEntryId`. - /// - /// [Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// - /// public async Task GetAsync(GetJournalEntryRequest? request = null) { string baseUrl = _serverUrl; @@ -266,22 +299,6 @@ public async Task GetAsync(GetJournalEntryRequest? requ } - /// - /// Get create journal entry model - /// - /// - /// The *Get create journal entry model* endpoint returns the expected data for the request payload when creating a [journal entry](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) for a given company and integration. - /// - /// [Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. - /// - /// **Integration-specific behaviour** - /// - /// See the *response examples* for integration-specific indicative models. - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support creating a journal entry. - /// - /// - /// public async Task GetCreateModelAsync(GetCreateJournalEntryModelRequest? request = null) { string baseUrl = _serverUrl; @@ -330,18 +347,6 @@ public async Task GetCreateModelAsync(GetCre } - /// - /// List journal entries - /// - /// - /// The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) for a given company's connection. - /// - /// [Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// - /// public async Task ListAsync(ListJournalEntriesRequest? request = null) { string baseUrl = _serverUrl; diff --git a/sync-for-payroll/CodatSyncPayroll/Journals.cs b/sync-for-payroll/CodatSyncPayroll/Journals.cs index d28f033e4..287636acc 100755 --- a/sync-for-payroll/CodatSyncPayroll/Journals.cs +++ b/sync-for-payroll/CodatSyncPayroll/Journals.cs @@ -19,23 +19,85 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Journals + /// public interface IJournalsSDK { + + /// + /// Create journal + /// + /// + /// The *Create journal* endpoint creates a new journal for a given company's connection.
+ ///
+ /// Journals are used to record all the financial transactions of a company.
+ ///
+ /// **Integration-specific behaviour**
+ ///
+ /// Required data may vary by integration. To see what data to post, first call Get create journal model.
+ ///
+ /// Check out our coverage explorer for integrations that support creating a journal.
+ /// + /// + /// Task CreateAsync(CreateJournalRequest? request = null); + + /// + /// Get journal + /// + /// + /// The *Get journal* endpoint returns a single journal for a given `journalId`.
+ ///
+ /// Journals are used to record all the financial transactions of a company.
+ ///
+ /// Check out our coverage explorer for integrations that support getting a specific journal.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ /// + /// + /// Task GetAsync(GetJournalRequest? request = null); + + /// + /// Get create journal model + /// + /// + /// The *Get create journal model* endpoint returns the expected data for the request payload when creating a journal for a given company and integration.
+ ///
+ /// Journals are used to record all the financial transactions of a company.
+ ///
+ /// **Integration-specific behaviour**
+ ///
+ /// See the *response examples* for integration-specific indicative models.
+ ///
+ /// Check out our coverage explorer for integrations that support creating a journal.
+ /// + /// + /// Task GetCreateModelAsync(GetCreateJournalModelRequest? request = null); + + /// + /// List journals + /// + /// + /// The *List journals* endpoint returns a list of journals for a given company's connection.
+ ///
+ /// Journals are used to record all the financial transactions of a company.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ /// + /// + /// Task ListAsync(ListJournalsRequest? request = null); } - /// - /// Journals - /// public class JournalsSDK: IJournalsSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -50,22 +112,6 @@ public JournalsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu } - /// - /// Create journal - /// - /// - /// The *Create journal* endpoint creates a new [journal](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) for a given company's connection. - /// - /// [Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company. - /// - /// **Integration-specific behaviour** - /// - /// Required data may vary by integration. To see what data to post, first call [Get create journal model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-journals-model). - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support creating a journal. - /// - /// - /// public async Task CreateAsync(CreateJournalRequest? request = null) { string baseUrl = _serverUrl; @@ -119,20 +165,6 @@ public JournalsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu } - /// - /// Get journal - /// - /// - /// The *Get journal* endpoint returns a single journal for a given `journalId`. - /// - /// [Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company. - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// - /// public async Task GetAsync(GetJournalRequest? request = null) { string baseUrl = _serverUrl; @@ -181,22 +213,6 @@ public async Task GetAsync(GetJournalRequest? request = null } - /// - /// Get create journal model - /// - /// - /// The *Get create journal model* endpoint returns the expected data for the request payload when creating a [journal](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) for a given company and integration. - /// - /// [Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company. - /// - /// **Integration-specific behaviour** - /// - /// See the *response examples* for integration-specific indicative models. - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support creating a journal. - /// - /// - /// public async Task GetCreateModelAsync(GetCreateJournalModelRequest? request = null) { string baseUrl = _serverUrl; @@ -245,18 +261,6 @@ public async Task GetCreateModelAsync(GetCreateJo } - /// - /// List journals - /// - /// - /// The *List journals* endpoint returns a list of [journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) for a given company's connection. - /// - /// [Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// - /// public async Task ListAsync(ListJournalsRequest? request = null) { string baseUrl = _serverUrl; diff --git a/sync-for-payroll/CodatSyncPayroll/ManageData.cs b/sync-for-payroll/CodatSyncPayroll/ManageData.cs index 2ff9dbeaf..a5f0dc486 100755 --- a/sync-for-payroll/CodatSyncPayroll/ManageData.cs +++ b/sync-for-payroll/CodatSyncPayroll/ManageData.cs @@ -20,26 +20,88 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Asynchronously retrieve data from an integration to refresh data in Codat. + /// public interface IManageDataSDK { + + /// + /// Get data status + /// + /// + /// Get the state of each data type for a company + /// + /// Task GetDataStatusAsync(GetDataStatusRequest? request = null); + + /// + /// Get pull operation + /// + /// + /// Retrieve information about a single dataset or pull operation. + /// + /// Task GetPullOperationAsync(GetPullOperationRequest? request = null); + + /// + /// Get push operation + /// + /// + /// Retrieve push operation. + /// + /// Task GetPushOperationAsync(GetPushOperationRequest? request = null); + + /// + /// List push operations + /// + /// + /// List push operation records. + /// + /// Task ListAsync(ListPushOperationsRequest? request = null); + + /// + /// List pull operations + /// + /// + /// Gets the pull operation history (datasets) for a given company. + /// + /// Task ListPullOperationsAsync(ListPullOperationsRequest? request = null); + + /// + /// Refresh all data + /// + /// + /// Refreshes all data types with `fetch on first link` set to `true` for a given company.
+ ///
+ /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+ ///
+ /// Read more about data type settings and `fetch on first link`. + /// + /// Task RefreshAllDataTypesAsync(RefreshAllDataTypesRequest? request = null); + + /// + /// Refresh data type + /// + /// + /// Refreshes a given data type for a given company.
+ ///
+ /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + /// + /// Task RefreshDataTypeAsync(RefreshDataTypeRequest? request = null); } - /// - /// Asynchronously retrieve data from an integration to refresh data in Codat. - /// public class ManageDataSDK: IManageDataSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -54,13 +116,6 @@ public ManageDataSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient se } - /// - /// Get data status - /// - /// - /// Get the state of each data type for a company - /// - /// public async Task GetDataStatusAsync(GetDataStatusRequest? request = null) { string baseUrl = _serverUrl; @@ -109,13 +164,6 @@ public async Task GetDataStatusAsync(GetDataStatusRequest } - /// - /// Get pull operation - /// - /// - /// Retrieve information about a single dataset or pull operation. - /// - /// public async Task GetPullOperationAsync(GetPullOperationRequest? request = null) { string baseUrl = _serverUrl; @@ -164,13 +212,6 @@ public async Task GetPullOperationAsync(GetPullOperati } - /// - /// Get push operation - /// - /// - /// Retrieve push operation. - /// - /// public async Task GetPushOperationAsync(GetPushOperationRequest? request = null) { string baseUrl = _serverUrl; @@ -219,13 +260,6 @@ public async Task GetPushOperationAsync(GetPushOperati } - /// - /// List push operations - /// - /// - /// List push operation records. - /// - /// public async Task ListAsync(ListPushOperationsRequest? request = null) { string baseUrl = _serverUrl; @@ -274,13 +308,6 @@ public async Task ListAsync(ListPushOperationsReques } - /// - /// List pull operations - /// - /// - /// Gets the pull operation history (datasets) for a given company. - /// - /// public async Task ListPullOperationsAsync(ListPullOperationsRequest? request = null) { string baseUrl = _serverUrl; @@ -329,17 +356,6 @@ public async Task ListPullOperationsAsync(ListPullOp } - /// - /// Refresh all data - /// - /// - /// Refreshes all data types with `fetch on first link` set to `true` for a given company. - /// - /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. - /// - /// [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. - /// - /// public async Task RefreshAllDataTypesAsync(RefreshAllDataTypesRequest? request = null) { string baseUrl = _serverUrl; @@ -384,15 +400,6 @@ public async Task RefreshAllDataTypesAsync(RefreshA } - /// - /// Refresh data type - /// - /// - /// Refreshes a given data type for a given company. - /// - /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. - /// - /// public async Task RefreshDataTypeAsync(RefreshDataTypeRequest? request = null) { string baseUrl = _serverUrl; diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountRequest.cs index 275e8079e..886dc2c67 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountRequest.cs @@ -13,21 +13,19 @@ namespace CodatSyncPayroll.Models.Operations using CodatSyncPayroll.Models.Shared; using CodatSyncPayroll.Utils; - public class CreateAccountRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public Account? Account { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - + [SpeakeasyMetadata("queryParam:style=form,explode=true,name=timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountResponse.cs index 7619faa17..6ba43cef0 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateAccountResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class CreateAccountResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Success /// - public Models.Shared.CreateAccountResponse? CreateAccountResponseValue { get; set; } - + /// /// The request made is not valid. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateCompanyResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateCompanyResponse.cs index 9cd26c13b..01d700293 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateCompanyResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateCompanyResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class CreateCompanyResponse { + /// /// OK /// - public Company? Company { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// The request made is not valid. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequest.cs index a72bcaa4d..1fda24e68 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class CreateConnectionRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public CreateConnectionRequestBody? RequestBody { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequestBody.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequestBody.cs index 0c7032b75..f0e6a7ebf 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequestBody.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionRequestBody.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Operations { using Newtonsoft.Json; - public class CreateConnectionRequestBody { + [JsonProperty("platformKey")] public string? PlatformKey { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionResponse.cs index 793cdc09e..8c8b60703 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateConnectionResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class CreateConnectionResponse { + /// /// OK /// - public Connection? Connection { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryRequest.cs index 82c3a1b48..3e1516413 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryRequest.cs @@ -13,21 +13,19 @@ namespace CodatSyncPayroll.Models.Operations using CodatSyncPayroll.Models.Shared; using CodatSyncPayroll.Utils; - public class CreateJournalEntryRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public JournalEntry? JournalEntry { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - + [SpeakeasyMetadata("queryParam:style=form,explode=true,name=timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryResponse.cs index 05ed8dc5d..2095d6f8e 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalEntryResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class CreateJournalEntryResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Success /// - public Models.Shared.CreateJournalEntryResponse? CreateJournalEntryResponseValue { get; set; } - + /// /// The request made is not valid. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalRequest.cs index ef3bc55a0..d58117e96 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalRequest.cs @@ -13,21 +13,19 @@ namespace CodatSyncPayroll.Models.Operations using CodatSyncPayroll.Models.Shared; using CodatSyncPayroll.Utils; - public class CreateJournalRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public Journal? Journal { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - + [SpeakeasyMetadata("queryParam:style=form,explode=true,name=timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalResponse.cs index e23fd369f..8e56dd6e0 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/CreateJournalResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class CreateJournalResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Success /// - public Models.Shared.CreateJournalResponse? CreateJournalResponseValue { get; set; } - + /// /// The request made is not valid. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyRequest.cs index 0c06842f4..96d069b95 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyRequest.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class DeleteCompanyRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyResponse.cs index 181e11530..99d625dd7 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteCompanyResponse.cs @@ -14,24 +14,18 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class DeleteCompanyResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionRequest.cs index b79f19194..66ef9647b 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class DeleteConnectionRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionResponse.cs index 323697ee8..bca2c296d 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteConnectionResponse.cs @@ -14,24 +14,18 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class DeleteConnectionResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryRequest.cs index ebd0b73dc..fd0b93a30 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class DeleteJournalEntryRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=journalEntryId")] public string JournalEntryId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryResponse.cs index 10e975649..9ed6832e0 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/DeleteJournalEntryResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class DeleteJournalEntryResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOperation? PushOperation { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountRequest.cs index 67e3afc9d..c7ceb5371 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountRequest.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetAccountRequest { + /// /// Unique identifier for an account /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=accountId")] public string AccountId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountResponse.cs index 724b0e74e..cd189f45a 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetAccountResponse { + /// /// Success /// - public Account? Account { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformation.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformation.cs deleted file mode 100755 index 839b68ee1..000000000 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformation.cs +++ /dev/null @@ -1,179 +0,0 @@ - -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace CodatSyncPayroll.Models.Operations -{ - using Newtonsoft.Json; - using System.Collections.Generic; - - - /// - /// > View the coverage for company info in the Data coverage explorer. - /// - /// - /// - /// Company info provides standard details about a linked company such as their address, phone number, and company registration. - /// - /// > **Company information or companies?** - /// > - /// > Company information is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. - /// - /// - public class GetAccountingProfileCompanyInformation - { - /// - /// Identifier or reference for the company in the accounting platform. - /// - [JsonProperty("accountingPlatformRef")] - public string? AccountingPlatformRef { get; set; } - - /// - /// An array of Addresses. - /// - [JsonProperty("addresses")] - public List? Addresses { get; set; } - - /// - /// Currency set in the accounting platform of the linked company. Used by the currency rate. - /// - [JsonProperty("baseCurrency")] - public string? BaseCurrency { get; set; } - - /// - /// Registered legal name of the linked company. - /// - [JsonProperty("companyLegalName")] - public string? CompanyLegalName { get; set; } - - /// - /// Name of the linked company. - /// - [JsonProperty("companyName")] - public string? CompanyName { get; set; } - - /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - /// - /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. - /// - /// - [JsonProperty("createdDate")] - public string? CreatedDate { get; set; } - - /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - /// - /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. - /// - /// - [JsonProperty("financialYearStartDate")] - public string? FinancialYearStartDate { get; set; } - - /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - /// - /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. - /// - /// - [JsonProperty("ledgerLockDate")] - public string? LedgerLockDate { get; set; } - - /// - /// An array of phone numbers. - /// - [JsonProperty("phoneNumbers")] - public List? PhoneNumbers { get; set; } - - /// - /// Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. - /// - [JsonProperty("registrationNumber")] - public string? RegistrationNumber { get; set; } - - /// - /// URL addresses for the accounting source. - /// - /// - /// - /// For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). - /// - /// - [JsonProperty("sourceUrls")] - public Dictionary? SourceUrls { get; set; } - - /// - /// Company tax number. - /// - [JsonProperty("taxNumber")] - public string? TaxNumber { get; set; } - - /// - /// An array of weblinks. - /// - [JsonProperty("webLinks")] - public List? WebLinks { get; set; } - - } - -} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileRequest.cs index a669c77c2..031a1bf7a 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileRequest.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetAccountingProfileRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileResponse.cs index e062a5dad..b1129e0fc 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetAccountingProfileResponse { + /// /// Success /// - - public GetAccountingProfileCompanyInformation? CompanyInformation { get; set; } - - + public CompanyInfo? CompanyInfo { get; set; } + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyRequest.cs index f9ac7add5..b33030612 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyRequest.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetCompanyRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyResponse.cs index 2b0f5db5a..5bc759224 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCompanyResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetCompanyResponse { + /// /// OK /// - public Company? Company { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionRequest.cs index 23a5eafdd..006a02918 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetConnectionRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionResponse.cs index 900c0f359..b878499be 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetConnectionResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetConnectionResponse { + /// /// OK /// - public Connection? Connection { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelRequest.cs index 0f067af3b..690474849 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetCreateAccountsModelRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelResponse.cs index 789f6f05c..19e1561d2 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateAccountsModelResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetCreateAccountsModelResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOption? PushOption { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelRequest.cs index 5a37bfea6..f75eb59a5 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetCreateJournalEntryModelRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelResponse.cs index ffde95fd7..46db8d427 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalEntryModelResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetCreateJournalEntryModelResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOption? PushOption { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelRequest.cs index 3c82f89a1..c232d8aa7 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetCreateJournalModelRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelResponse.cs index 37c3910bf..a75bb05f9 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetCreateJournalModelResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetCreateJournalModelResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOption? PushOption { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusRequest.cs index 2e7701870..69eb425d1 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusRequest.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetDataStatusRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusResponse.cs index f1476d13a..34594f430 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetDataStatusResponse.cs @@ -15,30 +15,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetDataStatusResponse { - + public string? ContentType { get; set; } = default!; - + /// /// OK /// - public Dictionary? DataStatusResponse { get; set; } - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryRequest.cs index 1bcc1a2e6..17b570e08 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetJournalEntryRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=journalEntryId")] public string JournalEntryId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryResponse.cs index efda87120..cf2ebf1c6 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalEntryResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetJournalEntryResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// Success /// - public JournalEntry? JournalEntry { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalRequest.cs index f85547c10..6578b7d84 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetJournalRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=journalId")] public string JournalId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalResponse.cs index a90f63119..20829b6fa 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetJournalResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetJournalResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// Success /// - public Journal? Journal { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationRequest.cs index 8420d8576..6527d363b 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationRequest.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetPullOperationRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// /// Unique ID of a dataset or pull operation. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=datasetId")] public string DatasetId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationResponse.cs index 53dc936aa..7808f3bf6 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPullOperationResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetPullOperationResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PullOperation? PullOperation { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationRequest.cs index 6c358939c..4ba64930a 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationRequest.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetPushOperationRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// /// Push operation key. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=pushOperationKey")] public string PushOperationKey { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationResponse.cs index 73cdff35a..895cb6e57 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetPushOperationResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetPushOperationResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOperation? PushOperation { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryRequest.cs index faa57084a..f3dc053c7 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryRequest.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class GetTrackingCategoryRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=trackingCategoryId")] public string TrackingCategoryId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryResponse.cs index 8cf60c336..804bfa9a4 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetTrackingCategoryResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class GetTrackingCategoryResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - + /// /// Success /// - public TrackingCategoryTree? TrackingCategoryTree { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsRequest.cs index f3884a59f..44e9e7b08 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsRequest.cs @@ -12,36 +12,34 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListAccountsRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsResponse.cs index 7cd02dd5a..318d1a1e8 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListAccountsResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListAccountsResponse { + /// /// Success /// - public Accounts? Accounts { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesRequest.cs index 9b537e6bf..2aa66397b 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesRequest.cs @@ -12,33 +12,31 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListCompaniesRequest { + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesResponse.cs index 683bffff3..ddadd0093 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListCompaniesResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListCompaniesResponse { + /// /// OK /// - public Companies? Companies { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsRequest.cs index 27e3504da..ada85962e 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsRequest.cs @@ -12,36 +12,34 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListConnectionsRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsResponse.cs index 82d4ba0e2..4021f0c79 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListConnectionsResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListConnectionsResponse { + /// /// OK /// - public Connections? Connections { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesRequest.cs index 5723de7e9..5f72ab32e 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesRequest.cs @@ -12,36 +12,34 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListJournalEntriesRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesResponse.cs index c091e8fa3..8e4f233a2 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalEntriesResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListJournalEntriesResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// Success /// - public JournalEntries? JournalEntries { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsRequest.cs index 53753f81f..6ab9cc4a6 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsRequest.cs @@ -12,36 +12,34 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListJournalsRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsResponse.cs index 0d0824bd1..e5fe002fb 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListJournalsResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListJournalsResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// Success /// - public Journals? Journals { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsRequest.cs index 5c6e8d749..cae1b6edc 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsRequest.cs @@ -12,36 +12,34 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListPullOperationsRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsResponse.cs index c985271a2..0714a1c32 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPullOperationsResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListPullOperationsResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PullOperations? PullOperations { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsRequest.cs index 6eeaffd95..3dbf92535 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsRequest.cs @@ -12,36 +12,34 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListPushOperationsRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsResponse.cs index 00e8d8221..f35c914d8 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListPushOperationsResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListPushOperationsResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOperations? PushOperations { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesRequest.cs index 86ad607ee..5be0a6d15 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesRequest.cs @@ -12,36 +12,34 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class ListTrackingCategoriesRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesResponse.cs index 6af665c6c..f894c79a1 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/ListTrackingCategoriesResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class ListTrackingCategoriesResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - + /// /// Success /// - public TrackingCategories? TrackingCategories { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesRequest.cs index 668c09a38..5daa15286 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesRequest.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class RefreshAllDataTypesRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesResponse.cs index c1204be08..2ccfb8ed3 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshAllDataTypesResponse.cs @@ -14,24 +14,18 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class RefreshAllDataTypesResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeRequest.cs index 86d21ff83..f049af904 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeRequest.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Operations using CodatSyncPayroll.Models.Shared; using CodatSyncPayroll.Utils; - public class RefreshDataTypeRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// /// Optionally, provide a data connection id to only queue pull operations on that connection. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=connectionId")] public string? ConnectionId { get; set; } - + /// /// The key of a Codat data type /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public DataType DataType { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeResponse.cs index 4ce92d90e..c8ca506da 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/RefreshDataTypeResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class RefreshDataTypeResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PullOperation? PullOperation { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionRequest.cs index 559524440..a1c23a359 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionRequest.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Operations { using CodatSyncPayroll.Utils; - public class UnlinkConnectionRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public UnlinkConnectionUpdateConnection? RequestBody { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionResponse.cs index e6ce30ba0..f58100079 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class UnlinkConnectionResponse { + /// /// OK /// - public Connection? Connection { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionUpdateConnection.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionUpdateConnection.cs index 509862252..beea26838 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionUpdateConnection.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UnlinkConnectionUpdateConnection.cs @@ -13,15 +13,13 @@ namespace CodatSyncPayroll.Models.Operations using CodatSyncPayroll.Models.Shared; using Newtonsoft.Json; - public class UnlinkConnectionUpdateConnection { + /// /// The current authorization status of the data connection. /// [JsonProperty("status")] public DataConnectionStatus? Status { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyRequest.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyRequest.cs index d4a022f52..927b0b8b1 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyRequest.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyRequest.cs @@ -13,15 +13,13 @@ namespace CodatSyncPayroll.Models.Operations using CodatSyncPayroll.Models.Shared; using CodatSyncPayroll.Utils; - public class UpdateCompanyRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public CompanyRequestBody? CompanyRequestBody { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyResponse.cs index 80343a5fc..f0814b713 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Operations/UpdateCompanyResponse.cs @@ -14,30 +14,23 @@ namespace CodatSyncPayroll.Models.Operations using System.Net.Http; using System; - public class UpdateCompanyResponse { + /// /// OK /// - public Company? Company { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Account.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Account.cs index 87475b7c6..ceb46050b 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Account.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Account.cs @@ -13,143 +13,141 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// - /// > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. + /// &gt; **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.<br/> /// /// - /// - /// View the coverage for accounts in the Data coverage explorer. - /// - /// ## Overview - /// - /// Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company. - /// - /// The categories for an account include: - /// * Asset - /// * Expense - /// * Income - /// * Liability - /// * Equity. - /// - /// The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online. - /// - /// At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided. - /// - /// To determine the list of allowed categories for a specific integration, you can: - /// - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model). - /// - Refer to the integration's own documentation. - /// - /// > **Accounts with no category** - /// > - /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`. - /// > - /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. + ///
+ /// View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
+ ///
+ /// ## Overview
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.
+ ///
+ /// The categories for an account include:
+ /// * Asset
+ /// * Expense
+ /// * Income
+ /// * Liability
+ /// * Equity.
+ ///
+ /// The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.
+ ///
+ /// At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.
+ ///
+ /// To determine the list of allowed categories for a specific integration, you can:
+ /// - Follow our Create, update, delete data guide and use the Get create account model.
+ /// - Refer to the integration's own documentation.
+ ///
+ /// > **Accounts with no category**
+ /// >
+ /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
+ /// >
+ /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. /// /// public class Account { + /// - /// The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. + /// The currency data type in Codat is the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a> currency code, e.g. _GBP_.<br/> /// /// - /// - /// ## Unknown currencies - /// - /// In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - /// + ///
+ /// ## Unknown currencies
+ ///
+ /// In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+ ///
/// There are only a very small number of edge cases where this currency code is returned by the Codat system. /// /// [JsonProperty("currency")] public string? Currency { get; set; } - + /// /// Current balance in the account. /// [JsonProperty("currentBalance")] public decimal? CurrentBalance { get; set; } - + /// /// Description for the account. /// [JsonProperty("description")] public string? Description { get; set; } - + /// - /// Full category of the account. + /// Full category of the account. <br/> /// /// - /// - /// For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. + ///
+ /// For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our Create, update, delete data guide, or refer to the integration's own documentation. /// /// [JsonProperty("fullyQualifiedCategory")] public string? FullyQualifiedCategory { get; set; } - + /// - /// Full name of the account, for example: + /// Full name of the account, for example:<br/> /// /// - /// - `Cash On Hand` - /// - `Rents Held In Trust` + /// - `Cash On Hand`
+ /// - `Rents Held In Trust`
/// - `Fixed Asset` /// /// [JsonProperty("fullyQualifiedName")] public string? FullyQualifiedName { get; set; } - + /// /// Identifier for the account, unique for the company. /// [JsonProperty("id")] public string? Id { get; set; } - + /// /// Confirms whether the account is a bank account or not. /// [JsonProperty("isBankAccount")] public bool? IsBankAccount { get; set; } - + [JsonProperty("metadata")] public AccountMetadata? Metadata { get; set; } - + [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } - + /// /// Name of the account. /// [JsonProperty("name")] public string? Name { get; set; } - + /// - /// Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. + /// Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn&apos;t a unique identifier in the Codat system. /// [JsonProperty("nominalCode")] public string? NominalCode { get; set; } - + [JsonProperty("sourceModifiedDate")] public string? SourceModifiedDate { get; set; } - + /// /// Status of the account /// [JsonProperty("status")] public AccountStatus? Status { get; set; } - + /// /// Type of account /// [JsonProperty("type")] public AccountType? Type { get; set; } - + /// - /// The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/accounting-api#/schemas/ValidDataTypeLinks). + /// The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see <a href="/accounting-api#/schemas/ValidDataTypeLinks">Valid Data Type Links</a>. /// [JsonProperty("validDatatypeLinks")] public List? ValidDatatypeLinks { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountMetadata.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountMetadata.cs index a4f67902b..97f590b50 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountMetadata.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountMetadata.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class AccountMetadata { + /// /// Indicates whether the record has been deleted in the third-party system this record originated from. /// [JsonProperty("isDeleted")] public bool? IsDeleted { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountRef.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountRef.cs index 615cd4cc0..1db1ec529 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountRef.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountRef.cs @@ -12,24 +12,22 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// /// Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. /// public class AccountRef { + /// - /// 'id' from the Accounts data type. + /// &apos;id&apos; from the Accounts data type. /// [JsonProperty("id")] public string? Id { get; set; } - + /// - /// 'name' from the Accounts data type. + /// &apos;name&apos; from the Accounts data type. /// [JsonProperty("name")] public string? Name { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountStatus.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountStatus.cs index 1dc3accdb..132799238 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountStatus.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountStatus.cs @@ -13,22 +13,21 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// /// Status of the account /// public enum AccountStatus { - [JsonProperty("Unknown")] - Unknown, - [JsonProperty("Active")] - Active, - [JsonProperty("Archived")] - Archived, - [JsonProperty("Pending")] - Pending, + [JsonProperty("Unknown")] + Unknown, + [JsonProperty("Active")] + Active, + [JsonProperty("Archived")] + Archived, + [JsonProperty("Pending")] + Pending, } - + public static class AccountStatusExtension { public static string Value(this AccountStatus value) @@ -55,5 +54,4 @@ public static AccountStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountStatus"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountType.cs index 91e8e748d..3e96c9841 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountType.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountType.cs @@ -13,26 +13,25 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// /// Type of account /// public enum AccountType { - [JsonProperty("Unknown")] - Unknown, - [JsonProperty("Asset")] - Asset, - [JsonProperty("Expense")] - Expense, - [JsonProperty("Income")] - Income, - [JsonProperty("Liability")] - Liability, - [JsonProperty("Equity")] - Equity, + [JsonProperty("Unknown")] + Unknown, + [JsonProperty("Asset")] + Asset, + [JsonProperty("Expense")] + Expense, + [JsonProperty("Income")] + Income, + [JsonProperty("Liability")] + Liability, + [JsonProperty("Equity")] + Equity, } - + public static class AccountTypeExtension { public static string Value(this AccountType value) @@ -59,5 +58,4 @@ public static AccountType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum AccountType"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountValidDataTypeLinks.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountValidDataTypeLinks.cs index 231c1f365..042e9f3f0 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountValidDataTypeLinks.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountValidDataTypeLinks.cs @@ -13,66 +13,64 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// - /// When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data. + /// When querying Codat&apos;s data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.<br/> /// /// - /// - /// For example, `validDatatypeLinks` might indicate the following references: - /// - /// - Which tax rates are valid to use on the line item of a bill. - /// - Which items can be used when creating an invoice. - /// - /// You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example. - /// - /// ## `validDatatypeLinks` example - /// - /// The following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error. - /// - /// ```json validDatatypeLinks for an account - /// { - /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", - /// "nominalCode": "090", - /// "name": "Business Bank Account", - /// #... - /// "validDatatypeLinks": [ - /// { - /// "property": "Id", - /// "links": [ - /// "Payment.AccountRef.Id", - /// "BillPayment.AccountRef.Id", - /// "DirectIncome.LineItems.AccountRef.Id", - /// "DirectCost.LineItems.AccountRef.Id" - /// ] - /// } - /// ] - /// } - /// ``` - /// - /// - /// - /// ## Support for `validDatatypeLinks` - /// - /// Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. - /// - /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. + ///
+ /// For example, `validDatatypeLinks` might indicate the following references:
+ ///
+ /// - Which tax rates are valid to use on the line item of a bill.
+ /// - Which items can be used when creating an invoice.
+ ///
+ /// You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example.
+ ///
+ /// ## `validDatatypeLinks` example
+ ///
+ /// The following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error.
+ ///
+ /// ```json validDatatypeLinks for an account
+ /// {
+ /// "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
+ /// "nominalCode": "090",
+ /// "name": "Business Bank Account",
+ /// #...
+ /// "validDatatypeLinks": [
+ /// {
+ /// "property": "Id",
+ /// "links": [
+ /// "Payment.AccountRef.Id",
+ /// "BillPayment.AccountRef.Id",
+ /// "DirectIncome.LineItems.AccountRef.Id",
+ /// "DirectCost.LineItems.AccountRef.Id"
+ /// ]
+ /// }
+ /// ]
+ /// }
+ /// ```
+ ///
+ ///
+ ///
+ /// ## Support for `validDatatypeLinks`
+ ///
+ /// Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations.
+ ///
+ /// If you'd like us to extend support to more data types or integrations, suggest or vote for this on our <a href="https://portal.productboard.com/codat/5-product-roadmap">Product Roadmap</a>. /// /// public class AccountValidDataTypeLinks { + /// /// Supported `dataTypes` that the record can be linked to. /// [JsonProperty("links")] public List? Links { get; set; } - + /// /// The property from the account that can be linked. /// [JsonProperty("property")] public string? Property { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountingAddressType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountingAddressType.cs new file mode 100755 index 000000000..ff7bf1a37 --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/AccountingAddressType.cs @@ -0,0 +1,55 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Shared +{ + using Newtonsoft.Json; + using System; + + /// + /// The type of the address + /// + public enum AccountingAddressType + { + [JsonProperty("Unknown")] + Unknown, + [JsonProperty("Billing")] + Billing, + [JsonProperty("Delivery")] + Delivery, + } + + public static class AccountingAddressTypeExtension + { + public static string Value(this AccountingAddressType value) + { + return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); + } + + public static AccountingAddressType ToEnum(this string value) + { + foreach(var field in typeof(AccountingAddressType).GetFields()) + { + var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + if (attribute != null && attribute.PropertyName == value) + { + var enumVal = field.GetValue(null); + + if (enumVal is AccountingAddressType) + { + return (AccountingAddressType)enumVal; + } + } + } + + throw new Exception($"Unknown value {value} for enum AccountingAddressType"); + } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Accounts.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Accounts.cs index 363ad791a..1eec001dc 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Accounts.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Accounts.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Accounts { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationAccountingAddress.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Address.cs similarity index 78% rename from sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationAccountingAddress.cs rename to sync-for-payroll/CodatSyncPayroll/Models/Shared/Address.cs index 96d556d31..d80bdbd40 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationAccountingAddress.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Address.cs @@ -8,56 +8,53 @@ // //------------------------------------------------------------------------------ #nullable enable -namespace CodatSyncPayroll.Models.Operations +namespace CodatSyncPayroll.Models.Shared { - using CodatSyncPayroll.Models.Shared; using Newtonsoft.Json; - - public class GetAccountingProfileCompanyInformationAccountingAddress + public class Address { + /// /// City of the customer address. /// [JsonProperty("city")] public string? City { get; set; } - + /// /// Country of the customer address. /// [JsonProperty("country")] public string? Country { get; set; } - + /// /// Line 1 of the customer address. /// [JsonProperty("line1")] public string? Line1 { get; set; } - + /// /// Line 2 of the customer address. /// [JsonProperty("line2")] public string? Line2 { get; set; } - + /// /// Postal code or zip code. /// [JsonProperty("postalCode")] public string? PostalCode { get; set; } - + /// /// Region of the customer address. /// [JsonProperty("region")] public string? Region { get; set; } - + /// /// The type of the address /// [JsonProperty("type")] - public Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType Type { get; set; } = default!; - + public AccountingAddressType Type { get; set; } = default!; } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhook.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhook.cs new file mode 100755 index 000000000..2e3cd5b4d --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhook.cs @@ -0,0 +1,60 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Shared +{ + using Newtonsoft.Json; + + /// + /// Webhook request body for a client that has reached their rate limit. + /// + public class ClientRateLimitReachedWebhook + { + + /// + /// Unique identifier of the webhook event. + /// + [JsonProperty("AlertId")] + public string? AlertId { get; set; } + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + + [JsonProperty("Data")] + public ClientRateLimitReachedWebhookData? Data { get; set; } + + /// + /// A human readable message about the webhook. + /// + [JsonProperty("Message")] + public string? Message { get; set; } + + /// + /// Unique identifier for the rule. + /// + [JsonProperty("RuleId")] + public string? RuleId { get; set; } + + /// + /// The type of rule. + /// + [JsonProperty("RuleType")] + public string? RuleType { get; set; } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhookData.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhookData.cs new file mode 100755 index 000000000..d1de91c5d --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhookData.cs @@ -0,0 +1,51 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Shared +{ + using Newtonsoft.Json; + + public class ClientRateLimitReachedWebhookData + { + + /// + /// The number of available requests per day. + /// + [JsonProperty("DailyQuota")] + public long? DailyQuota { get; set; } + + /// + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> + /// + /// + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + /// + /// + [JsonProperty("ExpiresUtc")] + public string? ExpiresUtc { get; set; } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhook.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhook.cs new file mode 100755 index 000000000..6d5a8df56 --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhook.cs @@ -0,0 +1,60 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Shared +{ + using Newtonsoft.Json; + + /// + /// Webhook request body for a client that has had their rate limit reset. + /// + public class ClientRateLimitResetWebhook + { + + /// + /// Unique identifier of the webhook event. + /// + [JsonProperty("AlertId")] + public string? AlertId { get; set; } + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + + [JsonProperty("Data")] + public ClientRateLimitResetWebhookData? Data { get; set; } + + /// + /// A human readable message about the webhook. + /// + [JsonProperty("Message")] + public string? Message { get; set; } + + /// + /// Unique identifier for the rule. + /// + [JsonProperty("RuleId")] + public string? RuleId { get; set; } + + /// + /// The type of rule. + /// + [JsonProperty("RuleType")] + public string? RuleType { get; set; } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhookData.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhookData.cs new file mode 100755 index 000000000..ef36f7f76 --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhookData.cs @@ -0,0 +1,63 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Shared +{ + using Newtonsoft.Json; + + public class ClientRateLimitResetWebhookData + { + + /// + /// The number of available requests per day. + /// + [JsonProperty("DailyQuota")] + public long? DailyQuota { get; set; } + + /// + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> + /// + /// + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + /// + /// + [JsonProperty("ExpiresUtc")] + public string? ExpiresUtc { get; set; } + + /// + /// Total number of request remaining for your client. + /// + [JsonProperty("QuotaRemaining")] + public long? QuotaRemaining { get; set; } + + /// + /// The reason for your rate limit quota being reset. + /// + [JsonProperty("ResetReason")] + public string? ResetReason { get; set; } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Companies.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Companies.cs index c1872e756..5b18de85a 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Companies.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Companies.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Companies { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Company.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Company.cs index 8b5d5513a..605770ec4 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Company.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Company.cs @@ -14,107 +14,105 @@ namespace CodatSyncPayroll.Models.Shared using System.Collections.Generic; using System; - /// - /// In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data. + /// In Codat, a company represents a business sharing access to their data. Each company can have multiple <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Connection">connections</a> to different data sources such as one connection to <a href="https://docs.codat.io/integrations/accounting/xero/accounting-xero">Xero</a> for accounting data, two connections to <a href="https://docs.codat.io/integrations/banking/plaid/banking-plaid">Plaid</a> for two bank accounts and a connection to <a href="https://docs.codat.io/integrations/commerce/zettle/commerce-zettle">Zettle</a> for POS data.<br/> /// /// - /// - /// Typically each company is one of your customers. - /// + ///
+ /// Typically each company is one of your customers.
+ ///
/// When you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company. /// /// public class Company { + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("created")] public string? Created { get; set; } - + [JsonProperty("createdByUserName")] public string? CreatedByUserName { get; set; } - + [JsonProperty("dataConnections")] public List? DataConnections { get; set; } - + /// /// Additional information about the company. This can be used to store foreign IDs, references, etc. /// [JsonProperty("description")] public string? Description { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("id")] public string Id { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("lastSync")] public string? LastSync { get; set; } - + /// /// The name of the company /// [JsonProperty("name")] public string Name { get; set; } = default!; - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("platform")] public string? Platform { get; set; } - + /// - /// The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. + /// The `redirect` <a href="https://docs.codat.io/auth-flow/authorize-hosted-link">Link URL</a> enabling the customer to start their auth flow journey for the company. /// [JsonProperty("redirect")] public string Redirect { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CompanyInfo.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CompanyInfo.cs new file mode 100755 index 000000000..a4dc92518 --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CompanyInfo.cs @@ -0,0 +1,177 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Shared +{ + using Newtonsoft.Json; + using System.Collections.Generic; + + /// + /// &gt; View the coverage for company info in the &lt;a className=&quot;external&quot; href=&quot;https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&amp;dataType=cashFlowStatement&quot; target=&quot;_blank&quot;&gt;Data coverage explorer&lt;/a&gt;.<br/> + /// + /// + ///
+ /// Company info provides standard details about a linked company such as their address, phone number, and company registration.
+ ///
+ /// > **Company information or companies?**
+ /// >
+ /// > Company information is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. + /// + /// + public class CompanyInfo + { + + /// + /// Identifier or reference for the company in the accounting platform. + /// + [JsonProperty("accountingPlatformRef")] + public string? AccountingPlatformRef { get; set; } + + /// + /// An array of Addresses. + /// + [JsonProperty("addresses")] + public List
? Addresses { get; set; } + + /// + /// Currency set in the accounting platform of the linked company. Used by the currency rate. + /// + [JsonProperty("baseCurrency")] + public string? BaseCurrency { get; set; } + + /// + /// Registered legal name of the linked company. + /// + [JsonProperty("companyLegalName")] + public string? CompanyLegalName { get; set; } + + /// + /// Name of the linked company. + /// + [JsonProperty("companyName")] + public string? CompanyName { get; set; } + + /// + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> + /// + /// + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + /// + /// + [JsonProperty("createdDate")] + public string? CreatedDate { get; set; } + + /// + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> + /// + /// + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + /// + /// + [JsonProperty("financialYearStartDate")] + public string? FinancialYearStartDate { get; set; } + + /// + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> + /// + /// + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + /// + /// + [JsonProperty("ledgerLockDate")] + public string? LedgerLockDate { get; set; } + + /// + /// An array of phone numbers. + /// + [JsonProperty("phoneNumbers")] + public List? PhoneNumbers { get; set; } + + /// + /// Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + /// + [JsonProperty("registrationNumber")] + public string? RegistrationNumber { get; set; } + + /// + /// URL addresses for the accounting source.<br/> + /// + /// + ///
+ /// For example, for Xero integrations two URLs are returned. These have many potential use cases, such as deep linking. + /// + /// + [JsonProperty("sourceUrls")] + public Dictionary? SourceUrls { get; set; } + + /// + /// Company tax number. + /// + [JsonProperty("taxNumber")] + public string? TaxNumber { get; set; } + + /// + /// An array of weblinks. + /// + [JsonProperty("webLinks")] + public List? WebLinks { get; set; } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CompanyRequestBody.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CompanyRequestBody.cs index c46808e07..08b39cfa0 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CompanyRequestBody.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CompanyRequestBody.cs @@ -12,21 +12,19 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class CompanyRequestBody { + /// /// Additional information about the company. This can be used to store foreign IDs, references, etc. /// [JsonProperty("description")] public string? Description { get; set; } - + /// /// Name of company being connected. /// [JsonProperty("name")] public string Name { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connection.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connection.cs index 3343edd2c..ac9b40982 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connection.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connection.cs @@ -13,129 +13,127 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// - /// A connection represents a [company's](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source. + /// A connection represents a <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Company">company&apos;s</a> connection to a data source and allows you to synchronize data (pull and/or push) with that source.<br/> /// /// - /// - /// A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to: - /// - /// - [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection. - /// - [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections. - /// - [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections. - /// Any combination of accounting, banking, and commerce data connections is allowed. - /// - /// Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview). + ///
+ /// A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
+ ///
+ /// - Accounting data - 1 active connection.
+ /// - Banking data - Multiple active connections.
+ /// - Commerce data - Multiple active connections.
+ /// Any combination of accounting, banking, and commerce data connections is allowed.
+ ///
+ /// Before you can use a data connection to pull or push data, the company must grant you access to their business data by linking the connection. /// /// public class Connection { + [JsonProperty("additionalProperties")] public object? AdditionalProperties { get; set; } - + [JsonProperty("connectionInfo")] public Dictionary? ConnectionInfo { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("created")] public string Created { get; set; } = default!; - + [JsonProperty("dataConnectionErrors")] public List? DataConnectionErrors { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("id")] public string Id { get; set; } = default!; - + /// /// A Codat ID representing the integration. /// [JsonProperty("integrationId")] public string IntegrationId { get; set; } = default!; - + /// - /// A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. + /// A unique four-character ID that identifies the platform of the company&apos;s data connection. This ensures continuity if the platform changes its name in the future. /// [JsonProperty("integrationKey")] public string IntegrationKey { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("lastSync")] public string? LastSync { get; set; } - + [JsonProperty("linkUrl")] public string LinkUrl { get; set; } = default!; - + [JsonProperty("platformName")] public string PlatformName { get; set; } = default!; - + /// /// A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. /// [JsonProperty("sourceId")] public string SourceId { get; set; } = default!; - + /// /// The type of platform of the connection. /// [JsonProperty("sourceType")] public ConnectionSourceType SourceType { get; set; } = default!; - + /// /// The current authorization status of the data connection. /// [JsonProperty("status")] public DataConnectionStatus Status { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ConnectionSourceType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ConnectionSourceType.cs index cfbce23a9..2e3ab1798 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ConnectionSourceType.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ConnectionSourceType.cs @@ -13,24 +13,23 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// /// The type of platform of the connection. /// public enum ConnectionSourceType { - [JsonProperty("Accounting")] - Accounting, - [JsonProperty("Banking")] - Banking, - [JsonProperty("Commerce")] - Commerce, - [JsonProperty("Other")] - Other, - [JsonProperty("Unknown")] - Unknown, + [JsonProperty("Accounting")] + Accounting, + [JsonProperty("Banking")] + Banking, + [JsonProperty("Commerce")] + Commerce, + [JsonProperty("Other")] + Other, + [JsonProperty("Unknown")] + Unknown, } - + public static class ConnectionSourceTypeExtension { public static string Value(this ConnectionSourceType value) @@ -57,5 +56,4 @@ public static ConnectionSourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ConnectionSourceType"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connections.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connections.cs index 3bdd9dbad..873bfef1e 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connections.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Connections.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Connections { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateAccountResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateAccountResponse.cs index a75e35568..fbed80520 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateAccountResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateAccountResponse.cs @@ -14,154 +14,152 @@ namespace CodatSyncPayroll.Models.Shared using System.Collections.Generic; using System; - public class CreateAccountResponse { + /// /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } - + /// - /// > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. + /// &gt; **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.<br/> /// /// - /// - /// View the coverage for accounts in the Data coverage explorer. - /// - /// ## Overview - /// - /// Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company. - /// - /// The categories for an account include: - /// * Asset - /// * Expense - /// * Income - /// * Liability - /// * Equity. - /// - /// The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online. - /// - /// At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided. - /// - /// To determine the list of allowed categories for a specific integration, you can: - /// - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model). - /// - Refer to the integration's own documentation. - /// - /// > **Accounts with no category** - /// > - /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`. - /// > - /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. + ///
+ /// View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
+ ///
+ /// ## Overview
+ ///
+ /// Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.
+ ///
+ /// The categories for an account include:
+ /// * Asset
+ /// * Expense
+ /// * Income
+ /// * Liability
+ /// * Equity.
+ ///
+ /// The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.
+ ///
+ /// At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.
+ ///
+ /// To determine the list of allowed categories for a specific integration, you can:
+ /// - Follow our Create, update, delete data guide and use the Get create account model.
+ /// - Refer to the integration's own documentation.
+ ///
+ /// > **Accounts with no category**
+ /// >
+ /// > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
+ /// >
+ /// > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. /// /// [JsonProperty("data")] public Account? Data { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; - + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } - + /// /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. /// [JsonProperty("pushOperationKey")] public string PushOperationKey { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; - + /// - /// The status of the push operation. + /// The current status of the push operation. /// [JsonProperty("status")] public PushOperationStatus Status { get; set; } = default!; - + [JsonProperty("statusCode")] public long StatusCode { get; set; } = default!; - + [JsonProperty("timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("timeoutInSeconds")] public int? TimeoutInSeconds { get; set; } - + /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// [JsonProperty("validation")] public Validation? Validation { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalEntryResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalEntryResponse.cs index c91c7e4d0..78ccdbd22 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalEntryResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalEntryResponse.cs @@ -14,148 +14,146 @@ namespace CodatSyncPayroll.Models.Shared using System.Collections.Generic; using System; - public class CreateJournalEntryResponse { + /// /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } - + /// - /// > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type + /// &gt; **Language tip:** For the top-level record of a company&apos;s financial transactions, refer to the <a href="https://docs.codat.io/accounting-api#/schemas/Journal">Journals</a> data type<br/> /// /// - /// - /// > View the coverage for journal entries in the Data coverage explorer. - /// - /// ## Overview - /// - /// A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. - /// - /// A journal entry line item is a single transaction line on the journal entry. For example: - /// - /// - When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. - /// - When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue. - /// - /// In Codat a journal entry contains details of: - /// - /// - The date on which the entry was created and posted. - /// - Itemised lines, including amounts and currency. - /// - A reference to the associated accounts. - /// - A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. - /// - /// > **Pushing journal entries** - /// > Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. + ///
+ /// > View the coverage for journal entries in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries" target="_blank">Data coverage explorer</a>.
+ ///
+ /// ## Overview
+ ///
+ /// A journal entry report shows the entries made in a company's general ledger, or accounts, when transactions are approved. The journal line items for each journal entry should balance.
+ ///
+ /// A journal entry line item is a single transaction line on the journal entry. For example:
+ ///
+ /// - When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items.
+ /// - When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue.
+ ///
+ /// In Codat a journal entry contains details of:
+ ///
+ /// - The date on which the entry was created and posted.
+ /// - Itemised lines, including amounts and currency.
+ /// - A reference to the associated accounts.
+ /// - A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger.
+ ///
+ /// > **Pushing journal entries**
+ /// > Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. /// /// [JsonProperty("data")] public JournalEntry? Data { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; - + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } - + /// /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. /// [JsonProperty("pushOperationKey")] public string PushOperationKey { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; - + /// - /// The status of the push operation. + /// The current status of the push operation. /// [JsonProperty("status")] public PushOperationStatus Status { get; set; } = default!; - + [JsonProperty("statusCode")] public long StatusCode { get; set; } = default!; - + [JsonProperty("timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("timeoutInSeconds")] public int? TimeoutInSeconds { get; set; } - + /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// [JsonProperty("validation")] public Validation? Validation { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalResponse.cs index e07ba641f..02471fc9d 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalResponse.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/CreateJournalResponse.cs @@ -14,149 +14,147 @@ namespace CodatSyncPayroll.Models.Shared using System.Collections.Generic; using System; - public class CreateJournalResponse { + /// /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } - + /// - /// > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type + /// &gt; **Language tip:** For line items, or individual transactions, of a company&apos;s financial documents, refer to the <a href="https://docs.codat.io/accounting-api#/schemas/JournalEntry">Journal entries</a> data type<br/> /// /// - /// - /// > View the coverage for journals in the Data coverage explorer. - /// - /// ## Overview - /// - /// In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. - /// - /// When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. - /// - /// Such journals can be divided into two categories: - /// - /// - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal. - /// - General journals: journals used to record transactions that fall outside the scope of the special journals. - /// - /// Multiple journals or subjournals are used in the following Codat integrations: - /// - /// - [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory) - /// - [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory) - /// - [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional) - /// - /// > When pushing journal entries to an accounting platform that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object. + ///
+ /// > View the coverage for journals in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals" target="_blank">Data coverage explorer</a>.
+ ///
+ /// ## Overview
+ ///
+ /// In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate journal entry. These entries are used to create the general ledger, which is then used to create the financial statements of a business.
+ ///
+ /// When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries.
+ ///
+ /// Such journals can be divided into two categories:
+ ///
+ /// - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal.
+ /// - General journals: journals used to record transactions that fall outside the scope of the special journals.
+ ///
+ /// Multiple journals or subjournals are used in the following Codat integrations:
+ ///
+ /// - Sage Intacct (mandatory)
+ /// - Exact Online (mandatory)
+ /// - Oracle NetSuite (optional)
+ ///
+ /// > When pushing journal entries to an accounting platform that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object.
/// /// /// [JsonProperty("data")] public Journal? Data { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; - + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } - + /// /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. /// [JsonProperty("pushOperationKey")] public string PushOperationKey { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; - + /// - /// The status of the push operation. + /// The current status of the push operation. /// [JsonProperty("status")] public PushOperationStatus Status { get; set; } = default!; - + [JsonProperty("statusCode")] public long StatusCode { get; set; } = default!; - + [JsonProperty("timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("timeoutInSeconds")] public int? TimeoutInSeconds { get; set; } - + /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// [JsonProperty("validation")] public Validation? Validation { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionError.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionError.cs index cbac5ffb8..805c4e329 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionError.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionError.cs @@ -12,45 +12,43 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class DataConnectionError { + [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("erroredOnUtc")] public string? ErroredOnUtc { get; set; } - + [JsonProperty("statusCode")] public string? StatusCode { get; set; } - + [JsonProperty("statusText")] public string? StatusText { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionStatus.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionStatus.cs index 7302ad4f3..c38241c62 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionStatus.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataConnectionStatus.cs @@ -13,22 +13,21 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// /// The current authorization status of the data connection. /// public enum DataConnectionStatus { - [JsonProperty("PendingAuth")] - PendingAuth, - [JsonProperty("Linked")] - Linked, - [JsonProperty("Unlinked")] - Unlinked, - [JsonProperty("Deauthorized")] - Deauthorized, + [JsonProperty("PendingAuth")] + PendingAuth, + [JsonProperty("Linked")] + Linked, + [JsonProperty("Unlinked")] + Unlinked, + [JsonProperty("Deauthorized")] + Deauthorized, } - + public static class DataConnectionStatusExtension { public static string Value(this DataConnectionStatus value) @@ -55,5 +54,4 @@ public static DataConnectionStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataConnectionStatus"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataStatus.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataStatus.cs index 00f564429..62b8a0a6c 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataStatus.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataStatus.cs @@ -12,51 +12,49 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// /// Describes the state of data in the Codat cache for a company and data type /// public class DataStatus { + [JsonProperty("currentStatus")] public string CurrentStatus { get; set; } = default!; - + [JsonProperty("dataType")] public string DataType { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("lastSuccessfulSync")] public string LastSuccessfulSync { get; set; } = default!; - + [JsonProperty("latestSuccessfulSyncId")] public string? LatestSuccessfulSyncId { get; set; } - + [JsonProperty("latestSyncId")] public string? LatestSyncId { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataType.cs index ae274f345..29be6c7d6 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataType.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/DataType.cs @@ -13,98 +13,97 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// /// Available Data types /// public enum DataType { - [JsonProperty("accountTransactions")] - AccountTransactions, - [JsonProperty("balanceSheet")] - BalanceSheet, - [JsonProperty("bankAccounts")] - BankAccounts, - [JsonProperty("bankTransactions")] - BankTransactions, - [JsonProperty("billCreditNotes")] - BillCreditNotes, - [JsonProperty("billPayments")] - BillPayments, - [JsonProperty("bills")] - Bills, - [JsonProperty("cashFlowStatement")] - CashFlowStatement, - [JsonProperty("chartOfAccounts")] - ChartOfAccounts, - [JsonProperty("company")] - Company, - [JsonProperty("creditNotes")] - CreditNotes, - [JsonProperty("customers")] - Customers, - [JsonProperty("directCosts")] - DirectCosts, - [JsonProperty("directIncomes")] - DirectIncomes, - [JsonProperty("invoices")] - Invoices, - [JsonProperty("items")] - Items, - [JsonProperty("journalEntries")] - JournalEntries, - [JsonProperty("journals")] - Journals, - [JsonProperty("paymentMethods")] - PaymentMethods, - [JsonProperty("payments")] - Payments, - [JsonProperty("profitAndLoss")] - ProfitAndLoss, - [JsonProperty("purchaseOrders")] - PurchaseOrders, - [JsonProperty("salesOrders")] - SalesOrders, - [JsonProperty("suppliers")] - Suppliers, - [JsonProperty("taxRates")] - TaxRates, - [JsonProperty("trackingCategories")] - TrackingCategories, - [JsonProperty("transfers")] - Transfers, - [JsonProperty("banking-accountBalances")] - BankingAccountBalances, - [JsonProperty("banking-accounts")] - BankingAccounts, - [JsonProperty("banking-transactionCategories")] - BankingTransactionCategories, - [JsonProperty("banking-transactions")] - BankingTransactions, - [JsonProperty("commerce-companyInfo")] - CommerceCompanyInfo, - [JsonProperty("commerce-customers")] - CommerceCustomers, - [JsonProperty("commerce-disputes")] - CommerceDisputes, - [JsonProperty("commerce-locations")] - CommerceLocations, - [JsonProperty("commerce-orders")] - CommerceOrders, - [JsonProperty("commerce-paymentMethods")] - CommercePaymentMethods, - [JsonProperty("commerce-payments")] - CommercePayments, - [JsonProperty("commerce-productCategories")] - CommerceProductCategories, - [JsonProperty("commerce-products")] - CommerceProducts, - [JsonProperty("commerce-taxComponents")] - CommerceTaxComponents, - [JsonProperty("commerce-transactions")] - CommerceTransactions, + [JsonProperty("accountTransactions")] + AccountTransactions, + [JsonProperty("balanceSheet")] + BalanceSheet, + [JsonProperty("bankAccounts")] + BankAccounts, + [JsonProperty("bankTransactions")] + BankTransactions, + [JsonProperty("billCreditNotes")] + BillCreditNotes, + [JsonProperty("billPayments")] + BillPayments, + [JsonProperty("bills")] + Bills, + [JsonProperty("cashFlowStatement")] + CashFlowStatement, + [JsonProperty("chartOfAccounts")] + ChartOfAccounts, + [JsonProperty("company")] + Company, + [JsonProperty("creditNotes")] + CreditNotes, + [JsonProperty("customers")] + Customers, + [JsonProperty("directCosts")] + DirectCosts, + [JsonProperty("directIncomes")] + DirectIncomes, + [JsonProperty("invoices")] + Invoices, + [JsonProperty("items")] + Items, + [JsonProperty("journalEntries")] + JournalEntries, + [JsonProperty("journals")] + Journals, + [JsonProperty("paymentMethods")] + PaymentMethods, + [JsonProperty("payments")] + Payments, + [JsonProperty("profitAndLoss")] + ProfitAndLoss, + [JsonProperty("purchaseOrders")] + PurchaseOrders, + [JsonProperty("salesOrders")] + SalesOrders, + [JsonProperty("suppliers")] + Suppliers, + [JsonProperty("taxRates")] + TaxRates, + [JsonProperty("trackingCategories")] + TrackingCategories, + [JsonProperty("transfers")] + Transfers, + [JsonProperty("banking-accountBalances")] + BankingAccountBalances, + [JsonProperty("banking-accounts")] + BankingAccounts, + [JsonProperty("banking-transactionCategories")] + BankingTransactionCategories, + [JsonProperty("banking-transactions")] + BankingTransactions, + [JsonProperty("commerce-companyInfo")] + CommerceCompanyInfo, + [JsonProperty("commerce-customers")] + CommerceCustomers, + [JsonProperty("commerce-disputes")] + CommerceDisputes, + [JsonProperty("commerce-locations")] + CommerceLocations, + [JsonProperty("commerce-orders")] + CommerceOrders, + [JsonProperty("commerce-paymentMethods")] + CommercePaymentMethods, + [JsonProperty("commerce-payments")] + CommercePayments, + [JsonProperty("commerce-productCategories")] + CommerceProductCategories, + [JsonProperty("commerce-products")] + CommerceProducts, + [JsonProperty("commerce-taxComponents")] + CommerceTaxComponents, + [JsonProperty("commerce-transactions")] + CommerceTransactions, } - + public static class DataTypeExtension { public static string Value(this DataType value) @@ -131,5 +130,4 @@ public static DataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataType"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ErrorMessage.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ErrorMessage.cs index 536fbbdaf..3712ddc28 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ErrorMessage.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ErrorMessage.cs @@ -12,27 +12,25 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class ErrorMessage { + [JsonProperty("canBeRetried")] public string? CanBeRetried { get; set; } - + [JsonProperty("correlationId")] public string? CorrelationId { get; set; } - + [JsonProperty("detailedErrorCode")] public long? DetailedErrorCode { get; set; } - + [JsonProperty("error")] public string? Error { get; set; } - + [JsonProperty("service")] public string? Service { get; set; } - + [JsonProperty("statusCode")] public long? StatusCode { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/HalRef.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/HalRef.cs index f9b6311b0..97dacc8e5 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/HalRef.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/HalRef.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class HalRef { + [JsonProperty("href")] public string? Href { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journal.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journal.cs index d22a19b72..0b5e95035 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journal.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journal.cs @@ -12,90 +12,90 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// - /// > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type + /// &gt; **Language tip:** For line items, or individual transactions, of a company&apos;s financial documents, refer to the <a href="https://docs.codat.io/accounting-api#/schemas/JournalEntry">Journal entries</a> data type<br/> /// /// - /// - /// > View the coverage for journals in the Data coverage explorer. - /// - /// ## Overview - /// - /// In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. - /// - /// When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. - /// - /// Such journals can be divided into two categories: - /// - /// - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal. - /// - General journals: journals used to record transactions that fall outside the scope of the special journals. - /// - /// Multiple journals or subjournals are used in the following Codat integrations: - /// - /// - [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory) - /// - [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory) - /// - [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional) - /// - /// > When pushing journal entries to an accounting platform that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object. + ///
+ /// > View the coverage for journals in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals" target="_blank">Data coverage explorer</a>.
+ ///
+ /// ## Overview
+ ///
+ /// In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate journal entry. These entries are used to create the general ledger, which is then used to create the financial statements of a business.
+ ///
+ /// When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries.
+ ///
+ /// Such journals can be divided into two categories:
+ ///
+ /// - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal.
+ /// - General journals: journals used to record transactions that fall outside the scope of the special journals.
+ ///
+ /// Multiple journals or subjournals are used in the following Codat integrations:
+ ///
+ /// - Sage Intacct (mandatory)
+ /// - Exact Online (mandatory)
+ /// - Oracle NetSuite (optional)
+ ///
+ /// > When pushing journal entries to an accounting platform that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object.
/// /// /// public class Journal { + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("createdOn")] public string? CreatedOn { get; set; } - + /// /// If the journal has child journals, this value is true. If it doesn’t, it is false. /// [JsonProperty("hasChildren")] public bool? HasChildren { get; set; } - + /// /// Journal ID. /// [JsonProperty("id")] public string? Id { get; set; } - + /// /// Native journal number or code. /// [JsonProperty("journalCode")] public string? JournalCode { get; set; } - + [JsonProperty("metadata")] public Metadata? Metadata { get; set; } - + [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } - + /// - /// Journal name. + /// Journal name.<br/> /// /// /// The maximum length for a journal name is 256 characters. All characters above that number will be truncated. @@ -103,9 +103,9 @@ public class Journal /// [JsonProperty("name")] public string? Name { get; set; } - + /// - /// Parent journal ID. + /// Parent journal ID.<br/> /// /// /// If the journal is a parent journal, this value is not present. @@ -113,22 +113,20 @@ public class Journal /// [JsonProperty("parentId")] public string? ParentId { get; set; } - + [JsonProperty("sourceModifiedDate")] public string? SourceModifiedDate { get; set; } - + /// /// Current journal status. /// [JsonProperty("status")] public JournalStatus? Status { get; set; } - + /// /// The type of the journal. /// [JsonProperty("type")] public string? Type { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntries.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntries.cs index ff155b723..d64038999 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntries.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntries.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class JournalEntries { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntry.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntry.cs index 02183bc82..9ac334dc8 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntry.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntry.cs @@ -13,172 +13,170 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// - /// > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type + /// &gt; **Language tip:** For the top-level record of a company&apos;s financial transactions, refer to the <a href="https://docs.codat.io/accounting-api#/schemas/Journal">Journals</a> data type<br/> /// /// - /// - /// > View the coverage for journal entries in the Data coverage explorer. - /// - /// ## Overview - /// - /// A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. - /// - /// A journal entry line item is a single transaction line on the journal entry. For example: - /// - /// - When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. - /// - When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue. - /// - /// In Codat a journal entry contains details of: - /// - /// - The date on which the entry was created and posted. - /// - Itemised lines, including amounts and currency. - /// - A reference to the associated accounts. - /// - A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. - /// - /// > **Pushing journal entries** - /// > Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. + ///
+ /// > View the coverage for journal entries in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries" target="_blank">Data coverage explorer</a>.
+ ///
+ /// ## Overview
+ ///
+ /// A journal entry report shows the entries made in a company's general ledger, or accounts, when transactions are approved. The journal line items for each journal entry should balance.
+ ///
+ /// A journal entry line item is a single transaction line on the journal entry. For example:
+ ///
+ /// - When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items.
+ /// - When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue.
+ ///
+ /// In Codat a journal entry contains details of:
+ ///
+ /// - The date on which the entry was created and posted.
+ /// - Itemised lines, including amounts and currency.
+ /// - A reference to the associated accounts.
+ /// - A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger.
+ ///
+ /// > **Pushing journal entries**
+ /// > Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. /// /// public class JournalEntry { + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("createdOn")] public string? CreatedOn { get; set; } - + /// /// Optional description of the journal entry. /// [JsonProperty("description")] public string? Description { get; set; } - + /// /// Unique identifier of the journal entry for the company in the accounting platform. /// [JsonProperty("id")] public string? Id { get; set; } - + /// /// An array of journal lines. /// [JsonProperty("journalLines")] public List? JournalLines { get; set; } - + /// /// Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). /// [JsonProperty("journalRef")] public JournalRef? JournalRef { get; set; } - + [JsonProperty("metadata")] public Metadata? Metadata { get; set; } - + [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("postedOn")] public string? PostedOn { get; set; } - + /// - /// Links the current record to the underlying record or data type that created it. + /// Links the current record to the underlying record or data type that created it. <br/> /// /// - /// + ///
/// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. /// /// [JsonProperty("recordRef")] public JournalEntryRecordReference? RecordRef { get; set; } - + [JsonProperty("sourceModifiedDate")] public string? SourceModifiedDate { get; set; } - + /// - /// Supplemental data is additional data you can include in our standard data types. + /// Supplemental data is additional data you can include in our standard data types. <br/> /// /// - /// - /// It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + ///
+ /// It is referenced as a configured dynamic key value pair that is unique to the accounting platform. Learn more about supplemental data. /// /// [JsonProperty("supplementalData")] public JournalEntrySupplementalData? SupplementalData { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("updatedOn")] public string? UpdatedOn { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntryRecordReference.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntryRecordReference.cs index 2ee61a188..c5a9a3716 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntryRecordReference.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntryRecordReference.cs @@ -12,29 +12,27 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// - /// Links the current record to the underlying record or data type that created it. + /// Links the current record to the underlying record or data type that created it. <br/> /// /// - /// + ///
/// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. /// /// public class JournalEntryRecordReference { + /// - /// Allowed name of the 'dataType'. + /// Allowed name of the &apos;dataType&apos;. /// [JsonProperty("dataType")] public string? DataType { get; set; } - + /// - /// 'id' of the underlying record or data type. + /// &apos;id&apos; of the underlying record or data type. /// [JsonProperty("id")] public string? Id { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntrySupplementalData.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntrySupplementalData.cs index ca0814895..2d88a38fe 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntrySupplementalData.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalEntrySupplementalData.cs @@ -13,20 +13,18 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// - /// Supplemental data is additional data you can include in our standard data types. + /// Supplemental data is additional data you can include in our standard data types. <br/> /// /// - /// - /// It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + ///
+ /// It is referenced as a configured dynamic key value pair that is unique to the accounting platform. Learn more about supplemental data. /// /// public class JournalEntrySupplementalData { + [JsonProperty("content")] public Dictionary>? Content { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLine.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLine.cs index 4856795c9..3226ccb79 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLine.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLine.cs @@ -12,39 +12,37 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class JournalLine { + /// /// Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. /// [JsonProperty("accountRef")] public AccountRef? AccountRef { get; set; } - + /// /// Currency for the journal line item. /// [JsonProperty("currency")] public string? Currency { get; set; } - + /// /// Description of the journal line item. /// [JsonProperty("description")] public string? Description { get; set; } - + /// /// Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative. /// [JsonProperty("netAmount")] public decimal NetAmount { get; set; } = default!; - + /// /// List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.) /// [JsonProperty("tracking")] public JournalLineTracking? Tracking { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLineTracking.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLineTracking.cs index 220ffb172..bdf1e8019 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLineTracking.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalLineTracking.cs @@ -13,15 +13,13 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// /// List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.) /// public class JournalLineTracking { + [JsonProperty("recordRefs")] public List? RecordRefs { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalRef.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalRef.cs index bc54b99ea..d8950c9f3 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalRef.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalRef.cs @@ -12,24 +12,22 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// /// Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). /// public class JournalRef { + /// /// GUID of the underlying journal. /// [JsonProperty("id")] public string Id { get; set; } = default!; - + /// /// Name of journal /// [JsonProperty("name")] public string? Name { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalStatus.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalStatus.cs index 5fabc08d8..625a9a4b6 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalStatus.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/JournalStatus.cs @@ -13,20 +13,19 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// /// Current journal status. /// public enum JournalStatus { - [JsonProperty("Unknown")] - Unknown, - [JsonProperty("Active")] - Active, - [JsonProperty("Archived")] - Archived, + [JsonProperty("Unknown")] + Unknown, + [JsonProperty("Active")] + Active, + [JsonProperty("Archived")] + Archived, } - + public static class JournalStatusExtension { public static string Value(this JournalStatus value) @@ -53,5 +52,4 @@ public static JournalStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum JournalStatus"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journals.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journals.cs index da6043925..06f105476 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journals.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Journals.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Journals { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Links.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Links.cs index 9cd587e37..9edd7637a 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Links.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Links.cs @@ -12,21 +12,19 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class Links { + [JsonProperty("current")] public HalRef Current { get; set; } = default!; - + [JsonProperty("next")] public HalRef? Next { get; set; } - + [JsonProperty("previous")] public HalRef? Previous { get; set; } - + [JsonProperty("self")] public HalRef Self { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Metadata.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Metadata.cs index 16c505fd2..b8cfe6745 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Metadata.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Metadata.cs @@ -12,15 +12,13 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class Metadata { + /// /// Indicates whether the record has been deleted in the third-party system this record originated from. /// [JsonProperty("isDeleted")] public bool? IsDeleted { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.cs deleted file mode 100755 index fe7e0303d..000000000 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.cs +++ /dev/null @@ -1,57 +0,0 @@ - -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace CodatSyncPayroll.Models.Shared -{ - using Newtonsoft.Json; - using System; - - - /// - /// The type of the address - /// - public enum Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType - { - [JsonProperty("Unknown")] - Unknown, - [JsonProperty("Billing")] - Billing, - [JsonProperty("Delivery")] - Delivery, - } - - public static class Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressTypeExtension - { - public static string Value(this Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType value) - { - return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); - } - - public static Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType ToEnum(this string value) - { - foreach(var field in typeof(Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType).GetFields()) - { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; - if (attribute != null && attribute.PropertyName == value) - { - var enumVal = field.GetValue(null); - - if (enumVal is Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType) - { - return (Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType)enumVal; - } - } - } - - throw new Exception($"Unknown value {value} for enum Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType"); - } - } - -} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.cs deleted file mode 100755 index 390b42a69..000000000 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.cs +++ /dev/null @@ -1,61 +0,0 @@ - -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace CodatSyncPayroll.Models.Shared -{ - using Newtonsoft.Json; - using System; - - - /// - /// The type of phone number - /// - public enum Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType - { - [JsonProperty("Primary")] - Primary, - [JsonProperty("Landline")] - Landline, - [JsonProperty("Mobile")] - Mobile, - [JsonProperty("Fax")] - Fax, - [JsonProperty("Unknown")] - Unknown, - } - - public static class Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberTypeExtension - { - public static string Value(this Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType value) - { - return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); - } - - public static Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType ToEnum(this string value) - { - foreach(var field in typeof(Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType).GetFields()) - { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; - if (attribute != null && attribute.PropertyName == value) - { - var enumVal = field.GetValue(null); - - if (enumVal is Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType) - { - return (Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType)enumVal; - } - } - } - - throw new Exception($"Unknown value {value} for enum Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType"); - } - } - -} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationPhone.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PhoneNumber.cs similarity index 66% rename from sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationPhone.cs rename to sync-for-payroll/CodatSyncPayroll/Models/Shared/PhoneNumber.cs index e3489c728..7427c2c84 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationPhone.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PhoneNumber.cs @@ -8,26 +8,23 @@ // //------------------------------------------------------------------------------ #nullable enable -namespace CodatSyncPayroll.Models.Operations +namespace CodatSyncPayroll.Models.Shared { - using CodatSyncPayroll.Models.Shared; using Newtonsoft.Json; - - public class GetAccountingProfileCompanyInformationPhone + public class PhoneNumber { + /// /// A phone number. /// [JsonProperty("number")] public string Number { get; set; } = default!; - + /// /// The type of phone number /// [JsonProperty("type")] - public Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType Type { get; set; } = default!; - + public PhoneNumberType Type { get; set; } = default!; } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PhoneNumberType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PhoneNumberType.cs new file mode 100755 index 000000000..cdde9d1c8 --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PhoneNumberType.cs @@ -0,0 +1,59 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Shared +{ + using Newtonsoft.Json; + using System; + + /// + /// The type of phone number + /// + public enum PhoneNumberType + { + [JsonProperty("Primary")] + Primary, + [JsonProperty("Landline")] + Landline, + [JsonProperty("Mobile")] + Mobile, + [JsonProperty("Fax")] + Fax, + [JsonProperty("Unknown")] + Unknown, + } + + public static class PhoneNumberTypeExtension + { + public static string Value(this PhoneNumberType value) + { + return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); + } + + public static PhoneNumberType ToEnum(this string value) + { + foreach(var field in typeof(PhoneNumberType).GetFields()) + { + var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + if (attribute != null && attribute.PropertyName == value) + { + var enumVal = field.GetValue(null); + + if (enumVal is PhoneNumberType) + { + return (PhoneNumberType)enumVal; + } + } + } + + throw new Exception($"Unknown value {value} for enum PhoneNumberType"); + } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperation.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperation.cs index e74a99073..36ccb2b07 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperation.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperation.cs @@ -12,9 +12,8 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// - /// Information about a queued, in progress or completed pull operation. + /// Information about a queued, in progress or completed pull operation.<br/> /// /// /// *Formally called `dataset`* @@ -22,57 +21,56 @@ namespace CodatSyncPayroll.Models.Shared /// public class PullOperation { + [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; - + [JsonProperty("connectionId")] public string ConnectionId { get; set; } = default!; - + [JsonProperty("dataType")] public string DataType { get; set; } = default!; - + [JsonProperty("id")] public string Id { get; set; } = default!; - + [JsonProperty("isCompleted")] public bool IsCompleted { get; set; } = default!; - + [JsonProperty("isErrored")] public bool IsErrored { get; set; } = default!; - + [JsonProperty("progress")] public long Progress { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("requested")] public string Requested { get; set; } = default!; - + [JsonProperty("status")] public PullOperationStatus Status { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperationStatus.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperationStatus.cs index 2f49a8d56..e40f8b384 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperationStatus.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperationStatus.cs @@ -13,57 +13,56 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - public enum PullOperationStatus { - [JsonProperty("Initial")] - Initial, - [JsonProperty("Queued")] - Queued, - [JsonProperty("Fetching")] - Fetching, - [JsonProperty("MapQueued")] - MapQueued, - [JsonProperty("Mapping")] - Mapping, - [JsonProperty("Complete")] - Complete, - [JsonProperty("FetchError")] - FetchError, - [JsonProperty("MapError")] - MapError, - [JsonProperty("InternalError")] - InternalError, - [JsonProperty("ProcessingQueued")] - ProcessingQueued, - [JsonProperty("Processing")] - Processing, - [JsonProperty("ProcessingError")] - ProcessingError, - [JsonProperty("ValidationQueued")] - ValidationQueued, - [JsonProperty("Validating")] - Validating, - [JsonProperty("ValidationError")] - ValidationError, - [JsonProperty("AuthError")] - AuthError, - [JsonProperty("Cancelled")] - Cancelled, - [JsonProperty("Routing")] - Routing, - [JsonProperty("RoutingError")] - RoutingError, - [JsonProperty("NotSupported")] - NotSupported, - [JsonProperty("RateLimitError")] - RateLimitError, - [JsonProperty("PermissionsError")] - PermissionsError, - [JsonProperty("PrerequisiteNotMet")] - PrerequisiteNotMet, + [JsonProperty("Initial")] + Initial, + [JsonProperty("Queued")] + Queued, + [JsonProperty("Fetching")] + Fetching, + [JsonProperty("MapQueued")] + MapQueued, + [JsonProperty("Mapping")] + Mapping, + [JsonProperty("Complete")] + Complete, + [JsonProperty("FetchError")] + FetchError, + [JsonProperty("MapError")] + MapError, + [JsonProperty("InternalError")] + InternalError, + [JsonProperty("ProcessingQueued")] + ProcessingQueued, + [JsonProperty("Processing")] + Processing, + [JsonProperty("ProcessingError")] + ProcessingError, + [JsonProperty("ValidationQueued")] + ValidationQueued, + [JsonProperty("Validating")] + Validating, + [JsonProperty("ValidationError")] + ValidationError, + [JsonProperty("AuthError")] + AuthError, + [JsonProperty("Cancelled")] + Cancelled, + [JsonProperty("Routing")] + Routing, + [JsonProperty("RoutingError")] + RoutingError, + [JsonProperty("NotSupported")] + NotSupported, + [JsonProperty("RateLimitError")] + RateLimitError, + [JsonProperty("PermissionsError")] + PermissionsError, + [JsonProperty("PrerequisiteNotMet")] + PrerequisiteNotMet, } - + public static class PullOperationStatusExtension { public static string Value(this PullOperationStatus value) @@ -90,5 +89,4 @@ public static PullOperationStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PullOperationStatus"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperations.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperations.cs index e8b718800..ebeb26708 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperations.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PullOperations.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PullOperations { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushChangeType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushChangeType.cs index a6e20b3f3..f491b20fb 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushChangeType.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushChangeType.cs @@ -13,21 +13,20 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - public enum PushChangeType { - [JsonProperty("Unknown")] - Unknown, - [JsonProperty("Created")] - Created, - [JsonProperty("Modified")] - Modified, - [JsonProperty("Deleted")] - Deleted, - [JsonProperty("AttachmentUploaded")] - AttachmentUploaded, + [JsonProperty("Unknown")] + Unknown, + [JsonProperty("Created")] + Created, + [JsonProperty("Modified")] + Modified, + [JsonProperty("Deleted")] + Deleted, + [JsonProperty("AttachmentUploaded")] + AttachmentUploaded, } - + public static class PushChangeTypeExtension { public static string Value(this PushChangeType value) @@ -54,5 +53,4 @@ public static PushChangeType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushChangeType"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushFieldValidation.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushFieldValidation.cs index 2c6b5e4db..244058f6c 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushFieldValidation.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushFieldValidation.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class PushFieldValidation { + [JsonProperty("details")] public string Details { get; set; } = default!; - + [JsonProperty("field")] public string? Field { get; set; } - + [JsonProperty("ref")] public string? Ref { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperation.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperation.cs index 6dbf6e792..9352c492a 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperation.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperation.cs @@ -14,118 +14,116 @@ namespace CodatSyncPayroll.Models.Shared using System.Collections.Generic; using System; - public class PushOperation { + /// /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; - + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } - + /// /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. /// [JsonProperty("pushOperationKey")] public string PushOperationKey { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. /// /// [JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; - + /// - /// The status of the push operation. + /// The current status of the push operation. /// [JsonProperty("status")] public PushOperationStatus Status { get; set; } = default!; - + [JsonProperty("statusCode")] public long StatusCode { get; set; } = default!; - + [JsonProperty("timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("timeoutInSeconds")] public int? TimeoutInSeconds { get; set; } - + /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// [JsonProperty("validation")] public Validation? Validation { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationChange.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationChange.cs index fbdad75e0..8e7e4fe3f 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationChange.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationChange.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class PushOperationChange { + [JsonProperty("attachmentId")] public string? AttachmentId { get; set; } - + [JsonProperty("recordRef")] public PushOperationRef? RecordRef { get; set; } - + [JsonProperty("type")] public PushChangeType? Type { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationRef.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationRef.cs index 131f238ce..62e48768c 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationRef.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationRef.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class PushOperationRef { + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("id")] public string? Id { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationStatus.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationStatus.cs index afd026a1e..ff5182781 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationStatus.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperationStatus.cs @@ -13,22 +13,21 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// - /// The status of the push operation. + /// The current status of the push operation. /// public enum PushOperationStatus { - [JsonProperty("Pending")] - Pending, - [JsonProperty("Failed")] - Failed, - [JsonProperty("Success")] - Success, - [JsonProperty("TimedOut")] - TimedOut, + [JsonProperty("Pending")] + Pending, + [JsonProperty("Failed")] + Failed, + [JsonProperty("Success")] + Success, + [JsonProperty("TimedOut")] + TimedOut, } - + public static class PushOperationStatusExtension { public static string Value(this PushOperationStatus value) @@ -55,5 +54,4 @@ public static PushOperationStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOperationStatus"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperations.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperations.cs index fa73ab141..0415898b7 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperations.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOperations.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushOperations { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOption.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOption.cs index c78981f5b..52abbb613 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOption.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOption.cs @@ -13,30 +13,28 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushOption { + [JsonProperty("description")] public string? Description { get; set; } - + [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; - + [JsonProperty("options")] public List? Options { get; set; } - + [JsonProperty("properties")] public Dictionary? Properties { get; set; } - + [JsonProperty("required")] public bool Required { get; set; } = default!; - + [JsonProperty("type")] public PushOptionType Type { get; set; } = default!; - + [JsonProperty("validation")] public PushValidationInfo? Validation { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionChoice.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionChoice.cs index 24a30efa2..db54f4527 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionChoice.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionChoice.cs @@ -12,27 +12,25 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class PushOptionChoice { + [JsonProperty("description")] public string? Description { get; set; } - + [JsonProperty("displayName")] public string? DisplayName { get; set; } - + [JsonProperty("required")] public bool? Required { get; set; } - + [JsonProperty("type")] public PushOptionType? Type { get; set; } - + /// /// Allowed value for field. /// [JsonProperty("value")] public string? Value { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionProperty.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionProperty.cs index 7652a4d3f..cedf8324e 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionProperty.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionProperty.cs @@ -13,30 +13,28 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushOptionProperty { + [JsonProperty("description")] public string Description { get; set; } = default!; - + [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; - + [JsonProperty("options")] public List? Options { get; set; } - + [JsonProperty("properties")] public Dictionary? Properties { get; set; } - + [JsonProperty("required")] public bool Required { get; set; } = default!; - + [JsonProperty("type")] public PushOptionType Type { get; set; } = default!; - + [JsonProperty("validation")] public PushValidationInfo? Validation { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionType.cs index 9d4183ec4..f18f6a346 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionType.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushOptionType.cs @@ -13,27 +13,26 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - public enum PushOptionType { - [JsonProperty("Array")] - Array, - [JsonProperty("Object")] - Object, - [JsonProperty("String")] - String, - [JsonProperty("Number")] - Number, - [JsonProperty("Boolean")] - Boolean, - [JsonProperty("DateTime")] - DateTime, - [JsonProperty("File")] - File, - [JsonProperty("MultiPart")] - MultiPart, + [JsonProperty("Array")] + Array, + [JsonProperty("Object")] + Object, + [JsonProperty("String")] + String, + [JsonProperty("Number")] + Number, + [JsonProperty("Boolean")] + Boolean, + [JsonProperty("DateTime")] + DateTime, + [JsonProperty("File")] + File, + [JsonProperty("MultiPart")] + MultiPart, } - + public static class PushOptionTypeExtension { public static string Value(this PushOptionType value) @@ -60,5 +59,4 @@ public static PushOptionType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOptionType"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushValidationInfo.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushValidationInfo.cs index 45d4d142d..4ea3e31b9 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushValidationInfo.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/PushValidationInfo.cs @@ -13,15 +13,13 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushValidationInfo { + [JsonProperty("information")] public List? Information { get; set; } - + [JsonProperty("warnings")] public List? Warnings { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/RecordRef.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/RecordRef.cs index 7440fc8cd..a190cc636 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/RecordRef.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/RecordRef.cs @@ -12,29 +12,27 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// - /// Links the current record to the underlying record or data type that created it. + /// Links the current record to the underlying record or data type that created it. <br/> /// /// - /// + ///
/// For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. /// /// public class RecordRef { + /// - /// Allowed name of the 'dataType'. + /// Allowed name of the &apos;dataType&apos;. /// [JsonProperty("dataType")] public string? DataType { get; set; } - + /// - /// 'id' of the underlying record or data type. + /// &apos;id&apos; of the underlying record or data type. /// [JsonProperty("id")] public string? Id { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Security.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Security.cs index e44b52085..590ff5f22 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Security.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Security.cs @@ -12,12 +12,10 @@ namespace CodatSyncPayroll.Models.Shared { using CodatSyncPayroll.Utils; - public class Security { + [SpeakeasyMetadata("security:scheme=true,type=apiKey,subType=header,name=Authorization")] public string AuthHeader { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Status.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Status.cs index 40da75fc1..df5837c53 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Status.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Status.cs @@ -13,20 +13,19 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System; - /// /// Current state of the tracking category. /// public enum Status { - [JsonProperty("Unknown")] - Unknown, - [JsonProperty("Active")] - Active, - [JsonProperty("Archived")] - Archived, + [JsonProperty("Unknown")] + Unknown, + [JsonProperty("Active")] + Active, + [JsonProperty("Archived")] + Archived, } - + public static class StatusExtension { public static string Value(this Status value) @@ -53,5 +52,4 @@ public static Status ToEnum(this string value) throw new Exception($"Unknown value {value} for enum Status"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategories.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategories.cs index 520a21d07..3ae8ed29d 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategories.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategories.cs @@ -13,24 +13,22 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class TrackingCategories { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategory.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategory.cs index f54303417..8eb95f70b 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategory.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategory.cs @@ -12,178 +12,176 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// - /// Details of a category used for tracking transactions. + /// Details of a category used for tracking transactions.<br/> /// /// - /// - /// > Language tip - /// > - /// > Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting platforms. In Codat, we refer to these as tracking categories. - /// - /// View the coverage for tracking categories in the Data coverage explorer. - /// - /// ## Overview - /// - /// Tracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers. - /// - /// From their accounting system, customers can: - /// - /// - Create and maintain tracking categories and tracking category types. - /// - View all tracking categories that are available for use. - /// - View the relationships between the categories. - /// - Assign invoices, bills, credit notes, or bill credit notes to one or more categories. - /// - View the categories that a transaction belongs to. - /// - View all transactions in a tracking category. - /// - /// ### Tracking categories per platform - /// - /// Review the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform. - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - ///
PlatformTracking categoryTracking level
Dynamics 365DimensionsLine item
FreshbooksExpense categoriesLine item
MYOBCategoriesTransaction
NetsuiteClassesLine item
LocationsLine item
DepartmentsLine item
Custom segmentsLine item
QuickBooks DesktopClassesLine item or transaction level
LocationsTransaction
QuickBooks OnlineClassesLine item or transaction level
LocationsTransaction
Sage 200Cost centersLine item
DepartmentsLine item
Analysis codesTransaction
Sage 50DepartmentsLine item
CostcodesLine item
ProjectsLine item
Sage IntacctDimensionsLine item
XeroTracking categoriesLine item
- /// - /// > **Example use case** - /// > - /// > Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**. - /// + ///
+ /// > Language tip
+ /// >
+ /// > Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting platforms. In Codat, we refer to these as tracking categories.
+ ///
+ /// View the coverage for tracking categories in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=trackingCategories" target="_blank">Data coverage explorer</a>.
+ ///
+ /// ## Overview
+ ///
+ /// Tracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers.
+ ///
+ /// From their accounting system, customers can:
+ ///
+ /// - Create and maintain tracking categories and tracking category types.
+ /// - View all tracking categories that are available for use.
+ /// - View the relationships between the categories.
+ /// - Assign invoices, bills, credit notes, or bill credit notes to one or more categories.
+ /// - View the categories that a transaction belongs to.
+ /// - View all transactions in a tracking category.
+ ///
+ /// ### Tracking categories per platform
+ ///
+ /// Review the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform.
+ ///
+ /// <table>
+ /// <thead>
+ /// <tr>
+ /// <th>Platform</th>
+ /// <th>Tracking category</th>
+ /// <th>Tracking level</th>
+ /// </tr>
+ /// </thead>
+ /// <tbody>
+ /// <tr>
+ /// <td><b>Dynamics 365</b></td>
+ /// <td>Dimensions</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td><b>Freshbooks</b></td>
+ /// <td>Expense&nbsp;categories</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td><b>MYOB</b></td>
+ /// <td>Categories</td>
+ /// <td>Transaction</td>
+ /// </tr>
+ /// <tr>
+ /// <td rowspan=4><b>Netsuite</b></td>
+ /// <td>Classes</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Locations</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Departments</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Custom&nbsp;segments</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td rowspan=2><b>QuickBooks Desktop</b></td>
+ /// <td>Classes</td>
+ /// <td>Line item or transaction level</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Locations</td>
+ /// <td>Transaction</td>
+ /// </tr>
+ /// <tr>
+ /// <td rowspan=2><b>QuickBooks Online</b></td>
+ /// <td>Classes</td>
+ /// <td>Line item or transaction level</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Locations</td>
+ /// <td>Transaction</td>
+ /// </tr>
+ /// <tr>
+ /// <td rowspan=3><b>Sage 200</b></td>
+ /// <td>Cost&nbsp;centers</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Departments</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Analysis&nbsp;codes</td>
+ /// <td>Transaction</td>
+ /// </tr>
+ /// <tr>
+ /// <td rowspan=3><b>Sage 50</b></td>
+ /// <td>Departments</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Costcodes</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td>Projects</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td><b>Sage Intacct</b></td>
+ /// <td>Dimensions</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// <tr>
+ /// <td><b>Xero</b></td>
+ /// <td>Tracking&nbsp;categories</td>
+ /// <td>Line item</td>
+ /// </tr>
+ /// </tbody>
+ /// </table>
+ ///
+ /// > **Example use case**
+ /// >
+ /// > Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**.
+ ///
/// If a tracking category has a parent category, the ID of that parent category is displayed. There is also a `hasChildren` field that shows whether there are child subcategories nested beneath. /// /// public class TrackingCategory { + /// /// Boolean value indicating whether this category has SubCategories /// [JsonProperty("hasChildren")] public bool? HasChildren { get; set; } - + /// /// The identifier for the item, unique per tracking category /// [JsonProperty("id")] public string? Id { get; set; } - + [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } - + /// /// The name of the tracking category /// [JsonProperty("name")] public string? Name { get; set; } - + /// - /// The identifier for this item's immediate parent + /// The identifier for this item&apos;s immediate parent /// [JsonProperty("parentId")] public string? ParentId { get; set; } - + [JsonProperty("sourceModifiedDate")] public string? SourceModifiedDate { get; set; } - + /// /// Current state of the tracking category. /// [JsonProperty("status")] public Status? Status { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategoryTree.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategoryTree.cs index 43487a808..49fc9cadb 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategoryTree.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/TrackingCategoryTree.cs @@ -13,54 +13,52 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// /// The full structure of a specific tracking category including any child or subcategories. /// public class TrackingCategoryTree { + /// /// Boolean value indicating whether this category has SubCategories /// [JsonProperty("hasChildren")] public bool? HasChildren { get; set; } - + /// /// The identifier for the item, unique per tracking category /// [JsonProperty("id")] public string? Id { get; set; } - + [JsonProperty("modifiedDate")] public string? ModifiedDate { get; set; } - + /// /// The name of the tracking category /// [JsonProperty("name")] public string? Name { get; set; } - + /// - /// The identifier for this item's immediate parent + /// The identifier for this item&apos;s immediate parent /// [JsonProperty("parentId")] public string? ParentId { get; set; } - + [JsonProperty("sourceModifiedDate")] public string? SourceModifiedDate { get; set; } - + /// /// Current state of the tracking category. /// [JsonProperty("status")] public Status? Status { get; set; } - + /// /// A collection of subcategories that are nested beneath this category. /// [JsonProperty("subCategories")] public List? SubCategories { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Validation.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Validation.cs index 9051a1170..8b3c35582 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/Validation.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/Validation.cs @@ -13,18 +13,16 @@ namespace CodatSyncPayroll.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// public class Validation { + [JsonProperty("errors")] public List? Errors { get; set; } - + [JsonProperty("warnings")] public List? Warnings { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ValidationItem.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ValidationItem.cs index a2c36099d..c131d7675 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Shared/ValidationItem.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/ValidationItem.cs @@ -12,18 +12,16 @@ namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - public class ValidationItem { + [JsonProperty("itemId")] public string? ItemId { get; set; } - + [JsonProperty("message")] public string? Message { get; set; } - + [JsonProperty("validatorName")] public string? ValidatorName { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblink.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/WebLink.cs similarity index 78% rename from sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblink.cs rename to sync-for-payroll/CodatSyncPayroll/Models/Shared/WebLink.cs index 3a188b607..8df049ca0 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblink.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/WebLink.cs @@ -8,28 +8,26 @@ // //------------------------------------------------------------------------------ #nullable enable -namespace CodatSyncPayroll.Models.Operations +namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; - /// /// Weblink associated with the company. /// - public class GetAccountingProfileCompanyInformationWeblink + public class WebLink { + /// /// The type of the weblink. /// [JsonProperty("type")] - public GetAccountingProfileCompanyInformationWeblinkType? Type { get; set; } - + public WebLinkType? Type { get; set; } + /// /// The full URL for the weblink. /// [JsonProperty("url")] public string? Url { get; set; } - } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblinkType.cs b/sync-for-payroll/CodatSyncPayroll/Models/Shared/WebLinkType.cs similarity index 58% rename from sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblinkType.cs rename to sync-for-payroll/CodatSyncPayroll/Models/Shared/WebLinkType.cs index 34ae7b9d6..04067dcdc 100755 --- a/sync-for-payroll/CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblinkType.cs +++ b/sync-for-payroll/CodatSyncPayroll/Models/Shared/WebLinkType.cs @@ -8,50 +8,48 @@ // //------------------------------------------------------------------------------ #nullable enable -namespace CodatSyncPayroll.Models.Operations +namespace CodatSyncPayroll.Models.Shared { using Newtonsoft.Json; using System; - /// /// The type of the weblink. /// - public enum GetAccountingProfileCompanyInformationWeblinkType + public enum WebLinkType { - [JsonProperty("Website")] - Website, - [JsonProperty("Social")] - Social, - [JsonProperty("Unknown")] - Unknown, + [JsonProperty("Website")] + Website, + [JsonProperty("Social")] + Social, + [JsonProperty("Unknown")] + Unknown, } - - public static class GetAccountingProfileCompanyInformationWeblinkTypeExtension + + public static class WebLinkTypeExtension { - public static string Value(this GetAccountingProfileCompanyInformationWeblinkType value) + public static string Value(this WebLinkType value) { return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); } - public static GetAccountingProfileCompanyInformationWeblinkType ToEnum(this string value) + public static WebLinkType ToEnum(this string value) { - foreach(var field in typeof(GetAccountingProfileCompanyInformationWeblinkType).GetFields()) + foreach(var field in typeof(WebLinkType).GetFields()) { var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); - if (enumVal is GetAccountingProfileCompanyInformationWeblinkType) + if (enumVal is WebLinkType) { - return (GetAccountingProfileCompanyInformationWeblinkType)enumVal; + return (WebLinkType)enumVal; } } } - throw new Exception($"Unknown value {value} for enum GetAccountingProfileCompanyInformationWeblinkType"); + throw new Exception($"Unknown value {value} for enum WebLinkType"); } } - } \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Webhooks/ClientRateLimitReachedResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Webhooks/ClientRateLimitReachedResponse.cs new file mode 100755 index 000000000..02ae75c9f --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Webhooks/ClientRateLimitReachedResponse.cs @@ -0,0 +1,25 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Webhooks +{ + using System.Net.Http; + using System; + + public class ClientRateLimitReachedResponse + { + + public string? ContentType { get; set; } = default!; + + public int StatusCode { get; set; } = default!; + + public HttpResponseMessage? RawResponse { get; set; } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/Models/Webhooks/ClientRateLimitResetResponse.cs b/sync-for-payroll/CodatSyncPayroll/Models/Webhooks/ClientRateLimitResetResponse.cs new file mode 100755 index 000000000..6ec0edb6a --- /dev/null +++ b/sync-for-payroll/CodatSyncPayroll/Models/Webhooks/ClientRateLimitResetResponse.cs @@ -0,0 +1,25 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatSyncPayroll.Models.Webhooks +{ + using System.Net.Http; + using System; + + public class ClientRateLimitResetResponse + { + + public string? ContentType { get; set; } = default!; + + public int StatusCode { get; set; } = default!; + + public HttpResponseMessage? RawResponse { get; set; } + } +} \ No newline at end of file diff --git a/sync-for-payroll/CodatSyncPayroll/TrackingCategories.cs b/sync-for-payroll/CodatSyncPayroll/TrackingCategories.cs index 31bec92c8..8920e5f28 100755 --- a/sync-for-payroll/CodatSyncPayroll/TrackingCategories.cs +++ b/sync-for-payroll/CodatSyncPayroll/TrackingCategories.cs @@ -19,21 +19,49 @@ namespace CodatSyncPayroll using System.Threading.Tasks; using System; + /// + /// Tracking categories + /// public interface ITrackingCategoriesSDK { + + /// + /// Get tracking categories + /// + /// + /// The *Get tracking category* endpoint returns a single tracking category for a given `trackingCategoryId`.
+ ///
+ /// Tracking categories are used to monitor cost centres and control budgets that sit outside the standard set of accounts.
+ ///
+ /// Check out our coverage explorer for integrations that support getting a specific tracking category.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ /// + /// + /// Task GetAsync(GetTrackingCategoryRequest? request = null); + + /// + /// List tracking categories + /// + /// + /// The *List tracking categories* endpoint returns a list of tracking categories for a given company's connection.
+ ///
+ /// Tracking categories are used to monitor cost centres and control budgets that sit outside the standard set of accounts.
+ ///
+ /// Before using this endpoint, you must have retrieved data for the company.
+ /// + /// + /// Task ListAsync(ListTrackingCategoriesRequest? request = null); } - /// - /// Tracking categories - /// public class TrackingCategoriesSDK: ITrackingCategoriesSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.4.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -48,20 +76,6 @@ public TrackingCategoriesSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpC } - /// - /// Get tracking categories - /// - /// - /// The *Get tracking category* endpoint returns a single tracking category for a given `trackingCategoryId`. - /// - /// [Tracking categories](https://docs.codat.io/sync-for-payroll-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts. - /// - /// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=trackingCategories) for integrations that support getting a specific tracking category. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// - /// public async Task GetAsync(GetTrackingCategoryRequest? request = null) { string baseUrl = _serverUrl; @@ -110,18 +124,6 @@ public async Task GetAsync(GetTrackingCategoryReque } - /// - /// List tracking categories - /// - /// - /// The *List tracking categories* endpoint returns a list of [tracking categories](https://docs.codat.io/sync-for-payroll-api#/schemas/TrackingCategory) for a given company's connection. - /// - /// [Tracking categories](https://docs.codat.io/sync-for-payroll-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts. - /// - /// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data). - /// - /// - /// public async Task ListAsync(ListTrackingCategoriesRequest? request = null) { string baseUrl = _serverUrl; diff --git a/sync-for-payroll/README.md b/sync-for-payroll/README.md index e5680dc14..77bf2586b 100644 --- a/sync-for-payroll/README.md +++ b/sync-for-payroll/README.md @@ -67,14 +67,14 @@ var res = await sdk.Accounts.CreateAsync(new CreateAccountRequest() { ## Available Resources and Operations -### [accounts](docs/sdks/accounts/README.md) +### [Accounts](docs/sdks/accounts/README.md) * [Create](docs/sdks/accounts/README.md#create) - Create account * [Get](docs/sdks/accounts/README.md#get) - Get account * [GetCreateModel](docs/sdks/accounts/README.md#getcreatemodel) - Get create account model * [List](docs/sdks/accounts/README.md#list) - List accounts -### [companies](docs/sdks/companies/README.md) +### [Companies](docs/sdks/companies/README.md) * [Create](docs/sdks/companies/README.md#create) - Create company * [Delete](docs/sdks/companies/README.md#delete) - Delete a company @@ -82,11 +82,11 @@ var res = await sdk.Accounts.CreateAsync(new CreateAccountRequest() { * [List](docs/sdks/companies/README.md#list) - List companies * [Update](docs/sdks/companies/README.md#update) - Update company -### [companyInfo](docs/sdks/companyinfo/README.md) +### [CompanyInfo](docs/sdks/companyinfo/README.md) * [GetAccountingProfile](docs/sdks/companyinfo/README.md#getaccountingprofile) - Get company accounting profile -### [connections](docs/sdks/connections/README.md) +### [Connections](docs/sdks/connections/README.md) * [Create](docs/sdks/connections/README.md#create) - Create connection * [Delete](docs/sdks/connections/README.md#delete) - Delete connection @@ -94,7 +94,7 @@ var res = await sdk.Accounts.CreateAsync(new CreateAccountRequest() { * [List](docs/sdks/connections/README.md#list) - List connections * [Unlink](docs/sdks/connections/README.md#unlink) - Unlink connection -### [journalEntries](docs/sdks/journalentries/README.md) +### [JournalEntries](docs/sdks/journalentries/README.md) * [Create](docs/sdks/journalentries/README.md#create) - Create journal entry * [Delete](docs/sdks/journalentries/README.md#delete) - Delete journal entry @@ -102,14 +102,14 @@ var res = await sdk.Accounts.CreateAsync(new CreateAccountRequest() { * [GetCreateModel](docs/sdks/journalentries/README.md#getcreatemodel) - Get create journal entry model * [List](docs/sdks/journalentries/README.md#list) - List journal entries -### [journals](docs/sdks/journals/README.md) +### [Journals](docs/sdks/journals/README.md) * [Create](docs/sdks/journals/README.md#create) - Create journal * [Get](docs/sdks/journals/README.md#get) - Get journal * [GetCreateModel](docs/sdks/journals/README.md#getcreatemodel) - Get create journal model * [List](docs/sdks/journals/README.md#list) - List journals -### [manageData](docs/sdks/managedata/README.md) +### [ManageData](docs/sdks/managedata/README.md) * [GetDataStatus](docs/sdks/managedata/README.md#getdatastatus) - Get data status * [GetPullOperation](docs/sdks/managedata/README.md#getpulloperation) - Get pull operation @@ -119,7 +119,7 @@ var res = await sdk.Accounts.CreateAsync(new CreateAccountRequest() { * [RefreshAllDataTypes](docs/sdks/managedata/README.md#refreshalldatatypes) - Refresh all data * [RefreshDataType](docs/sdks/managedata/README.md#refreshdatatype) - Refresh data type -### [trackingCategories](docs/sdks/trackingcategories/README.md) +### [TrackingCategories](docs/sdks/trackingcategories/README.md) * [Get](docs/sdks/trackingcategories/README.md#get) - Get tracking categories * [List](docs/sdks/trackingcategories/README.md#list) - List tracking categories diff --git a/sync-for-payroll/RELEASES.md b/sync-for-payroll/RELEASES.md index a12722cd5..2a045f3af 100644 --- a/sync-for-payroll/RELEASES.md +++ b/sync-for-payroll/RELEASES.md @@ -36,4 +36,14 @@ Based on: ### Generated - [csharp v0.4.0] sync-for-payroll ### Releases -- [NuGet v0.4.0] https://www.nuget.org/packages/Codat.Sync.Payroll/0.4.0 - sync-for-payroll \ No newline at end of file +- [NuGet v0.4.0] https://www.nuget.org/packages/Codat.Sync.Payroll/0.4.0 - sync-for-payroll + +## 2023-09-18 21:54:54 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Payroll.yaml +- Speakeasy CLI 1.87.0 (2.116.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v1.1.0] sync-for-payroll +### Releases +- [NuGet v1.1.0] https://www.nuget.org/packages/Codat.Sync.Payroll/1.1.0 - sync-for-payroll \ No newline at end of file diff --git a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationPhone.md b/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationPhone.md deleted file mode 100755 index 448d40490..000000000 --- a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationPhone.md +++ /dev/null @@ -1,9 +0,0 @@ -# GetAccountingProfileCompanyInformationPhone - - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `number` | *string* | :heavy_check_mark: | A phone number. | +44 25691 154789 | -| `type` | [Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType](../../models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationWeblink.md b/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationWeblink.md deleted file mode 100755 index 5da068ecf..000000000 --- a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationWeblink.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetAccountingProfileCompanyInformationWeblink - -Weblink associated with the company. - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [GetAccountingProfileCompanyInformationWeblinkType](../../models/operations/GetAccountingProfileCompanyInformationWeblinkType.md) | :heavy_minus_sign: | The type of the weblink. | -| `url` | *string* | :heavy_minus_sign: | The full URL for the weblink. | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/operations/GetAccountingProfileResponse.md b/sync-for-payroll/docs/models/operations/GetAccountingProfileResponse.md index a1a12d2e1..a31e93ad8 100755 --- a/sync-for-payroll/docs/models/operations/GetAccountingProfileResponse.md +++ b/sync-for-payroll/docs/models/operations/GetAccountingProfileResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `companyInformation` | [GetAccountingProfileCompanyInformation](../../models/operations/GetAccountingProfileCompanyInformation.md) | :heavy_minus_sign: | Success | +| `companyInfo` | [CompanyInfo](../../models/shared/CompanyInfo.md) | :heavy_minus_sign: | Success | | `contentType` | *string* | :heavy_check_mark: | N/A | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `statusCode` | *int* | :heavy_check_mark: | N/A | diff --git a/sync-for-payroll/docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.md b/sync-for-payroll/docs/models/shared/AccountingAddressType.md similarity index 53% rename from sync-for-payroll/docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.md rename to sync-for-payroll/docs/models/shared/AccountingAddressType.md index a01d6d4cf..2c5f98c72 100755 --- a/sync-for-payroll/docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.md +++ b/sync-for-payroll/docs/models/shared/AccountingAddressType.md @@ -1,4 +1,4 @@ -# Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType +# AccountingAddressType The type of the address diff --git a/sync-for-payroll/docs/models/shared/Address.md b/sync-for-payroll/docs/models/shared/Address.md new file mode 100755 index 000000000..eae4f6b95 --- /dev/null +++ b/sync-for-payroll/docs/models/shared/Address.md @@ -0,0 +1,14 @@ +# Address + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `city` | *string* | :heavy_minus_sign: | City of the customer address. | +| `country` | *string* | :heavy_minus_sign: | Country of the customer address. | +| `line1` | *string* | :heavy_minus_sign: | Line 1 of the customer address. | +| `line2` | *string* | :heavy_minus_sign: | Line 2 of the customer address. | +| `postalCode` | *string* | :heavy_minus_sign: | Postal code or zip code. | +| `region` | *string* | :heavy_minus_sign: | Region of the customer address. | +| `type` | [AccountingAddressType](../../models/shared/AccountingAddressType.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/shared/ClientRateLimitReachedWebhook.md b/sync-for-payroll/docs/models/shared/ClientRateLimitReachedWebhook.md new file mode 100755 index 000000000..8964c7a69 --- /dev/null +++ b/sync-for-payroll/docs/models/shared/ClientRateLimitReachedWebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitReachedWebhook + +Webhook request body for a client that has reached their rate limit. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [ClientRateLimitReachedWebhookData](../../models/shared/ClientRateLimitReachedWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | +| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationAccountingAddress.md b/sync-for-payroll/docs/models/shared/ClientRateLimitReachedWebhookData.md similarity index 56% rename from sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationAccountingAddress.md rename to sync-for-payroll/docs/models/shared/ClientRateLimitReachedWebhookData.md index f0c6a1130..ce6df4f7a 100755 --- a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationAccountingAddress.md +++ b/sync-for-payroll/docs/models/shared/ClientRateLimitReachedWebhookData.md @@ -1,14 +1,9 @@ -# GetAccountingProfileCompanyInformationAccountingAddress +# ClientRateLimitReachedWebhookData ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | City of the customer address. | -| `country` | *string* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *string* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *string* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postalCode` | *string* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *string* | :heavy_minus_sign: | Region of the customer address. | -| `type` | [Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType](../../models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dailyQuota` | *long* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/shared/ClientRateLimitResetWebhook.md b/sync-for-payroll/docs/models/shared/ClientRateLimitResetWebhook.md new file mode 100755 index 000000000..50d8ba967 --- /dev/null +++ b/sync-for-payroll/docs/models/shared/ClientRateLimitResetWebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitResetWebhook + +Webhook request body for a client that has had their rate limit reset. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [ClientRateLimitResetWebhookData](../../models/shared/ClientRateLimitResetWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | +| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/shared/ClientRateLimitResetWebhookData.md b/sync-for-payroll/docs/models/shared/ClientRateLimitResetWebhookData.md new file mode 100755 index 000000000..17286b07d --- /dev/null +++ b/sync-for-payroll/docs/models/shared/ClientRateLimitResetWebhookData.md @@ -0,0 +1,11 @@ +# ClientRateLimitResetWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dailyQuota` | *long* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `quotaRemaining` | *long* | :heavy_minus_sign: | Total number of request remaining for your client. | | +| `resetReason` | *string* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformation.md b/sync-for-payroll/docs/models/shared/CompanyInfo.md similarity index 98% rename from sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformation.md rename to sync-for-payroll/docs/models/shared/CompanyInfo.md index e46560545..f1e329fe6 100755 --- a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformation.md +++ b/sync-for-payroll/docs/models/shared/CompanyInfo.md @@ -1,4 +1,4 @@ -# GetAccountingProfileCompanyInformation +# CompanyInfo > View the coverage for company info in the Data coverage explorer. @@ -14,15 +14,15 @@ Company info provides standard details about a linked company such as their addr | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountingPlatformRef` | *string* | :heavy_minus_sign: | Identifier or reference for the company in the accounting platform. | | -| `addresses` | List<[GetAccountingProfileCompanyInformationAccountingAddress](../../models/operations/GetAccountingProfileCompanyInformationAccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List<[Address](../../models/shared/Address.md)> | :heavy_minus_sign: | An array of Addresses. | | | `baseCurrency` | *string* | :heavy_minus_sign: | Currency set in the accounting platform of the linked company. Used by the currency rate. | | | `companyLegalName` | *string* | :heavy_minus_sign: | Registered legal name of the linked company. | | | `companyName` | *string* | :heavy_minus_sign: | Name of the linked company. | | | `createdDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `financialYearStartDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `ledgerLockDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `phoneNumbers` | List<[GetAccountingProfileCompanyInformationPhone](../../models/operations/GetAccountingProfileCompanyInformationPhone.md)> | :heavy_minus_sign: | An array of phone numbers. | | +| `phoneNumbers` | List<[PhoneNumber](../../models/shared/PhoneNumber.md)> | :heavy_minus_sign: | An array of phone numbers. | | | `registrationNumber` | *string* | :heavy_minus_sign: | Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. | | | `sourceUrls` | Dictionary | :heavy_minus_sign: | URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). | | | `taxNumber` | *string* | :heavy_minus_sign: | Company tax number. | | -| `webLinks` | List<[GetAccountingProfileCompanyInformationWeblink](../../models/operations/GetAccountingProfileCompanyInformationWeblink.md)> | :heavy_minus_sign: | An array of weblinks. | | \ No newline at end of file +| `webLinks` | List<[WebLink](../../models/shared/WebLink.md)> | :heavy_minus_sign: | An array of weblinks. | | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/shared/CreateAccountResponse.md b/sync-for-payroll/docs/models/shared/CreateAccountResponse.md index 1a8985a4b..5340c086e 100755 --- a/sync-for-payroll/docs/models/shared/CreateAccountResponse.md +++ b/sync-for-payroll/docs/models/shared/CreateAccountResponse.md @@ -14,7 +14,7 @@ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | | | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | N/A | | | `timeoutInMinutes` | *int* | :heavy_minus_sign: | N/A | | | ~~`timeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/sync-for-payroll/docs/models/shared/CreateJournalEntryResponse.md b/sync-for-payroll/docs/models/shared/CreateJournalEntryResponse.md index 594b95ac7..aca33ac39 100755 --- a/sync-for-payroll/docs/models/shared/CreateJournalEntryResponse.md +++ b/sync-for-payroll/docs/models/shared/CreateJournalEntryResponse.md @@ -14,7 +14,7 @@ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | | | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | N/A | | | `timeoutInMinutes` | *int* | :heavy_minus_sign: | N/A | | | ~~`timeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/sync-for-payroll/docs/models/shared/CreateJournalResponse.md b/sync-for-payroll/docs/models/shared/CreateJournalResponse.md index 8a1d234c2..b9f9a2515 100755 --- a/sync-for-payroll/docs/models/shared/CreateJournalResponse.md +++ b/sync-for-payroll/docs/models/shared/CreateJournalResponse.md @@ -14,7 +14,7 @@ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | | | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | N/A | | | `timeoutInMinutes` | *int* | :heavy_minus_sign: | N/A | | | ~~`timeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/sync-for-payroll/docs/models/shared/PhoneNumber.md b/sync-for-payroll/docs/models/shared/PhoneNumber.md new file mode 100755 index 000000000..a5a6260c7 --- /dev/null +++ b/sync-for-payroll/docs/models/shared/PhoneNumber.md @@ -0,0 +1,9 @@ +# PhoneNumber + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `number` | *string* | :heavy_check_mark: | A phone number. | +44 25691 154789 | +| `type` | [PhoneNumberType](../../models/shared/PhoneNumberType.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.md b/sync-for-payroll/docs/models/shared/PhoneNumberType.md similarity index 60% rename from sync-for-payroll/docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.md rename to sync-for-payroll/docs/models/shared/PhoneNumberType.md index 1a60ef89d..4d49c6915 100755 --- a/sync-for-payroll/docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.md +++ b/sync-for-payroll/docs/models/shared/PhoneNumberType.md @@ -1,4 +1,4 @@ -# Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType +# PhoneNumberType The type of phone number diff --git a/sync-for-payroll/docs/models/shared/PushOperation.md b/sync-for-payroll/docs/models/shared/PushOperation.md index 577e3bbfa..b7b0e1a98 100755 --- a/sync-for-payroll/docs/models/shared/PushOperation.md +++ b/sync-for-payroll/docs/models/shared/PushOperation.md @@ -13,7 +13,7 @@ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | | | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | N/A | | | `timeoutInMinutes` | *int* | :heavy_minus_sign: | N/A | | | ~~`timeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/sync-for-payroll/docs/models/shared/PushOperationStatus.md b/sync-for-payroll/docs/models/shared/PushOperationStatus.md index 3adf5a3ae..4e041b534 100755 --- a/sync-for-payroll/docs/models/shared/PushOperationStatus.md +++ b/sync-for-payroll/docs/models/shared/PushOperationStatus.md @@ -1,6 +1,6 @@ # PushOperationStatus -The status of the push operation. +The current status of the push operation. ## Values diff --git a/sync-for-payroll/docs/models/shared/WebLink.md b/sync-for-payroll/docs/models/shared/WebLink.md new file mode 100755 index 000000000..f882a621c --- /dev/null +++ b/sync-for-payroll/docs/models/shared/WebLink.md @@ -0,0 +1,11 @@ +# WebLink + +Weblink associated with the company. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| `type` | [WebLinkType](../../models/shared/WebLinkType.md) | :heavy_minus_sign: | The type of the weblink. | +| `url` | *string* | :heavy_minus_sign: | The full URL for the weblink. | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationWeblinkType.md b/sync-for-payroll/docs/models/shared/WebLinkType.md similarity index 76% rename from sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationWeblinkType.md rename to sync-for-payroll/docs/models/shared/WebLinkType.md index e02c740b6..a091ba93e 100755 --- a/sync-for-payroll/docs/models/operations/GetAccountingProfileCompanyInformationWeblinkType.md +++ b/sync-for-payroll/docs/models/shared/WebLinkType.md @@ -1,4 +1,4 @@ -# GetAccountingProfileCompanyInformationWeblinkType +# WebLinkType The type of the weblink. diff --git a/sync-for-payroll/docs/models/webhooks/ClientRateLimitReachedResponse.md b/sync-for-payroll/docs/models/webhooks/ClientRateLimitReachedResponse.md new file mode 100755 index 000000000..f63a6471a --- /dev/null +++ b/sync-for-payroll/docs/models/webhooks/ClientRateLimitReachedResponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitReachedResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | N/A | +| `statusCode` | *int* | :heavy_check_mark: | N/A | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-payroll/docs/models/webhooks/ClientRateLimitResetResponse.md b/sync-for-payroll/docs/models/webhooks/ClientRateLimitResetResponse.md new file mode 100755 index 000000000..c24fe522c --- /dev/null +++ b/sync-for-payroll/docs/models/webhooks/ClientRateLimitResetResponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitResetResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | N/A | +| `statusCode` | *int* | :heavy_check_mark: | N/A | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-payroll/docs/sdks/accounts/README.md b/sync-for-payroll/docs/sdks/accounts/README.md index 1d907a27c..0dd390b24 100755 --- a/sync-for-payroll/docs/sdks/accounts/README.md +++ b/sync-for-payroll/docs/sdks/accounts/README.md @@ -1,4 +1,4 @@ -# accounts +# Accounts ## Overview diff --git a/sync-for-payroll/docs/sdks/companies/README.md b/sync-for-payroll/docs/sdks/companies/README.md index 028eef82c..4e22ba10e 100755 --- a/sync-for-payroll/docs/sdks/companies/README.md +++ b/sync-for-payroll/docs/sdks/companies/README.md @@ -1,4 +1,4 @@ -# companies +# Companies ## Overview diff --git a/sync-for-payroll/docs/sdks/companyinfo/README.md b/sync-for-payroll/docs/sdks/companyinfo/README.md index 52b9adf60..7b610d8a1 100755 --- a/sync-for-payroll/docs/sdks/companyinfo/README.md +++ b/sync-for-payroll/docs/sdks/companyinfo/README.md @@ -1,4 +1,4 @@ -# companyInfo +# CompanyInfo ## Overview diff --git a/sync-for-payroll/docs/sdks/connections/README.md b/sync-for-payroll/docs/sdks/connections/README.md index a38cb9cb9..85b4dd9f4 100755 --- a/sync-for-payroll/docs/sdks/connections/README.md +++ b/sync-for-payroll/docs/sdks/connections/README.md @@ -1,4 +1,4 @@ -# connections +# Connections ## Overview diff --git a/sync-for-payroll/docs/sdks/journalentries/README.md b/sync-for-payroll/docs/sdks/journalentries/README.md index d2dd402c2..1d554f832 100755 --- a/sync-for-payroll/docs/sdks/journalentries/README.md +++ b/sync-for-payroll/docs/sdks/journalentries/README.md @@ -1,4 +1,4 @@ -# journalEntries +# JournalEntries ## Overview diff --git a/sync-for-payroll/docs/sdks/journals/README.md b/sync-for-payroll/docs/sdks/journals/README.md index 48741ec6e..b22b2f912 100755 --- a/sync-for-payroll/docs/sdks/journals/README.md +++ b/sync-for-payroll/docs/sdks/journals/README.md @@ -1,4 +1,4 @@ -# journals +# Journals ## Overview diff --git a/sync-for-payroll/docs/sdks/managedata/README.md b/sync-for-payroll/docs/sdks/managedata/README.md index 8f7955dc6..768962b69 100755 --- a/sync-for-payroll/docs/sdks/managedata/README.md +++ b/sync-for-payroll/docs/sdks/managedata/README.md @@ -1,4 +1,4 @@ -# manageData +# ManageData ## Overview diff --git a/sync-for-payroll/docs/sdks/trackingcategories/README.md b/sync-for-payroll/docs/sdks/trackingcategories/README.md index a4bf695cb..f0aa5ac64 100755 --- a/sync-for-payroll/docs/sdks/trackingcategories/README.md +++ b/sync-for-payroll/docs/sdks/trackingcategories/README.md @@ -1,4 +1,4 @@ -# trackingCategories +# TrackingCategories ## Overview diff --git a/sync-for-payroll/files.gen b/sync-for-payroll/files.gen index 919bcd178..b1723a56f 100755 --- a/sync-for-payroll/files.gen +++ b/sync-for-payroll/files.gen @@ -39,11 +39,6 @@ CodatSyncPayroll/Models/Operations/ListCompaniesResponse.cs CodatSyncPayroll/Models/Operations/UpdateCompanyRequest.cs CodatSyncPayroll/Models/Operations/UpdateCompanyResponse.cs CodatSyncPayroll/Models/Operations/GetAccountingProfileRequest.cs -CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationAccountingAddress.cs -CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationPhone.cs -CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblinkType.cs -CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformationWeblink.cs -CodatSyncPayroll/Models/Operations/GetAccountingProfileCompanyInformation.cs CodatSyncPayroll/Models/Operations/GetAccountingProfileResponse.cs CodatSyncPayroll/Models/Operations/CreateConnectionRequestBody.cs CodatSyncPayroll/Models/Operations/CreateConnectionRequest.cs @@ -123,8 +118,13 @@ CodatSyncPayroll/Models/Shared/DataConnectionStatus.cs CodatSyncPayroll/Models/Shared/DataConnectionError.cs CodatSyncPayroll/Models/Shared/CompanyRequestBody.cs CodatSyncPayroll/Models/Shared/Companies.cs -CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.cs -CodatSyncPayroll/Models/Shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.cs +CodatSyncPayroll/Models/Shared/CompanyInfo.cs +CodatSyncPayroll/Models/Shared/WebLinkType.cs +CodatSyncPayroll/Models/Shared/WebLink.cs +CodatSyncPayroll/Models/Shared/PhoneNumber.cs +CodatSyncPayroll/Models/Shared/PhoneNumberType.cs +CodatSyncPayroll/Models/Shared/Address.cs +CodatSyncPayroll/Models/Shared/AccountingAddressType.cs CodatSyncPayroll/Models/Shared/Connections.cs CodatSyncPayroll/Models/Shared/CreateJournalEntryResponse.cs CodatSyncPayroll/Models/Shared/JournalEntryRecordReference.cs @@ -152,6 +152,12 @@ CodatSyncPayroll/Models/Shared/Status.cs CodatSyncPayroll/Models/Shared/TrackingCategories.cs CodatSyncPayroll/Models/Shared/TrackingCategory.cs CodatSyncPayroll/Models/Shared/Security.cs +CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhook.cs +CodatSyncPayroll/Models/Shared/ClientRateLimitReachedWebhookData.cs +CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhook.cs +CodatSyncPayroll/Models/Shared/ClientRateLimitResetWebhookData.cs +CodatSyncPayroll/Models/Webhooks/ClientRateLimitReachedResponse.cs +CodatSyncPayroll/Models/Webhooks/ClientRateLimitResetResponse.cs docs/sdks/codatsyncpayroll/README.md docs/sdks/accounts/README.md docs/sdks/companies/README.md @@ -180,11 +186,6 @@ docs/models/operations/ListCompaniesResponse.md docs/models/operations/UpdateCompanyRequest.md docs/models/operations/UpdateCompanyResponse.md docs/models/operations/GetAccountingProfileRequest.md -docs/models/operations/GetAccountingProfileCompanyInformationAccountingAddress.md -docs/models/operations/GetAccountingProfileCompanyInformationPhone.md -docs/models/operations/GetAccountingProfileCompanyInformationWeblinkType.md -docs/models/operations/GetAccountingProfileCompanyInformationWeblink.md -docs/models/operations/GetAccountingProfileCompanyInformation.md docs/models/operations/GetAccountingProfileResponse.md docs/models/operations/CreateConnectionRequestBody.md docs/models/operations/CreateConnectionRequest.md @@ -264,8 +265,13 @@ docs/models/shared/DataConnectionStatus.md docs/models/shared/DataConnectionError.md docs/models/shared/CompanyRequestBody.md docs/models/shared/Companies.md -docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesPhoneNumbersItemsDefinitionsPhoneNumberType.md -docs/models/shared/Onecompanies1Percent7BcompanyIdPercent7D1data1infoGetResponses200ContentApplication1jsonSchemaPropertiesAddressesItemsDefinitionsAccountingAddressType.md +docs/models/shared/CompanyInfo.md +docs/models/shared/WebLinkType.md +docs/models/shared/WebLink.md +docs/models/shared/PhoneNumber.md +docs/models/shared/PhoneNumberType.md +docs/models/shared/Address.md +docs/models/shared/AccountingAddressType.md docs/models/shared/Connections.md docs/models/shared/CreateJournalEntryResponse.md docs/models/shared/JournalEntryRecordReference.md @@ -293,4 +299,10 @@ docs/models/shared/Status.md docs/models/shared/TrackingCategories.md docs/models/shared/TrackingCategory.md docs/models/shared/Security.md +docs/models/shared/ClientRateLimitReachedWebhook.md +docs/models/shared/ClientRateLimitReachedWebhookData.md +docs/models/shared/ClientRateLimitResetWebhook.md +docs/models/shared/ClientRateLimitResetWebhookData.md +docs/models/webhooks/ClientRateLimitReachedResponse.md +docs/models/webhooks/ClientRateLimitResetResponse.md .gitattributes \ No newline at end of file diff --git a/sync-for-payroll/gen.yaml b/sync-for-payroll/gen.yaml index e5a136f57..d612502fd 100644 --- a/sync-for-payroll/gen.yaml +++ b/sync-for-payroll/gen.yaml @@ -1,23 +1,23 @@ configVersion: 1.0.0 management: - docChecksum: 1f4eacf69533bb7b4b445eb3b88a6646 + docChecksum: 2e46c003041e7d295471eea7b007b159 docVersion: 3.0.0 - speakeasyVersion: 1.84.0 - generationVersion: 2.113.0 + speakeasyVersion: 1.87.0 + generationVersion: 2.116.0 generation: sdkClassName: Codat.Sync.Payroll singleTagPerOp: false telemetryEnabled: true features: csharp: - core: 2.85.7 + core: 2.85.8 deprecations: 2.81.1 examples: 2.81.2 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 nameOverrides: 2.81.1 csharp: - version: 1.0.0 + version: 1.1.0 author: Codat description: Push payroll to accounting platforms. dotnetVersion: net6.0