Accounting

Overview

Available Operations

ListCompanies - List Companies
GetCompany - Get Company
ListCompanyAccounts - List Accounts
GetCompanyAccount - Get Account
ListCompanyTaxRates - List Tax Rates
GetCompanyTaxRate - Get Tax Rate
BatchCreateCompanyJournals - Batch Create Journals
ListCompanyJournals - List Journals
CreateCompanyJournal - Create Journal
GetCompanyJournal - Get Journal

ListCompanies

List Companies

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingListCompaniesRequest req = new AccountingListCompaniesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields",
    Filter = new AccountingListCompaniesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

AccountingListCompaniesResponse? res = await sdk.Accounting.ListCompaniesAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AccountingListCompaniesRequest	✔️	The request object to use for the request.

Response

AccountingListCompaniesResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetCompany

Get Company

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingGetCompanyRequest req = new AccountingGetCompanyRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Accounting.GetCompanyAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AccountingGetCompanyRequest	✔️	The request object to use for the request.

Response

AccountingGetCompanyResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListCompanyAccounts

List Accounts

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingListCompanyAccountsRequest req = new AccountingListCompanyAccountsRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields",
    Filter = null,
    Prefer = "heartbeat",
};

AccountingListCompanyAccountsResponse? res = await sdk.Accounting.ListCompanyAccountsAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AccountingListCompanyAccountsRequest	✔️	The request object to use for the request.

Response

AccountingListCompanyAccountsResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetCompanyAccount

Get Account

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingGetCompanyAccountRequest req = new AccountingGetCompanyAccountRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    SubResourceId = "<id>",
    Fields = "id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Accounting.GetCompanyAccountAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AccountingGetCompanyAccountRequest	✔️	The request object to use for the request.

Response

AccountingGetCompanyAccountResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListCompanyTaxRates

List Tax Rates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingListCompanyTaxRatesRequest req = new AccountingListCompanyTaxRatesRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields",
    Filter = new AccountingListCompanyTaxRatesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

AccountingListCompanyTaxRatesResponse? res = await sdk.Accounting.ListCompanyTaxRatesAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AccountingListCompanyTaxRatesRequest	✔️	The request object to use for the request.

Response

AccountingListCompanyTaxRatesResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetCompanyTaxRate

Get Tax Rate

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingGetCompanyTaxRateRequest req = new AccountingGetCompanyTaxRateRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    SubResourceId = "<id>",
    Fields = "id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Accounting.GetCompanyTaxRateAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AccountingGetCompanyTaxRateRequest	✔️	The request object to use for the request.

Response

AccountingGetCompanyTaxRateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

BatchCreateCompanyJournals

Batch Create Journals

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Accounting.BatchCreateCompanyJournalsAsync(
    xAccountId: "<id>",
    id: "<id>",
    accountingJournalBatchCreateRequestDto: new AccountingJournalBatchCreateRequestDto() {
        Items = new List<AccountingJournalCreateRequestDto>() {},
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`AccountingJournalBatchCreateRequestDto`	AccountingJournalBatchCreateRequestDto	✔️	N/A
`Prefer`	string	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

AccountingBatchCreateCompanyJournalsResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListCompanyJournals

List Journals

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingListCompanyJournalsRequest req = new AccountingListCompanyJournalsRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields",
    Filter = null,
    Prefer = "heartbeat",
};

AccountingListCompanyJournalsResponse? res = await sdk.Accounting.ListCompanyJournalsAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AccountingListCompanyJournalsRequest	✔️	The request object to use for the request.

Response

AccountingListCompanyJournalsResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

CreateCompanyJournal

Create Journal

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Accounting.CreateCompanyJournalAsync(
    xAccountId: "<id>",
    id: "<id>",
    accountingJournalCreateRequestDto: new AccountingJournalCreateRequestDto() {
        Reference = "JRN-2024-001",
        Memo = "Monthly closing entries",
        CurrencyCode = new AccountingJournalCreateRequestDtoCurrencyCode() {
            Value = AccountingJournalCreateRequestDtoValue.Usd,
            SourceValue = AccountingJournalCreateRequestDtoSourceValueUnion.CreateStr(
                "USD"
            ),
        },
        ExchangeRate = 1D,
        TransactionDate = System.DateTime.Parse("2024-03-20T10:00:00Z"),
        Lines = new List<CreateJournalLine>() {
            new CreateJournalLine() {
                AccountId = "acc_123456789",
                Description = "Payment for office supplies",
                Amount = 10010D,
                TaxRateId = "tax_123456789",
                TaxAmount = 10010D,
            },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`AccountingJournalCreateRequestDto`	AccountingJournalCreateRequestDto	✔️	N/A
`Prefer`	string	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

AccountingCreateCompanyJournalResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetCompanyJournal

Get Journal

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AccountingGetCompanyJournalRequest req = new AccountingGetCompanyJournalRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    SubResourceId = "<id>",
    Fields = "id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Accounting.GetCompanyJournalAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AccountingGetCompanyJournalRequest	✔️	The request object to use for the request.

Response

AccountingGetCompanyJournalResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Accounting

Overview

Available Operations

ListCompanies

Example Usage

Parameters

Response

Errors

GetCompany

Example Usage

Parameters

Response

Errors

ListCompanyAccounts

Example Usage

Parameters

Response

Errors

GetCompanyAccount

Example Usage

Parameters

Response

Errors

ListCompanyTaxRates

Example Usage

Parameters

Response

Errors

GetCompanyTaxRate

Example Usage

Parameters

Response

Errors

BatchCreateCompanyJournals

Example Usage

Parameters

Response

Errors

ListCompanyJournals

Example Usage

Parameters

Response

Errors

CreateCompanyJournal

Example Usage

Parameters

Response

Errors

GetCompanyJournal

Example Usage

Parameters

Response

Errors