TrackingCategories

(Accounting.TrackingCategories)

Overview

Available Operations

List - List Tracking Categories
Create - Create Tracking Category
Get - Get Tracking Category
Update - Update Tracking Category
Delete - Delete Tracking Category

List

List Tracking Categories

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.Accounting.TrackingCategories.List(ctx, operations.AccountingTrackingCategoriesAllRequest{
        ServiceID: sdkgo.String("salesforce"),
        PassThrough: map[string]any{
            "search": "San Francisco",
        },
        Fields: sdkgo.String("id,updated_at"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetTrackingCategoriesResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.AccountingTrackingCategoriesAllRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.AccountingTrackingCategoriesAllResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Create

Create Tracking Category

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.Accounting.TrackingCategories.Create(ctx, components.TrackingCategoryInput{
        ParentID: sdkgo.String("12345"),
        Name: sdkgo.String("Department"),
        Code: sdkgo.String("100"),
        Status: components.TrackingCategoryStatusActive.ToPointer(),
        RowVersion: sdkgo.String("1-12345"),
        PassThrough: []components.PassThroughBody{
            components.PassThroughBody{
                ServiceID: "<id>",
                ExtendPaths: []components.ExtendPaths{
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                },
            },
        },
    }, nil, sdkgo.String("salesforce"))
    if err != nil {
        log.Fatal(err)
    }
    if res.CreateTrackingCategoryResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`trackingCategory`	components.TrackingCategoryInput	✔️	N/A
`raw`	*bool	➖	Include raw response. Mostly used for debugging purposes
`serviceID`	*string	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.AccountingTrackingCategoriesAddResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Get

Get Tracking Category

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.Accounting.TrackingCategories.Get(ctx, "<id>", sdkgo.String("salesforce"), nil, sdkgo.String("id,updated_at"))
    if err != nil {
        log.Fatal(err)
    }
    if res.GetTrackingCategoryResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`id`	string	✔️	ID of the record you are acting upon.
`serviceID`	*string	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`raw`	*bool	➖	Include raw response. Mostly used for debugging purposes
`fields`	*string	➖	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	id,updated_at
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.AccountingTrackingCategoriesOneResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Update

Update Tracking Category

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.Accounting.TrackingCategories.Update(ctx, "<id>", components.TrackingCategoryInput{
        ParentID: sdkgo.String("12345"),
        Name: sdkgo.String("Department"),
        Code: sdkgo.String("100"),
        Status: components.TrackingCategoryStatusActive.ToPointer(),
        RowVersion: sdkgo.String("1-12345"),
        PassThrough: []components.PassThroughBody{
            components.PassThroughBody{
                ServiceID: "<id>",
                ExtendPaths: []components.ExtendPaths{
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                },
            },
            components.PassThroughBody{
                ServiceID: "<id>",
                ExtendPaths: []components.ExtendPaths{
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                },
            },
            components.PassThroughBody{
                ServiceID: "<id>",
                ExtendPaths: []components.ExtendPaths{
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                    components.ExtendPaths{
                        Path: "$.nested.property",
                        Value: map[string]any{
                            "TaxClassificationRef": map[string]any{
                                "value": "EUC-99990201-V1-00020000",
                            },
                        },
                    },
                },
            },
        },
    }, sdkgo.String("salesforce"), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateTrackingCategoryResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`id`	string	✔️	ID of the record you are acting upon.
`trackingCategory`	components.TrackingCategoryInput	✔️	N/A
`serviceID`	*string	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`raw`	*bool	➖	Include raw response. Mostly used for debugging purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.AccountingTrackingCategoriesUpdateResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Delete

Delete Tracking Category

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.Accounting.TrackingCategories.Delete(ctx, "<id>", sdkgo.String("salesforce"), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.DeleteTrackingCategoryResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`id`	string	✔️	ID of the record you are acting upon.
`serviceID`	*string	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`raw`	*bool	➖	Include raw response. Mostly used for debugging purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.AccountingTrackingCategoriesDeleteResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

TrackingCategories

Overview

Available Operations

List

Example Usage

Parameters

Response

Errors

Create

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Response

Errors

Files

README.md

Latest commit

History

README.md

File metadata and controls

TrackingCategories

Overview

Available Operations

List

Example Usage

Parameters

Response

Errors

Create

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Response

Errors