Skip to content

README.md

Latest commit

 

History

History
638 lines (497 loc) · 52.5 KB

README.md

File metadata and controls

638 lines (497 loc) · 52.5 KB

Accounting

Overview

Available Operations

batch_create_company_journals

Batch Create Journals

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.accounting.batch_create_company_journals(accounting_journal_batch_create_request_dto: Models::Shared::AccountingJournalBatchCreateRequestDto.new(
  items: []
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.batch_result_api_model.nil?
  # handle response
end

Parameters

Parameter Type Required Description Example
accounting_journal_batch_create_request_dto Models::Shared::AccountingJournalBatchCreateRequestDto ✔️ N/A
id ::String ✔️ N/A
x_account_id ::String ✔️ The account identifier
prefer T.nilable(::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

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

create_company_journal

Create Journal

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.accounting.create_company_journal(accounting_journal_create_request_dto: Models::Shared::AccountingJournalCreateRequestDto.new(
  currency_code: Models::Shared::CurrencyCode.new(
    source_value: 'USD',
    value: Models::Shared::AccountingJournalCreateRequestDtoValue::USD
  ),
  exchange_rate: 1.0,
  lines: [
    Models::Shared::CreateJournalLine.new(
      account_id: 'acc_123456789',
      amount: 10_010.0,
      description: 'Payment for office supplies',
      tax_amount: 10_010.0,
      tax_rate_id: 'tax_123456789'
    ),
  ],
  memo: 'Monthly closing entries',
  reference: 'JRN-2024-001',
  transaction_date: DateTime.iso8601('2024-03-20T10:00:00Z')
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description Example
accounting_journal_create_request_dto Models::Shared::AccountingJournalCreateRequestDto ✔️ N/A
id ::String ✔️ N/A
x_account_id ::String ✔️ The account identifier
prefer T.nilable(::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

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

get_company

Get Company

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingGetCompanyRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.accounting.get_company(request: req)

unless res.accounting_company_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::AccountingGetCompanyRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

get_company_account

Get Account

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingGetCompanyAccountRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields',
  id: '<id>',
  sub_resource_id: '<id>',
  x_account_id: '<id>'
)
res = s.accounting.get_company_account(request: req)

unless res.accounting_account_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::AccountingGetCompanyAccountRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

get_company_journal

Get Journal

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingGetCompanyJournalRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields',
  id: '<id>',
  sub_resource_id: '<id>',
  x_account_id: '<id>'
)
res = s.accounting.get_company_journal(request: req)

unless res.accounting_journal_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::AccountingGetCompanyJournalRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

get_company_tax_rate

Get Tax Rate

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingGetCompanyTaxRateRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields',
  id: '<id>',
  sub_resource_id: '<id>',
  x_account_id: '<id>'
)
res = s.accounting.get_company_tax_rate(request: req)

unless res.accounting_tax_rate_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::AccountingGetCompanyTaxRateRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

list_companies

List Companies

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingListCompaniesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields',
  filter: Models::Operations::AccountingListCompaniesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.accounting.list_companies(request: req)

unless res.accounting_companies_paginated.nil?
  # handle response
end

Parameters

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

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

list_company_accounts

List Accounts

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingListCompanyAccountsRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields',
  filter: nil,
  id: '<id>',
  x_account_id: '<id>'
)
res = s.accounting.list_company_accounts(request: req)

unless res.accounting_accounts_paginated.nil?
  # handle response
end

Parameters

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

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

list_company_journals

List Journals

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingListCompanyJournalsRequest.new(
  prefer: 'heartbeat',
  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: nil,
  id: '<id>',
  x_account_id: '<id>'
)
res = s.accounting.list_company_journals(request: req)

unless res.accounting_journals_paginated.nil?
  # handle response
end

Parameters

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

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*

list_company_tax_rates

List Tax Rates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::AccountingListCompanyTaxRatesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields',
  filter: Models::Operations::AccountingListCompanyTaxRatesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  id: '<id>',
  x_account_id: '<id>'
)
res = s.accounting.list_company_tax_rates(request: req)

unless res.accounting_tax_rates_paginated.nil?
  # handle response
end

Parameters

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

Response

T.nilable(Models::Operations::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
Errors::APIError 4XX, 5XX */*