Go API client for accounting

These APIs allow you to interact with HubSpot's Accounting Extension. It allows you to:

• Specify the URLs that HubSpot will use when making webhook requests to your external accounting system.
• Respond to webhook calls made to your external accounting system by HubSpot

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: v3
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

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 accounting "github.com/GIT_USER_ID/GIT_REPO_ID"

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(), accounting.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(), accounting.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 identified 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(), accounting.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), accounting.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.hubapi.com

Class	Method	HTTP request	Description
CallbacksApi	CallbackCreateCustomer	Post /crm/v3/extensions/accounting/callback/customer-create/{requestId}	Endpoint for customer creation response
CallbacksApi	CallbackCreateExchangeRate	Post /crm/v3/extensions/accounting/callback/exchange-rate/{requestId}	Endpoint for exchange rate response
CallbacksApi	CallbackCreateInvoice	Post /crm/v3/extensions/accounting/callback/invoice-create/{requestId}	Endpoint for invoice creation response
CallbacksApi	CallbackCreateTerm	Post /crm/v3/extensions/accounting/callback/terms/{requestId}	Endpoint for terms search response
CallbacksApi	CallbackDoInvoiceSearch	Post /crm/v3/extensions/accounting/callback/invoice-search/{requestId}	Endpoint for invoice search response
CallbacksApi	CallbackDoProductSearch	Post /crm/v3/extensions/accounting/callback/product-search/{requestId}	Endpoint for product search response
CallbacksApi	CallbackDoSearchCustomer	Post /crm/v3/extensions/accounting/callback/customer-search/{requestId}	Endpoint for customer search response
CallbacksApi	CallbackDoTaxSearch	Post /crm/v3/extensions/accounting/callback/tax-search/{requestId}	Endpoint for taxes search response
CallbacksApi	CallbackGetByID	Post /crm/v3/extensions/accounting/callback/invoices/{requestId}	Endpoint for invoice get-by-id response
CallbacksApi	CallbackInvoicePDF	Post /crm/v3/extensions/accounting/callback/invoice-pdf/{requestId}	Endpoint for PDF content of invoice
InvoiceApi	InvoiceCreatePayment	Post /crm/v3/extensions/accounting/invoice/{invoiceId}/payment	Records an invoice payment
InvoiceApi	InvoiceGetByID	Get /crm/v3/extensions/accounting/invoice/{invoiceId}	Get invoice data
InvoiceApi	InvoiceUpdate	Patch /crm/v3/extensions/accounting/invoice/{invoiceId}	Update an invoice
SettingsApi	SettingsGetByID	Get /crm/v3/extensions/accounting/settings/{appId}	Get URL settings
SettingsApi	SettingsReplace	Put /crm/v3/extensions/accounting/settings/{appId}	Add/Update URL Settings
SyncApi	SyncCreateContact	Post /crm/v3/extensions/accounting/sync/{appId}/contacts	Import contacts
SyncApi	SyncCreateProduct	Post /crm/v3/extensions/accounting/sync/{appId}/products	Import products
UserAccountsApi	UserAccountsArchive	Delete /crm/v3/extensions/accounting/user-accounts/{accountId}	Delete user account
UserAccountsApi	UserAccountsReplace	Put /crm/v3/extensions/accounting/user-accounts	Create a user account

Documentation For Models

• AccountingAppSettings
• AccountingAppUrls
• AccountingExtensionCustomer
• AccountingExtensionInvoice
• AccountingExtensionTerm
• AccountingFeatures
• ActionResponse
• Address
• CreateInvoiceFeature
• CreateInvoiceSubFeatures
• CreateUserAccountRequestExternal
• CustomerSearchResponseExternal
• Error
• ErrorDetail
• ExchangeRateResponse
• ImportInvoiceFeature
• InvoiceCreatePaymentRequest
• InvoicePdfResponse
• InvoiceReadResponse
• InvoiceSearchResponse
• InvoiceUpdateRequest
• InvoiceUpdateResponse
• InvoicesResponseExternal
• ObjectSyncFeature
• Product
• ProductSearchResponse
• ResultIdAccountingResponse
• SyncContactsRequest
• SyncProductsRequest
• Tax
• TaxSearchResponse
• TaxType
• TermsResponse
• UnitPrice
• UpdatedContact
• UpdatedProduct

Documentation For Authorization

Authentication schemes defined for the API:

oauth2_legacy

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://app.hubspot.com/oauth/authorize
• Scopes:
• accounting: Invoice Information

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

private_apps_legacy

• Type: API key
• API key parameter name: private-app-legacy
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: private-app-legacy 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