modulepackage
0.24.0
Repository: https://github.com/codatio/client-sdk-go.git
Documentation: pkg.go.dev
# README
Assess
Assess helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from the operating systems they are already using. You can use that data for automating decisioning and surfacing new insights on the customer, all via one API.
SDK Installation
go get github.com/codatio/client-sdk-go/assess
SDK Example Usage
package main
import(
"context"
"log"
"github.com/codatio/client-sdk-go/assess"
"github.com/codatio/client-sdk-go/assess/pkg/models/operations"
)
func main() {
s := codatassess.New(
codatassess.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Categories.GetAccountCategory(ctx, operations.GetAccountCategoryRequest{
AccountID: "corrupti",
CompanyID: "8a210b68-6988-11ed-a1eb-0242ac120002",
ConnectionID: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
})
if err != nil {
log.Fatal(err)
}
if res.CategorisedAccount != nil {
// handle response
}
}
Available Resources and Operations
Categories
GetAccountCategory- Get suggested and/or confirmed category for a specific account :warning: DeprecatedListAccountsCategories- List suggested and confirmed account categories :warning: DeprecatedListAvailableAccountCategories- List account categories :warning: DeprecatedUpdateAccountCategory- Update account categories :warning: DeprecatedUpdateAccountsCategories- Confirm categories for accounts :warning: Deprecated
DataIntegrity
- GetDataIntegrityStatus - Get data integrity status
- GetDataIntegritySummaries - Get data integrity summary
- ListDataTypeDataIntegrityDetails - List data type data integrity
ExcelReports
- GenerateExcelReport - Generate Excel report
- GetAccountingMarketingMetrics - Get marketing metrics report
- GetExcelReport - Download Excel report
- GetExcelReportGenerationStatus - Get Excel report status
Reports
- GetAccountsForEnhancedBalanceSheet - Get enhanced balance sheet accounts
- GetAccountsForEnhancedProfitAndLoss - Get enhanced profit and loss accounts
- GetCommerceCustomerRetentionMetrics - Get customer retention metrics
- GetCommerceLifetimeValueMetrics - Get lifetime value metric
- GetCommerceOrdersMetrics - Get orders report
- GetCommerceRefundsMetrics - Get refunds report
- GetCommerceRevenueMetrics - Get commerce revenue metrics
GetEnhancedBalanceSheet- Get enhanced balance sheet report :warning: Deprecated- GetEnhancedCashFlowTransactions - Get enhanced cash flow report
GetEnhancedFinancialMetrics- List financial metrics :warning: Deprecated- GetEnhancedInvoicesReport - Get enhanced invoices report
GetEnhancedProfitAndLoss- Get enhanced profit and loss report :warning: Deprecated- GetLoanSummary - Get enhanced loan summaries
- GetRecurringRevenueMetrics - Get key subscription revenue metrics
- ListLoanTransactions - List enhanced loan transactions
- RequestRecurringRevenueMetrics - Generate key subscription revenue metrics
SDK Generated by Speakeasy
# Packages
No description provided by the author
# Functions
Bool provides a helper function to return a pointer to a bool.
Float32 provides a helper function to return a pointer to a float32.
Float64 provides a helper function to return a pointer to a float64.
Int provides a helper function to return a pointer to an int.
Int64 provides a helper function to return a pointer to an int64.
New creates a new instance of the SDK with the provided options.
String provides a helper function to return a pointer to a string.
WithClient allows the overriding of the default HTTP client used by the SDK.
WithSecurity configures the SDK to use the provided security details.
WithServerIndex allows the overriding of the default server by index.
WithServerURL allows the overriding of the default server URL.
WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters.
# Variables
ServerList contains the list of servers available to the SDK.
# Structs
CodatAssess - Assess API: Codat's financial insights API Codat's Assess API enable you to make smarter credit decisions on your small business customers.
# Interfaces
HTTPClient provides an interface for suplying the SDK with a custom HTTP client.
# Type aliases
No description provided by the author