Skip to content

Latest commit

 

History

History
787 lines (612 loc) · 57.3 KB

File metadata and controls

787 lines (612 loc) · 57.3 KB

Accounting

Overview

Available Operations

listCompanies

List Companies

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingListCompaniesRequest req = AccountingListCompaniesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields")
                .filter(AccountingListCompaniesQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.accounting().listCompanies()
                .callAsStream()
                .forEach((AccountingListCompaniesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

AccountingListCompaniesResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

getCompany

Get Company

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyRequest;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingGetCompanyRequest req = AccountingGetCompanyRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        AccountingGetCompanyResponse res = sdk.accounting().getCompany()
                .request(req)
                .call();

        if (res.accountingCompanyResult().isPresent()) {
            // 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
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

listCompanyAccounts

List Accounts

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingListCompanyAccountsRequest;
import com.stackone.stackone_client_java.models.operations.AccountingListCompanyAccountsResponse;
import java.lang.Exception;
import org.openapitools.jackson.nullable.JsonNullable;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingListCompanyAccountsRequest req = AccountingListCompanyAccountsRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields")
                .filter(JsonNullable.of(null))
                .prefer("heartbeat")
                .build();


        sdk.accounting().listCompanyAccounts()
                .callAsStream()
                .forEach((AccountingListCompanyAccountsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

AccountingListCompanyAccountsResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

getCompanyAccount

Get Account

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyAccountRequest;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyAccountResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingGetCompanyAccountRequest req = AccountingGetCompanyAccountRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .subResourceId("<id>")
                .fields("id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        AccountingGetCompanyAccountResponse res = sdk.accounting().getCompanyAccount()
                .request(req)
                .call();

        if (res.accountingAccountResult().isPresent()) {
            // 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
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

listCompanyTaxRates

List Tax Rates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingListCompanyTaxRatesRequest req = AccountingListCompanyTaxRatesRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields")
                .filter(AccountingListCompanyTaxRatesQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.accounting().listCompanyTaxRates()
                .callAsStream()
                .forEach((AccountingListCompanyTaxRatesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

AccountingListCompanyTaxRatesResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

getCompanyTaxRate

Get Tax Rate

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyTaxRateRequest;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyTaxRateResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingGetCompanyTaxRateRequest req = AccountingGetCompanyTaxRateRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .subResourceId("<id>")
                .fields("id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        AccountingGetCompanyTaxRateResponse res = sdk.accounting().getCompanyTaxRate()
                .request(req)
                .call();

        if (res.accountingTaxRateResult().isPresent()) {
            // 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
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

batchCreateCompanyJournals

Batch Create Journals

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.AccountingJournalBatchCreateRequestDto;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingBatchCreateCompanyJournalsResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingBatchCreateCompanyJournalsResponse res = sdk.accounting().batchCreateCompanyJournals()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .accountingJournalBatchCreateRequestDto(AccountingJournalBatchCreateRequestDto.builder()
                    .items(List.of())
                    .build())
                .call();

        if (res.batchResultApiModel().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
xAccountId String ✔️ The account identifier
id String ✔️ N/A
prefer Optional<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
accountingJournalBatchCreateRequestDto AccountingJournalBatchCreateRequestDto ✔️ N/A

Response

AccountingBatchCreateCompanyJournalsResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

listCompanyJournals

List Journals

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingListCompanyJournalsRequest;
import com.stackone.stackone_client_java.models.operations.AccountingListCompanyJournalsResponse;
import java.lang.Exception;
import org.openapitools.jackson.nullable.JsonNullable;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingListCompanyJournalsRequest req = AccountingListCompanyJournalsRequest.builder()
                .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(JsonNullable.of(null))
                .prefer("heartbeat")
                .build();


        sdk.accounting().listCompanyJournals()
                .callAsStream()
                .forEach((AccountingListCompanyJournalsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

AccountingListCompanyJournalsResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

createCompanyJournal

Create Journal

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingCreateCompanyJournalResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingCreateCompanyJournalResponse res = sdk.accounting().createCompanyJournal()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .accountingJournalCreateRequestDto(AccountingJournalCreateRequestDto.builder()
                    .reference("JRN-2024-001")
                    .memo("Monthly closing entries")
                    .currencyCode(AccountingJournalCreateRequestDtoCurrencyCode.builder()
                        .value(AccountingJournalCreateRequestDtoValue.USD)
                        .sourceValue(AccountingJournalCreateRequestDtoSourceValue.of("USD"))
                        .build())
                    .exchangeRate(1d)
                    .transactionDate(OffsetDateTime.parse("2024-03-20T10:00:00Z"))
                    .lines(List.of(
                        CreateJournalLine.builder()
                            .accountId("acc_123456789")
                            .description("Payment for office supplies")
                            .amount(10010d)
                            .taxRateId("tax_123456789")
                            .taxAmount(10010d)
                            .build()))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
xAccountId String ✔️ The account identifier
id String ✔️ N/A
prefer Optional<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
accountingJournalCreateRequestDto AccountingJournalCreateRequestDto ✔️ N/A

Response

AccountingCreateCompanyJournalResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

getCompanyJournal

Get Journal

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyJournalRequest;
import com.stackone.stackone_client_java.models.operations.AccountingGetCompanyJournalResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        AccountingGetCompanyJournalRequest req = AccountingGetCompanyJournalRequest.builder()
                .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")
                .build();

        AccountingGetCompanyJournalResponse res = sdk.accounting().getCompanyJournal()
                .request(req)
                .call();

        if (res.accountingJournalResult().isPresent()) {
            // 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
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*