Arsredovisning Online API

An API to create and update annual reports. Spec: http://dev.arsredovisning-online.se/arsredovisning_online_api.yaml
More information: https://www.arsredovisning-online.se
Contact Info: kontakt@arsredovisning-online.se
Version: 1.1.0
N/A
https://www.arsredovisning-online.se

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
post /api/create_account
Creates a user account. (createAccount)
Creates a user account with the provided email address.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UserAccount (required)
Body Parameter

Responses

200

OK. The user account was created.

409

Conflict. The user has already created an account with the given email address.

Up
post /api/create_or_update_report
Creates or updates an annual report. (createOrUpdateReport)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Access-Token (optional)
Header Parameter

Form parameters

file (required)
Form Parameter — format: binary
report_type (optional)
Form Parameter — Type of report to generate. Options: "annual_report" (default) or "sole_trader"
Enum:
annual_report
sole_trader

Return type

AnnualReport

Example data

Content-Type: application/json
{
  "report_id" : "report_id",
  "report_url" : "report_url"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK. The user account was created. AnnualReport

Up
get /api/report
Fetch a completed annual report. (report)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReportReference (required)
Body Parameter

Request headers

Access-Token (optional)
Header Parameter

Query parameters

report_type (optional)
Query Parameter — Type of report to fetch. Options: "annual_report" (default) or "sole_trader"
Enum:
annual_report
sole_trader

Return type

File

Example data

Content-Type: application/pdf

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK. The report is ready. File

404

Report not found.

409

The report is not finished.

Up
get /api/get_status
Fetch report status. (getStatus)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReportReference (required)
Body Parameter

Request headers

Access-Token (optional)
Header Parameter

Query parameters

report_type (optional)
Query Parameter — Type of report to check status for. Options: "annual_report" (default) or "sole_trader"
Enum:
annual_report
sole_trader

Return type

ReportStatus

Example data

Content-Type: application/json
{
  "status_description" : "status_description",
  "status" : "incomplete"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK. ReportStatus

404

Report not found.

Up
get /api/get_vouchers
Fetch vouchers. (getVouchers)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReportReference (required)
Body Parameter

Request headers

Access-Token (optional)
Header Parameter

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

409

The report is not finished.

Up
get /api/login
Fetch a url that enables auto login to Ã…rsredovisning Online. (login)

Request headers

Return type

Login

Example data

Content-Type: application/json
{
  "url" : "url"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Login

Up
get /api/price
Fetch current price. (price)

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

Up
post /api/token
Fetch OAuth access token. (token)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AccessRequest (required)
Body Parameter

Responses

200

OK

Models

[ Jump to Methods ]

Table of Contents

  1. AccessRequest
  2. AnnualReport
  3. Login
  4. ReportReference
  5. ReportStatus
  6. UserAccount
  7. api_create_or_update_report_body

AccessRequest Up

code (optional)
grant_type (optional)
String Fixed value: 'authorization_code'
redirect_uri (optional)

AnnualReport Up

report_id (optional)
report_url (optional)

Login Up

url (optional)

ReportReference Up

report_id (optional)

ReportStatus Up

status (optional)
Enum:
incomplete
complete
status_description (optional)

UserAccount Up

user_email (optional)

api_create_or_update_report_body Up

file (optional)
byte[] format: binary