Beanie - the Ruby gem for the Beanie ERP API
An API specification for interacting with the Beanie ERP system
This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.8
- Package version: 0.8.1
- Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://bean.ie/help/api
To build the Ruby code into a gem:
gem build beanie.gemspec
Then either install the gem locally:
gem install ./beanie-0.8.1.gem
(for development, run gem install --dev ./beanie-0.8.1.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'beanie', '~> 0.8.1'
If the Ruby gem is hosted at a git repository: https://github.com/altoyield/ruby-beanieclient, then add the following in the Gemfile:
gem 'beanie', :git => 'https://github.com/altoyield/ruby-beanieclient.git'
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'beanie'
# Setup authorization
Beanie.configure do |config|
# Configure API key authorization: api_key
config.api_key['ApiKey'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['ApiKey'] = 'Bearer'
end
api_instance = Beanie::AddressBlockApi.new
address_blocks = Beanie::AddressBlockInput.new # AddressBlockInput | Address block to add to the system
begin
result = api_instance.add_address_block(address_blocks)
p result
rescue Beanie::ApiError => e
puts "Exception when calling AddressBlockApi->add_address_block: #{e}"
end
All URIs are relative to https://bean.ie
Class | Method | HTTP request | Description |
---|---|---|---|
Beanie::AddressBlockApi | add_address_block | POST /address_blocks | |
Beanie::AddressBlockApi | find_address_block_by_id | GET /address_blocks/{id} | Find Address block by ID |
Beanie::AddressBlockApi | find_address_blocks | GET /address_blocks | All address block |
Beanie::BankAccountApi | add_bank_account | POST /bank_accounts | |
Beanie::BankAccountApi | find_bank_account_by_id | GET /bank_accounts/{id} | Find Bank Account by ID |
Beanie::BankAccountApi | find_bank_accounts | GET /bank_accounts | All bank accounts |
Beanie::BankStatementApi | add_bank_statement | POST /bank_statements | |
Beanie::BankStatementApi | find_bank_statement_by_id | GET /bank_statements/{id} | Find Bank statement by ID |
Beanie::BankStatementApi | find_bank_statements | GET /bank_statements | All bank statement |
Beanie::BeanieTaskApi | add_beanie_task | POST /beanie_tasks | |
Beanie::BeanieTaskApi | find_beanie_task_by_id | GET /beanie_tasks/{id} | Find Beanie task by ID |
Beanie::BeanieTaskApi | find_beanie_tasks | GET /beanie_tasks | All beanie task |
Beanie::BillOfMaterialsApi | add_bill_of_material | POST /bill_of_materials | |
Beanie::BillOfMaterialsApi | find_bill_of_material_by_id | GET /bill_of_materials/{id} | Find Bill of Materials by ID |
Beanie::BillOfMaterialsApi | find_bill_of_materials | GET /bill_of_materials | All bill of materials |
Beanie::BillableApi | add_billable | POST /billables | |
Beanie::BillableApi | find_billable_by_id | GET /billables/{id} | Find Billable record by ID |
Beanie::BillableApi | find_billables | GET /billables | All billable record |
Beanie::CompanyApi | find_company_by_id | GET /companies/{id} | Find Company details by ID |
Beanie::DeliveryNoteApi | add_delivery_note | POST /delivery_notes | |
Beanie::DeliveryNoteApi | find_delivery_note_by_id | GET /delivery_notes/{id} | Find Delivery note by ID |
Beanie::DeliveryNoteApi | find_delivery_notes | GET /delivery_notes | All delivery note |
Beanie::DocumentApi | add_document | POST /documents | |
Beanie::DocumentApi | find_document_by_id | GET /documents/{id} | Find Document by ID |
Beanie::DocumentApi | find_documents | GET /documents | All document |
Beanie::FixedAssetApi | add_fixed_asset | POST /fixed_assets | |
Beanie::FixedAssetApi | find_fixed_asset_by_id | GET /fixed_assets/{id} | Find Fixed asset by ID |
Beanie::FixedAssetApi | find_fixed_assets | GET /fixed_assets | All fixed asset |
Beanie::ImageApi | add_image | POST /images | |
Beanie::ImageApi | find_image_by_id | GET /images/{id} | Find Image by ID |
Beanie::ImageApi | find_images | GET /images | All image |
Beanie::JournalApi | add_journal | POST /journals | |
Beanie::JournalApi | find_journal_by_id | GET /journals/{id} | Find Journal by ID |
Beanie::JournalApi | find_journals | GET /journals | All journal |
Beanie::NominalAccountApi | add_nominal_account | POST /nominal_accounts | |
Beanie::NominalAccountApi | find_nominal_account_by_id | GET /nominal_accounts/{id} | Find Nominal account by ID |
Beanie::NominalAccountApi | find_nominal_accounts | GET /nominal_accounts | All nominal account |
Beanie::NominalAccountCategoryApi | add_nominal_account_category | POST /nominal_account_categories | |
Beanie::NominalAccountCategoryApi | find_nominal_account_categories | GET /nominal_account_categories | All nominal account category |
Beanie::NominalAccountCategoryApi | find_nominal_account_category_by_id | GET /nominal_account_categories/{id} | Find Nominal account category by ID |
Beanie::PartnerApi | add_partner | POST /partners | |
Beanie::PartnerApi | find_partner_by_id | GET /partners/{id} | Find Partner by ID |
Beanie::PartnerApi | find_partners | GET /partners | All partners |
Beanie::PartnerAddressApi | add_partner_address | POST /partner_addresses | |
Beanie::PartnerAddressApi | find_partner_address_by_id | GET /partner_addresses/{id} | Find Partner address by ID |
Beanie::PartnerAddressApi | find_partner_addresses | GET /partner_addresses | All partner address |
Beanie::ProductApi | add_product | POST /products | |
Beanie::ProductApi | find_product_by_id | GET /products/{id} | Find Product by ID |
Beanie::ProductApi | find_products | GET /products | All product |
Beanie::ProductCategoryApi | add_product_category | POST /product_categories | |
Beanie::ProductCategoryApi | find_product_categories | GET /product_categories | All product category |
Beanie::ProductCategoryApi | find_product_category_by_id | GET /product_categories/{id} | Find Product category by ID |
Beanie::ProductPriceApi | add_product_price | POST /product_prices | |
Beanie::ProductPriceApi | find_product_price_by_id | GET /product_prices/{id} | Find Product price by ID |
Beanie::ProductPriceApi | find_product_prices | GET /product_prices | All product price |
Beanie::ProductVariantApi | add_product_variant | POST /product_variants | |
Beanie::ProductVariantApi | find_product_variant_by_id | GET /product_variants/{id} | Find Product variant by ID |
Beanie::ProductVariantApi | find_product_variants | GET /product_variants | All product variant |
Beanie::ProductionOrderApi | add_production_order | POST /production_orders | |
Beanie::ProductionOrderApi | find_production_order_by_id | GET /production_orders/{id} | Find Production order by ID |
Beanie::ProductionOrderApi | find_production_orders | GET /production_orders | All production order |
Beanie::PurchaseInvoiceApi | add_purchase_invoice | POST /purchase_invoices | |
Beanie::PurchaseInvoiceApi | find_purchase_invoice_by_id | GET /purchase_invoices/{id} | Find Purchase invoice by ID |
Beanie::PurchaseInvoiceApi | find_purchase_invoices | GET /purchase_invoices | All purchase invoice |
Beanie::PurchaseOrderApi | add_purchase_order | POST /purchase_orders | |
Beanie::PurchaseOrderApi | find_purchase_order_by_id | GET /purchase_orders/{id} | Find Purchase order by ID |
Beanie::PurchaseOrderApi | find_purchase_orders | GET /purchase_orders | All purchase order |
Beanie::SalesInvoiceApi | add_sales_invoice | POST /sales_invoices | |
Beanie::SalesInvoiceApi | find_sales_invoice_by_id | GET /sales_invoices/{id} | Find Sales invoice by ID |
Beanie::SalesInvoiceApi | find_sales_invoices | GET /sales_invoices | All sales invoice |
Beanie::SalesOrderApi | add_sales_order | POST /sales_orders | |
Beanie::SalesOrderApi | find_sales_order | GET /sales_orders | All sales order |
Beanie::SalesOrderApi | find_sales_order_by_id | GET /sales_orders/{id} | Find Sales order by ID |
Beanie::ShippingCentreApi | add_shipping_centre | POST /shipping_centres | |
Beanie::ShippingCentreApi | find_shipping_centre_by_id | GET /shipping_centres/{id} | Find Shipping centre by ID |
Beanie::ShippingCentreApi | find_shipping_centres | GET /shipping_centres | All shipping centre |
Beanie::StockAdjustmentApi | add_stock_adjustment | POST /stock_adjustments | |
Beanie::StockAdjustmentApi | find_stock_adjustment_by_id | GET /stock_adjustments/{id} | Find Stock adjustment by ID |
Beanie::StockAdjustmentApi | find_stock_adjustments | GET /stock_adjustments | All stock adjustment |
Beanie::StockCategoryApi | add_stock_category | POST /stock_categories | |
Beanie::StockCategoryApi | find_stock_categories | GET /stock_categories | All stock category |
Beanie::StockCategoryApi | find_stock_category_by_id | GET /stock_categories/{id} | Find Stock category by ID |
Beanie::StockItemApi | add_stock_item | POST /stock_items | |
Beanie::StockItemApi | find_stock_item_by_id | GET /stock_items/{id} | Find Stock item by ID |
Beanie::StockItemApi | find_stock_items | GET /stock_items | All stock item |
Beanie::StockLocationApi | add_stock_location | POST /stock_locations | |
Beanie::StockLocationApi | find_stock_location_by_id | GET /stock_locations/{id} | Find Stock location by ID |
Beanie::StockLocationApi | find_stock_locations | GET /stock_locations | All stock location |
Beanie::StockSupplierApi | add_stock_supplier | POST /stock_suppliers | |
Beanie::StockSupplierApi | find_stock_supplier_by_id | GET /stock_suppliers/{id} | Find Stock supplier by ID |
Beanie::StockSupplierApi | find_stock_suppliers | GET /stock_suppliers | All stock supplier |
Beanie::VatRecordApi | add_vat_record | POST /vat_records | |
Beanie::VatRecordApi | find_vat_record_by_id | GET /vat_records/{id} | Find VAT record by ID |
Beanie::VatRecordApi | find_vat_records | GET /vat_records | All vat record |
Beanie::VatReturnApi | add_vat_return | POST /vat_returns | |
Beanie::VatReturnApi | find_vat_return_by_id | GET /vat_returns/{id} | Find VAT return by ID |
Beanie::VatReturnApi | find_vat_returns | GET /vat_returns | All vat return |
Beanie::WorkCentreApi | find_work_centre_by_id | GET /work_centres/{id} | Find Work centre by ID |
Beanie::WorkCentreApi | find_work_centres | GET /work_centre_groups/{work_centre_group_id}/work_centres | All work centre |
Beanie::WorkCentreGroupApi | find_work_centre_group_by_id | GET /work_centre_groups/{id} | Find Work centre group by ID |
Beanie::WorkCentreGroupApi | find_work_centre_groups | GET /work_centre_groups | All work centre group |
- Beanie::AddressBlock
- Beanie::BankAccountInput
- Beanie::BankStatement
- Beanie::BankStatementData
- Beanie::BeanieTask
- Beanie::BillOfMaterial
- Beanie::Billable
- Beanie::BomItem
- Beanie::Company
- Beanie::DeliveryNote
- Beanie::DeliveryNoteItem
- Beanie::Document
- Beanie::ErrorModel
- Beanie::FiscalYear
- Beanie::FixedAsset
- Beanie::GoodsReceivedNote
- Beanie::Image
- Beanie::Journal
- Beanie::JournalItem
- Beanie::NominalAccount
- Beanie::NominalAccountCategory
- Beanie::PartnerAddress
- Beanie::PartnerInput
- Beanie::PartnerNote
- Beanie::PayablesLedger
- Beanie::Product
- Beanie::ProductCategory
- Beanie::ProductPrice
- Beanie::ProductVariant
- Beanie::ProductionOrderInput
- Beanie::ProductionOrderLog
- Beanie::PurchaseInvoice
- Beanie::PurchaseOrder
- Beanie::PurchaseOrderItem
- Beanie::ReceivablesLedger
- Beanie::SalesInvoice
- Beanie::SalesInvoiceItem
- Beanie::SalesOrder
- Beanie::SalesOrderItem
- Beanie::ShippingCentre
- Beanie::StockAdjustment
- Beanie::StockCategory
- Beanie::StockItem
- Beanie::StockLocation
- Beanie::StockSupplier
- Beanie::VatRecord
- Beanie::VatReturn
- Beanie::WorkCentre
- Beanie::WorkCentreGroup
- Beanie::AddressBlockInput
- Beanie::BankAccount
- Beanie::BankStatementDataInput
- Beanie::BankStatementInput
- Beanie::BeanieTaskInput
- Beanie::BillOfMaterialInput
- Beanie::BillableInput
- Beanie::BomItemInput
- Beanie::DeliveryNoteInput
- Beanie::DeliveryNoteItemInput
- Beanie::DocumentInput
- Beanie::FixedAssetInput
- Beanie::GoodsReceivedNoteInput
- Beanie::ImageInput
- Beanie::JournalInput
- Beanie::JournalItemInput
- Beanie::NominalAccountCategoryInput
- Beanie::NominalAccountInput
- Beanie::Partner
- Beanie::PartnerAddressInput
- Beanie::ProductCategoryInput
- Beanie::ProductInput
- Beanie::ProductPriceInput
- Beanie::ProductVariantInput
- Beanie::ProductionOrder
- Beanie::PurchaseInvoiceInput
- Beanie::PurchaseOrderInput
- Beanie::PurchaseOrderItemInput
- Beanie::SalesInvoiceInput
- Beanie::SalesInvoiceItemInput
- Beanie::SalesOrderInput
- Beanie::SalesOrderItemInput
- Beanie::ShippingCentreInput
- Beanie::StockAdjustmentInput
- Beanie::StockCategoryInput
- Beanie::StockItemInput
- Beanie::StockLocationInput
- Beanie::StockSupplierInput
- Beanie::VatRecordInput
- Beanie::VatReturnInput
- Type: API key
- API key parameter name: ApiKey
- Location: HTTP header