LedgerSMB API (0.0.1)

Download OpenAPI specification:Download

LedgerSMB API

SICs

Get a list of SICs

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ]
}

Add SIC entry

Request Body schema: application/json
code
required
string (sic-code) non-empty
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Get a single SIC

path Parameters
id
required
string (sic-code) non-empty

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Update a single SIC

path Parameters
id
required
string (sic-code) non-empty
header Parameters
If-Match
required
string
Request Body schema: application/json
code
required
string (sic-code) non-empty
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Delete a single SIC

path Parameters
id
required
string (sic-code) non-empty
header Parameters
If-Match
required
string

Responses

Update a single SIC

path Parameters
id
required
string (sic-code) non-empty
header Parameters
If-Match
required
string

Responses

Business types

Get business types

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ]
}

Create a business type

Request Body schema: application/json
id
required
number <int64> (business-type-id)
description
required
string
discount
number <float>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "discount": 0
}

Get a single business type

path Parameters
id
required
number <int64> (business-type-id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "discount": 0
}

Update a single business type

path Parameters
id
required
number <int64> (business-type-id)
header Parameters
If-Match
required
string
Request Body schema: application/json
id
required
number <int64> (business-type-id)
description
required
string
discount
number <float>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "discount": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "discount": 0
}

Delete a single business type

path Parameters
id
required
number <int64> (business-type-id)
header Parameters
If-Match
required
string

Responses

Update a single business type

path Parameters
id
required
number <int64> (business-type-id)
header Parameters
If-Match
required
string

Responses

GIFI

Get a list of GIFI

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ]
}

Create a single GIFI

Request Body schema: application/json
accno
required
string (accno-code) non-empty
description
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "accno": "string",
  • "description": "string"
}

Get a single GIFI

path Parameters
id
required
string (accno-code) non-empty

Responses

Response samples

Content type
application/json
{
  • "accno": "string",
  • "description": "string"
}

Put a single GIFI

path Parameters
id
required
string (accno-code) non-empty
header Parameters
If-Match
required
string
Request Body schema: application/json
accno
required
string (accno-code) non-empty
description
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "accno": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "accno": "string",
  • "description": "string"
}

Delete a single GIFI

path Parameters
id
required
string (accno-code) non-empty
header Parameters
If-Match
required
string

Responses

Update a single GIFI

path Parameters
id
required
string (accno-code) non-empty
header Parameters
If-Match
required
string

Responses

Languages

Get available languages

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ]
}

Create a language

Request Body schema: application/json
code
required
string (language-code) ^[a-z]{2}(_[A-Z]{2})?$
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Get a single language

path Parameters
id
required
string (language-code) ^[a-z]{2}(_[A-Z]{2})?$

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Update a single language

path Parameters
id
required
string (language-code) ^[a-z]{2}(_[A-Z]{2})?$
header Parameters
If-Match
required
string
Request Body schema: application/json
code
required
string (language-code) ^[a-z]{2}(_[A-Z]{2})?$
description
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string"
}

Delete a single language

path Parameters
id
required
string (language-code) ^[a-z]{2}(_[A-Z]{2})?$
header Parameters
If-Match
required
string

Responses

Update a single language

path Parameters
id
required
string (language-code) ^[a-z]{2}(_[A-Z]{2})?$
header Parameters
If-Match
required
string

Responses

Price groups

Get products price groups

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ]
}

Create products price group

Request Body schema: application/json
description
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Get a single products price group

path Parameters
id
required
integer <int64> (pricegroup-id) >= 1

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 1
}

Create single products price group

path Parameters
id
required
integer <int64> (pricegroup-id) >= 1
header Parameters
If-Match
required
string
Request Body schema: application/json
description
required
string
id
required
integer <int64> (pricegroup-id) >= 1

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 1
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 1
}

Delete a single products price group

path Parameters
id
required
integer <int64> (pricegroup-id) >= 1
header Parameters
If-Match
required
string

Responses

Update a single products price group

path Parameters
id
required
integer <int64> (pricegroup-id) >= 1
header Parameters
If-Match
required
string

Responses

Warehouses

Get a list of warehouses

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ]
}

Create a warehouse

Request Body schema: application/json
description
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Get a single warehouse

path Parameters
id
required
integer <int64> (warehouse-id) >= 1

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 1
}

Update a single warehouse

path Parameters
id
required
integer <int64> (warehouse-id) >= 1
header Parameters
If-Match
required
string
Request Body schema: application/json
description
required
string
id
required
integer <int64> (warehouse-id) >= 1

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 1
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 1
}

Delete a single warehouse

path Parameters
id
required
integer <int64> (warehouse-id) >= 1
header Parameters
If-Match
required
string

Responses

Update a single warehouse

path Parameters
id
required
integer <int64> (warehouse-id) >= 1
header Parameters
If-Match
required
string

Responses