Skip to content

Latest commit

 

History

History
161 lines (125 loc) · 9.79 KB

README.md

File metadata and controls

161 lines (125 loc) · 9.79 KB
Raw

standout_fortnox

StandoutFortnox - the Ruby gem for the Fortnox Swagger

Fortnox API Swagger

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 3
  • Package version: 2.1.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build standout_fortnox.gemspec

Then either install the gem locally:

gem install ./standout_fortnox-2.1.0.gem

(for development, run gem install --dev ./standout_fortnox-2.1.0.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 'standout_fortnox', '~> 2.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'standout_fortnox', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::CustomersApi.new

body = StandoutFortnox::Customers.new # Customers | Customer object that needs to be added


begin
  #Create customer
  result = api_instance.add_customer(body)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling CustomersApi->add_customer: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.fortnox.se/3

Class Method HTTP request Description
StandoutFortnox::CustomersApi add_customer POST /customers Create customer
StandoutFortnox::CustomersApi delete_customer DELETE /customers/{customerId} Delete customer
StandoutFortnox::CustomersApi get_active_customers GET /customers/?filter=active Check for active customers
StandoutFortnox::CustomersApi get_customer GET /customers/{customerId} Get customer by Id
StandoutFortnox::CustomersApi get_customers GET /customers Get all customers
StandoutFortnox::CustomersApi get_inactive_customers GET /customers/?filter=inactive Check for inactive customers
StandoutFortnox::CustomersApi update_customer PUT /customers/{customerId} Update customer
StandoutFortnox::EmployeesApi add_employee POST /employees Create employee
StandoutFortnox::EmployeesApi update_employee PUT /employees/{EmployeeId} Update employee
StandoutFortnox::InvoicePaymentsApi add_invoice_payment POST /invoicepayments Creates an invoice payment
StandoutFortnox::InvoicePaymentsApi bookkeep_invoice_payment PUT /invoicepayments/{Number}/bookkeep Bookkeeps the invoice payment
StandoutFortnox::InvoicePaymentsApi get_invoice_payment GET /invoicepayments/{Number} Retrieves a single invoice payment
StandoutFortnox::InvoicePaymentsApi remove_invoice_payment DELETE /invoicepayments/{Number} Removes an invoice payment
StandoutFortnox::InvoicePaymentsApi update_invoice_payment PUT /invoicepayments/{Number} Updates an invoice payment
StandoutFortnox::InvoicesApi add_invoice POST /invoices Add an invoice
StandoutFortnox::InvoicesApi bookkeep_invoice PUT /invoices/{documentNumber}/bookkeep Bookkeep an invoice
StandoutFortnox::InvoicesApi cancel_invoice PUT /invoices/{documentNumber}/cancel Cancel an invoice
StandoutFortnox::InvoicesApi credit_invoice PUT /invoices/{documentNumber}/credit Credit an invoice
StandoutFortnox::InvoicesApi e_invoice GET /invoices/{documentNumber}/einvoice Send an e-invoice
StandoutFortnox::InvoicesApi email_invoice GET /invoices/{documentNumber}/email Email an invoice
StandoutFortnox::InvoicesApi external_print_invoice PUT /invoices/{documentNumber}/externalprint Mark invoice as 'Sent' without generating a PDF
StandoutFortnox::InvoicesApi get_cancelled_invoices GET /invoices/?filter=cancelled Get all cancelled invoices
StandoutFortnox::InvoicesApi get_fully_paid_invoices GET /invoices/?filter=fullypaid Get all fully paid invoices
StandoutFortnox::InvoicesApi get_invoice GET /invoices/{documentNumber} Get a specific invoice
StandoutFortnox::InvoicesApi get_invoices GET /invoices Get all invoices
StandoutFortnox::InvoicesApi get_unbooked_invoices GET /invoices/?filter=unbooked Get all unbooked invoices
StandoutFortnox::InvoicesApi get_unpaid_and_overdue_invoices GET /invoices/?filter=unpaidoverdue Get all unpaid and overdue invoices
StandoutFortnox::InvoicesApi get_unpaid_invoices GET /invoices/?filter=unpaid Get all unpaid invoices
StandoutFortnox::InvoicesApi preview_invoice GET /invoices/{documentNumber}/preview Preview an invoice
StandoutFortnox::InvoicesApi print_invoice GET /invoices/{documentNumber}/print Print an invoice
StandoutFortnox::InvoicesApi print_invoice_reminder GET /invoices/{documentNumber}/printreminder Print an invoice reminder
StandoutFortnox::InvoicesApi update_invoice PUT /invoices/{documentNumber} Update invoice
StandoutFortnox::OrdersApi get_order GET /orders/{documentNumber} Get a specific order
StandoutFortnox::OrdersApi update_order PUT /orders/{documentNumber} Update order
StandoutFortnox::VouchersApi add_voucher POST /vouchers Create a voucher

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.