StandoutFortnox::InvoicesApi

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

Method	HTTP request	Description
add_invoice	POST /invoices	Add an invoice
bookkeep_invoice	PUT /invoices/{documentNumber}/bookkeep	Bookkeep an invoice
cancel_invoice	PUT /invoices/{documentNumber}/cancel	Cancel an invoice
credit_invoice	PUT /invoices/{documentNumber}/credit	Credit an invoice
e_invoice	GET /invoices/{documentNumber}/einvoice	Send an e-invoice
email_invoice	GET /invoices/{documentNumber}/email	Email an invoice
external_print_invoice	PUT /invoices/{documentNumber}/externalprint	Mark invoice as 'Sent' without generating a PDF
get_cancelled_invoices	GET /invoices/?filter=cancelled	Get all cancelled invoices
get_fully_paid_invoices	GET /invoices/?filter=fullypaid	Get all fully paid invoices
get_invoice	GET /invoices/{documentNumber}	Get a specific invoice
get_invoices	GET /invoices	Get all invoices
get_unbooked_invoices	GET /invoices/?filter=unbooked	Get all unbooked invoices
get_unpaid_and_overdue_invoices	GET /invoices/?filter=unpaidoverdue	Get all unpaid and overdue invoices
get_unpaid_invoices	GET /invoices/?filter=unpaid	Get all unpaid invoices
preview_invoice	GET /invoices/{documentNumber}/preview	Preview an invoice
print_invoice	GET /invoices/{documentNumber}/print	Print an invoice
print_invoice_reminder	GET /invoices/{documentNumber}/printreminder	Print an invoice reminder
update_invoice	PUT /invoices/{documentNumber}	Update invoice

add_invoice

Invoice add_invoice(body)

Add an invoice

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

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


begin
  #Add an invoice
  result = api_instance.add_invoice(body)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->add_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Invoice	Invoice object that needs to be added

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

bookkeep_invoice

Invoice bookkeep_invoice(document_number)

Bookkeep an invoice

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Bookkeep an invoice
  result = api_instance.bookkeep_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->bookkeep_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

cancel_invoice

Invoice cancel_invoice(document_number)

Cancel an invoice

Cancels an invoice (same as “Makulerad” in the GUI)

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Cancel an invoice
  result = api_instance.cancel_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->cancel_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

credit_invoice

Invoice credit_invoice(document_number)

Credit an invoice

Creates a credit invoice from the provided invoice. The created credit invoice will be referenced in the property CreditInvoiceReference.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Credit an invoice
  result = api_instance.credit_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->credit_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

e_invoice

Invoice e_invoice(document_number)

Send an e-invoice

Sends an e-invoice to the customer with an attached PDF document of the invoice. Note that this action also sets the property Sent as true.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Send an e-invoice
  result = api_instance.e_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->e_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

email_invoice

Invoice email_invoice(document_number)

Email an invoice

Sends an e-mail to the customer with an attached PDF document of the invoice. You can use the properties in the EmailInformation to customize the e-mail message on each invoice.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Email an invoice
  result = api_instance.email_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->email_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

external_print_invoice

Invoice external_print_invoice(document_number)

Mark invoice as 'Sent' without generating a PDF

This action is used to set the field Sent as true from an external system without generating a PDF.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Mark invoice as 'Sent' without generating a PDF
  result = api_instance.external_print_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->external_print_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_cancelled_invoices

Invoices get_cancelled_invoices

Get all cancelled invoices

Retrieves all invoices with the status 'cancelled'

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

begin
  #Get all cancelled invoices
  result = api_instance.get_cancelled_invoices
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->get_cancelled_invoices: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Invoices

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_fully_paid_invoices

Invoices get_fully_paid_invoices

Get all fully paid invoices

Retrieves all invoices that has been fully paid

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

begin
  #Get all fully paid invoices
  result = api_instance.get_fully_paid_invoices
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->get_fully_paid_invoices: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Invoices

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_invoice

Invoice get_invoice(document_number)

Get a specific invoice

Retrieves the details of an invoice. You need to supply the unique document number that was returned when the invoice was created or retrieved from the list of invoices.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Get a specific invoice
  result = api_instance.get_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->get_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_invoices

Invoices get_invoices(opts)

Get all invoices

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

opts = { 
  filter: nil, # Object | Retrieves all invoices matching given filter
  offset: nil, # Object | 
  limit: nil, # Object | 
  sortby: nil, # Object | Which property to sort by, must be defined as sortable in documentation
  sortorder: nil, # Object | 
  page: nil, # Object | 
  lastmodified: nil, # Object | Retrieves all records since the provided timestamp
  fromdate: nil, # Object | Defines a selection based on a start date.
  todate: nil, # Object | Defines a selection based on an end date.
  costcenter: nil, # Object | Get only invoices inluding given value for CostCenter
  currency: nil, # Object | Get only invoices inluding given value for Currency
  customername: nil, # Object | Get only invoices inluding given value for CustomerName
  customernumber: nil, # Object | Get only invoices inluding given value for CustomerNumber
  documentnumber: nil, # Object | Get only invoices inluding given value for DocumentNumber
  externalinvoicereference1: nil, # Object | Get only invoices inluding given value for ExternalInvoiceReference1
  externalinvoicereference2: nil, # Object | Get only invoices inluding given value for ExternalInvoiceReference2
  ocr: nil, # Object | Get only invoices inluding given value for OCR
  ourreference: nil, # Object | Get only invoices inluding given value for OurReference
  project: nil, # Object | Get only invoices inluding given value for Project
  yourordernumber: nil, # Object | Get only invoices inluding given value for YourOrderNumber
  yourreference: nil # Object | Get only invoices inluding given value for YourReference
}

begin
  #Get all invoices
  result = api_instance.get_invoices(opts)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->get_invoices: #{e}"
end

Parameters

Name	Type	Description	Notes
filter	Object	Retrieves all invoices matching given filter	[optional]
offset	Object		[optional]
limit	Object		[optional]
sortby	Object	Which property to sort by, must be defined as sortable in documentation	[optional]
sortorder	Object		[optional]
page	Object		[optional]
lastmodified	Object	Retrieves all records since the provided timestamp	[optional]
fromdate	Object	Defines a selection based on a start date.	[optional]
todate	Object	Defines a selection based on an end date.	[optional]
costcenter	Object	Get only invoices inluding given value for CostCenter	[optional]
currency	Object	Get only invoices inluding given value for Currency	[optional]
customername	Object	Get only invoices inluding given value for CustomerName	[optional]
customernumber	Object	Get only invoices inluding given value for CustomerNumber	[optional]
documentnumber	Object	Get only invoices inluding given value for DocumentNumber	[optional]
externalinvoicereference1	Object	Get only invoices inluding given value for ExternalInvoiceReference1	[optional]
externalinvoicereference2	Object	Get only invoices inluding given value for ExternalInvoiceReference2	[optional]
ocr	Object	Get only invoices inluding given value for OCR	[optional]
ourreference	Object	Get only invoices inluding given value for OurReference	[optional]
project	Object	Get only invoices inluding given value for Project	[optional]
yourordernumber	Object	Get only invoices inluding given value for YourOrderNumber	[optional]
yourreference	Object	Get only invoices inluding given value for YourReference	[optional]

Return type

Invoices

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

get_unbooked_invoices

Invoices get_unbooked_invoices

Get all unbooked invoices

Retrieves all invoices that is unbooked

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

begin
  #Get all unbooked invoices
  result = api_instance.get_unbooked_invoices
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->get_unbooked_invoices: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Invoices

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_unpaid_and_overdue_invoices

Invoices get_unpaid_and_overdue_invoices

Get all unpaid and overdue invoices

Retrieves all invoices that is unpaid and overdue

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

begin
  #Get all unpaid and overdue invoices
  result = api_instance.get_unpaid_and_overdue_invoices
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->get_unpaid_and_overdue_invoices: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Invoices

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_unpaid_invoices

Invoices get_unpaid_invoices

Get all unpaid invoices

Retrieves all invoices that is unpaid

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

begin
  #Get all unpaid invoices
  result = api_instance.get_unpaid_invoices
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->get_unpaid_invoices: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Invoices

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

preview_invoice

Invoice preview_invoice(document_number)

Preview an invoice

This action returns a PDF document with the current template that is used by the specific document. Unliike the action print, this action doesn’t set the property Sent as true.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Preview an invoice
  result = api_instance.preview_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->preview_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

print_invoice

Invoice print_invoice(document_number)

Print an invoice

This action returns a PDF document with the current template that is used by the specific document. Note that this action also sets the property Sent as true.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Print an invoice
  result = api_instance.print_invoice(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->print_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

print_invoice_reminder

Invoice print_invoice_reminder(document_number)

Print an invoice reminder

This action returns a PDF document with the current reminder template that is used by the specific document. Note that this action also sets the property Sent as true.

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | Document number


begin
  #Print an invoice reminder
  result = api_instance.print_invoice_reminder(document_number)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->print_invoice_reminder: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	Document number

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_invoice

Invoice update_invoice(document_number, body)

Update invoice

Update an invoice, find by document number

Example

# load the gem
require 'standout_fortnox'

api_instance = StandoutFortnox::InvoicesApi.new

document_number = 56 # Integer | documentNumber of invoice to update

body = StandoutFortnox::Invoice.new # Invoice | Invoice object to be updated


begin
  #Update invoice
  result = api_instance.update_invoice(document_number, body)
  p result
rescue StandoutFortnox::ApiError => e
  puts "Exception when calling InvoicesApi->update_invoice: #{e}"
end

Parameters

Name	Type	Description	Notes
document_number	Integer	documentNumber of invoice to update
body	Invoice	Invoice object to be updated

Return type

Invoice

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

InvoicesApi.md

Latest commit

History

InvoicesApi.md

File metadata and controls

StandoutFortnox::InvoicesApi

add_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

bookkeep_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

credit_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

e_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

email_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

external_print_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

get_cancelled_invoices

Example

Parameters

Return type

Authorization

HTTP request headers

get_fully_paid_invoices

Example

Parameters

Return type

Authorization

HTTP request headers

get_invoice

Example

Parameters

Return type

Authorization

HTTP request headers

get_invoices

Example

Parameters

Return type

Authorization

HTTP request headers

get_unbooked_invoices

Example

Parameters

Return type

Authorization

HTTP request headers

get_unpaid_and_overdue_invoices