Go API client for merge_accounting_client

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

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 1.3.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.merge.dev/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./merge_accounting_client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

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

• Account
• AccountDetails
• AccountDetailsAndActions
• AccountDetailsAndActionsIntegration
• AccountDetailsAndActionsStatusEnum
• AccountEndpointRequest
• AccountIntegration
• AccountRequest
• AccountResponse
• AccountStatusEnum
• AccountToken
• AccountingAttachment
• AccountingAttachmentEndpointRequest
• AccountingAttachmentRequest
• AccountingAttachmentResponse
• AccountingPhoneNumber
• AccountingPhoneNumberRequest
• Address
• AddressTypeEnum
• AvailableActions
• BalanceSheet
• CashFlowStatement
• CategoriesEnum
• CategoryEnum
• CategoryTypeEnum
• ClassificationEnum
• CommonModelScopesBodyRequest
• CompanyInfo
• ConditionSchema
• ConditionTypeEnum
• Contact
• ContactEndpointRequest
• ContactRequest
• ContactResponse
• CountryEnum
• CreditNote
• CreditNoteLineItem
• CreditNoteStatusEnum
• CurrencyEnum
• DataPassthroughRequest
• DebugModeLog
• DebugModelLogSummary
• EnabledActionsEnum
• EncodingEnum
• EndUserDetailsRequest
• ErrorValidationProblem
• Expense
• ExpenseEndpointRequest
• ExpenseLine
• ExpenseLineRequest
• ExpenseRequest
• ExpenseResponse
• GenerateRemoteKeyRequest
• IncomeStatement
• Invoice
• InvoiceEndpointRequest
• InvoiceLineItem
• InvoiceLineItemRequest
• InvoiceRequest
• InvoiceResponse
• InvoiceTypeEnum
• Issue
• IssueStatusEnum
• Item
• JournalEntry
• JournalEntryEndpointRequest
• JournalEntryRequest
• JournalEntryResponse
• JournalLine
• JournalLineRequest
• LinkToken
• LinkedAccountCondition
• LinkedAccountConditionRequest
• LinkedAccountSelectiveSyncConfiguration
• LinkedAccountSelectiveSyncConfigurationListRequest
• LinkedAccountSelectiveSyncConfigurationRequest
• LinkedAccountStatus
• MetaResponse
• MethodEnum
• ModelOperation
• MultipartFormFieldRequest
• OperatorSchema
• PaginatedAccountDetailsAndActionsList
• PaginatedAccountList
• PaginatedAccountingAttachmentList
• PaginatedBalanceSheetList
• PaginatedCashFlowStatementList
• PaginatedCompanyInfoList
• PaginatedConditionSchemaList
• PaginatedContactList
• PaginatedCreditNoteList
• PaginatedExpenseList
• PaginatedIncomeStatementList
• PaginatedInvoiceList
• PaginatedIssueList
• PaginatedItemList
• PaginatedJournalEntryList
• PaginatedPaymentList
• PaginatedPurchaseOrderList
• PaginatedSyncStatusList
• PaginatedTaxRateList
• PaginatedTrackingCategoryList
• PaginatedTransactionList
• PaginatedVendorCreditList
• Payment
• PaymentEndpointRequest
• PaymentRequest
• PaymentResponse
• PostingStatusEnum
• PurchaseOrder
• PurchaseOrderEndpointRequest
• PurchaseOrderLineItem
• PurchaseOrderLineItemRequest
• PurchaseOrderRequest
• PurchaseOrderResponse
• PurchaseOrderStatusEnum
• RemoteData
• RemoteKey
• RemoteKeyForRegenerationRequest
• RemoteResponse
• ReportItem
• RequestFormatEnum
• ResponseTypeEnum
• SelectiveSyncConfigurationsUsageEnum
• Status7d1Enum
• SyncStatus
• SyncStatusStatusEnum
• TaxRate
• TrackingCategory
• Transaction
• TransactionLineItem
• ValidationProblemSource
• VendorCredit
• VendorCreditLine
• WarningValidationProblem
• WebhookReceiver
• WebhookReceiverRequest

Documentation For Authorization

tokenAuth

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

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

hello@merge.dev