Skip to content

merge-api/merge-accounting-csharp-net

BranchesTags

Repository files navigation

Merge.AccountingClient - the C# library for the Merge Accounting API

The unified API for building rich integrations with multiple Accounting & Finance platforms.

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • SDK version: 1.1.1
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://www.merge.dev/

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Merge.AccountingClient.Api;
using Merge.AccountingClient.Client;
using Merge.AccountingClient.Model;

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Merge.AccountingClient.Api;
using Merge.AccountingClient.Client;
using Merge.AccountingClient.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.merge.dev/api/accounting/v1";
            // Configure API key authorization: tokenAuth
            config.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountDetailsApi(config);
            var xAccountToken = xAccountToken_example;  // string | Token identifying the end user.

            try
            {
                AccountDetails result = apiInstance.AccountDetailsRetrieve(xAccountToken);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AccountDetailsApi.AccountDetailsRetrieve: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/accounting/v1

Class Method HTTP request Description
AccountDetailsApi AccountDetailsRetrieve GET /account-details
AccountTokenApi AccountTokenRetrieve GET /account-token/{public_token}
AccountsApi AccountsCreate POST /accounts
AccountsApi AccountsList GET /accounts
AccountsApi AccountsMetaPostRetrieve GET /accounts/meta/post
AccountsApi AccountsRetrieve GET /accounts/{id}
AddressesApi AddressesRetrieve GET /addresses/{id}
AttachmentsApi AttachmentsCreate POST /attachments
AttachmentsApi AttachmentsList GET /attachments
AttachmentsApi AttachmentsMetaPostRetrieve GET /attachments/meta/post
AttachmentsApi AttachmentsRetrieve GET /attachments/{id}
AvailableActionsApi AvailableActionsRetrieve GET /available-actions
BalanceSheetsApi BalanceSheetsList GET /balance-sheets
BalanceSheetsApi BalanceSheetsRetrieve GET /balance-sheets/{id}
CashFlowStatementsApi CashFlowStatementsList GET /cash-flow-statements
CashFlowStatementsApi CashFlowStatementsRetrieve GET /cash-flow-statements/{id}
CompanyInfoApi CompanyInfoList GET /company-info
CompanyInfoApi CompanyInfoRetrieve GET /company-info/{id}
ContactsApi ContactsCreate POST /contacts
ContactsApi ContactsList GET /contacts
ContactsApi ContactsMetaPostRetrieve GET /contacts/meta/post
ContactsApi ContactsRetrieve GET /contacts/{id}
CreditNotesApi CreditNotesList GET /credit-notes
CreditNotesApi CreditNotesRetrieve GET /credit-notes/{id}
DeleteAccountApi DeleteAccountCreate POST /delete-account
ExpensesApi ExpensesCreate POST /expenses
ExpensesApi ExpensesList GET /expenses
ExpensesApi ExpensesMetaPostRetrieve GET /expenses/meta/post
ExpensesApi ExpensesRetrieve GET /expenses/{id}
ForceResyncApi SyncStatusResyncCreate POST /sync-status/resync
GenerateKeyApi GenerateKeyCreate POST /generate-key
IncomeStatementsApi IncomeStatementsList GET /income-statements
IncomeStatementsApi IncomeStatementsRetrieve GET /income-statements/{id}
InvoicesApi InvoicesCreate POST /invoices
InvoicesApi InvoicesList GET /invoices
InvoicesApi InvoicesMetaPostRetrieve GET /invoices/meta/post
InvoicesApi InvoicesRetrieve GET /invoices/{id}
IssuesApi IssuesList GET /issues
IssuesApi IssuesRetrieve GET /issues/{id}
ItemsApi ItemsList GET /items
ItemsApi ItemsRetrieve GET /items/{id}
JournalEntriesApi JournalEntriesCreate POST /journal-entries
JournalEntriesApi JournalEntriesList GET /journal-entries
JournalEntriesApi JournalEntriesMetaPostRetrieve GET /journal-entries/meta/post
JournalEntriesApi JournalEntriesRetrieve GET /journal-entries/{id}
LinkTokenApi LinkTokenCreate POST /link-token
LinkedAccountsApi LinkedAccountsList GET /linked-accounts
PassthroughApi PassthroughCreate POST /passthrough
PaymentsApi PaymentsCreate POST /payments
PaymentsApi PaymentsList GET /payments
PaymentsApi PaymentsMetaPostRetrieve GET /payments/meta/post
PaymentsApi PaymentsRetrieve GET /payments/{id}
PhoneNumbersApi PhoneNumbersRetrieve GET /phone-numbers/{id}
PurchaseOrdersApi PurchaseOrdersCreate POST /purchase-orders
PurchaseOrdersApi PurchaseOrdersList GET /purchase-orders
PurchaseOrdersApi PurchaseOrdersMetaPostRetrieve GET /purchase-orders/meta/post
PurchaseOrdersApi PurchaseOrdersRetrieve GET /purchase-orders/{id}
RegenerateKeyApi RegenerateKeyCreate POST /regenerate-key
SelectiveSyncApi SelectiveSyncConfigurationsList GET /selective-sync/configurations
SelectiveSyncApi SelectiveSyncConfigurationsUpdate PUT /selective-sync/configurations
SelectiveSyncApi SelectiveSyncMetaList GET /selective-sync/meta
SyncStatusApi SyncStatusList GET /sync-status
TaxRatesApi TaxRatesList GET /tax-rates
TaxRatesApi TaxRatesRetrieve GET /tax-rates/{id}
TrackingCategoriesApi TrackingCategoriesList GET /tracking-categories
TrackingCategoriesApi TrackingCategoriesRetrieve GET /tracking-categories/{id}
TransactionsApi TransactionsList GET /transactions
TransactionsApi TransactionsRetrieve GET /transactions/{id}
VendorCreditsApi VendorCreditsList GET /vendor-credits
VendorCreditsApi VendorCreditsRetrieve GET /vendor-credits/{id}
WebhookReceiversApi WebhookReceiversCreate POST /webhook-receivers
WebhookReceiversApi WebhookReceiversList GET /webhook-receivers

Documentation for Models

Documentation for Authorization

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

The C# .NET API Client for the Merge Accounting API.

Resources

Readme

License

View license
Activity
Custom properties

Stars

0 stars

Watchers

9 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages