LedgerSMB API (0.0.1)

Download OpenAPI specification:Download

URL: https://github.com/ledgersmb/LedgerSMB/issues License: GPL-2.0-or-later

LedgerSMB API

SICs

Get a list of SICs

Authorizations:

cookieAuth

Responses

Response samples

200

Content type

application/json

{"_links": [{ }
]
}

Add SIC entry

Authorizations:

cookieAuth

Request Body schema: application/json

code required	string (sic-code) non-empty
description required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Get a single SIC

Authorizations:

cookieAuth

path Parameters

id

required

string (sic-code) non-empty

Responses

Response samples

200

Content type

application/json

{"code": "string",
"description": "string"
}

Update a single SIC

Authorizations:

cookieAuth

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

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"code": "string",
"description": "string"
}

Delete a single SIC

Authorizations:

cookieAuth

path Parameters

id

required

string (sic-code) non-empty

header Parameters

If-Match

required

string

...

Responses

Update a single SIC

Authorizations:

cookieAuth

path Parameters

id

required

string (sic-code) non-empty

header Parameters

If-Match

required

string

...

Responses

Business types

Get business types

Authorizations:

cookieAuth

Responses

Response samples

200

Content type

application/json

{"_links": [{ }
]
}

Create a business type

Authorizations:

cookieAuth

Request Body schema: application/json

description

required

string

Responses

Request samples

Payload

Content type

application/json

{"description": "string"
}

Get a single business type

Authorizations:

cookieAuth

path Parameters

id

required

number <int64> (business-type-id)

Responses

Response samples

200

Content type

application/json

{"id": 0,
"description": "string",
"discount": 0
}

Update a single business type

Authorizations:

cookieAuth

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

Payload

Content type

application/json

{"id": 0,
"description": "string",
"discount": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"description": "string",
"discount": 0
}

Delete a single business type

Authorizations:

cookieAuth

path Parameters

id

required

number <int64> (business-type-id)

header Parameters

If-Match

required

string

...

Responses

Update a single business type

Authorizations:

cookieAuth

path Parameters

id

required

number <int64> (business-type-id)

header Parameters

If-Match

required

string

...

Responses

GIFI

Get a list of GIFI

Authorizations:

cookieAuth

Responses

Response samples

200

Content type

application/json

{"_links": [{ }
]
}

Create a single GIFI

Authorizations:

cookieAuth

Request Body schema: application/json

accno required	string (accno-code) non-empty
description required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"accno": "string",
"description": "string"
}

Get a single GIFI

Authorizations:

cookieAuth

path Parameters

id

required

string (accno-code) non-empty

Responses

Response samples

200

Content type

application/json

{"accno": "string",
"description": "string"
}

Put a single GIFI

Authorizations:

cookieAuth

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

Payload

Content type

application/json

{"accno": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"accno": "string",
"description": "string"
}

Delete a single GIFI

Authorizations:

cookieAuth

path Parameters

id

required

string (accno-code) non-empty

header Parameters

If-Match

required

string

...

Responses

Update a single GIFI

Authorizations:

cookieAuth

path Parameters

id

required

string (accno-code) non-empty

header Parameters

If-Match

required

string

...

Responses

Invoices

Lists invoices

Authorizations:

cookieAuth

Responses

Response samples

200
default

Content type

application/json

[{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}
]

Add an invoice

Authorizations:

cookieAuth

Request Body schema: application/json

...

required	object or object
required	object
currency required	string = 3 characters
description	string or null
notes	string or null
internal-notes	string or null
invoice-number	string
order-number	string
po-number	string
ship-via	string or null
shipping-point	string or null
ship-to	object
required	object
required	Array of objects
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"eca": {"id": 1
},
"account": {"accno": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string"
}
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string"
}
}
]
}

Response samples

201

Content type

application/json

{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}

Get a single invoice

Authorizations:

cookieAuth

path Parameters

id

required

string non-empty

Responses

Response samples

200

Content type

application/json

{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}

Update a single invoice

Authorizations:

cookieAuth

path Parameters

id

required

string non-empty

header Parameters

If-Match

required

string

...

Request Body schema: application/json

required	object or object
required	object
currency required	string = 3 characters
description	string or null
notes	string or null
internal-notes	string or null
invoice-number	string
order-number	string
po-number	string
ship-via	string or null
shipping-point	string or null
ship-to	object
required	object
required	Array of objects
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"eca": {"id": 1
},
"account": {"accno": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string"
}
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string"
}
}
]
}

Response samples

200

Content type

application/json

{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}

Experimental

Lists invoices

Authorizations:

cookieAuth

Responses

Response samples

200
default

Content type

application/json

[{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}
]

Add an invoice

Authorizations:

cookieAuth

Request Body schema: application/json

...

required	object or object
required	object
currency required	string = 3 characters
description	string or null
notes	string or null
internal-notes	string or null
invoice-number	string
order-number	string
po-number	string
ship-via	string or null
shipping-point	string or null
ship-to	object
required	object
required	Array of objects
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"eca": {"id": 1
},
"account": {"accno": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string"
}
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string"
}
}
]
}

Response samples

201

Content type

application/json

{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}

Get a single invoice

Authorizations:

cookieAuth

path Parameters

id

required

string non-empty

Responses

Response samples

200

Content type

application/json

{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}

Update a single invoice

Authorizations:

cookieAuth

path Parameters

id

required

string non-empty

header Parameters

If-Match

required

string

...

Request Body schema: application/json

required	object or object
required	object
currency required	string = 3 characters
description	string or null
notes	string or null
internal-notes	string or null
invoice-number	string
order-number	string
po-number	string
ship-via	string or null
shipping-point	string or null
ship-to	object
required	object
required	Array of objects
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"eca": {"id": 1
},
"account": {"accno": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string"
}
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string"
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string"
}
}
]
}

Response samples

200

Content type

application/json

{"eca": {"id": 1,
"entity": {"credit_limit": {"total": 0,
"used": 0,
"available": 0
}
}
},
"account": {"accno": "string",
"description": "string"
},
"currency": "str",
"description": "string",
"notes": "string",
"internal-notes": "string",
"invoice-number": "string",
"order-number": "string",
"po-number": "string",
"ship-via": "string",
"shipping-point": "string",
"ship-to": { },
"dates": {"due": "2019-08-24",
"book": "2019-08-24",
"created": "2019-08-24"
},
"lines": [{"description": "string",
"price": 0,
"price_fixated": false,
"unit": "string",
"qty": 1,
"taxform": false,
"serialnumber": "string",
"discount": 100,
"discount_type": "%",
"delivery_date": "2019-08-24",
"part": {"number": "string",
"_self": "string"
},
"total": 0
}
],
"taxes": {"property1": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
},
"property2": {"tax": {"category": "string"
},
"base-amount": 0,
"amount": 0,
"source": "string",
"memo": "string",
"name": "string",
"rate": 1,
"calculated-amount": 0
}
},
"payments": [{"date": "2019-08-24",
"source": "string",
"memo": "string",
"amount": 0,
"account": {"accno": "string",
"description": "string"
}
}
]
}

Languages

Get available languages

Authorizations:

cookieAuth

Responses

Response samples

200

Content type

application/json

{"_links": [{ }
]
}

Create a language

Authorizations:

cookieAuth

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Get a single language

Authorizations:

cookieAuth

path Parameters

id

required

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

Responses

Response samples

200

Content type

application/json

{"code": "string",
"description": "string"
}

Update a single language

Authorizations:

cookieAuth

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

Payload

Content type

application/json

{"code": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"code": "string",
"description": "string"
}

Delete a single language

Authorizations:

cookieAuth

path Parameters

id

required

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

header Parameters

If-Match

required

string

...

Responses

Update a single language

Authorizations:

cookieAuth

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

Authorizations:

cookieAuth

Responses

Response samples

200

Content type

application/json

{"_links": [{ }
]
}

Create products price group

Authorizations:

cookieAuth

Request Body schema: application/json

description

required

string

Responses

Request samples

Payload

Content type

application/json

{"description": "string"
}

Get a single products price group

Authorizations:

cookieAuth

path Parameters

id

required

integer <int64> (pricegroup-id) >= 1

Responses

Response samples

200

Content type

application/json

{"description": "string",
"id": 1
}

Create single products price group

Authorizations:

cookieAuth

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

Payload

Content type

application/json

{"description": "string",
"id": 1
}

Response samples

200

Content type

application/json

{"description": "string",
"id": 1
}

Delete a single products price group

Authorizations:

cookieAuth

path Parameters

id

required

integer <int64> (pricegroup-id) >= 1

header Parameters

If-Match

required

string

...

Responses

Update a single products price group

Authorizations:

cookieAuth

path Parameters

id

required

integer <int64> (pricegroup-id) >= 1

header Parameters

If-Match

required

string

...

Responses

Warehouses

Get a list of warehouses

Authorizations:

cookieAuth

Responses

Response samples

200

Content type

application/json

{"_links": [{ }
],
"items": [{"description": "string",
"id": 1
}
]
}

Create a warehouse

Authorizations:

cookieAuth

Request Body schema: application/json

description

required

string

Responses

Request samples

Payload

Content type

application/json

{"description": "string"
}

Get a single warehouse

Authorizations:

cookieAuth

path Parameters

id

required

integer <int64> (warehouse-id) >= 1

Responses

Response samples

200

Content type

application/json

{"description": "string",
"id": 1
}

Update a single warehouse

Authorizations:

cookieAuth

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

Payload

Content type

application/json

{"description": "string",
"id": 1
}

Response samples

200

Content type

application/json

{"description": "string",
"id": 1
}

Delete a single warehouse

Authorizations:

cookieAuth

path Parameters

id

required

integer <int64> (warehouse-id) >= 1

header Parameters

If-Match

required

string

...

Responses

Update a single warehouse

Authorizations:

cookieAuth

path Parameters

id

required

integer <int64> (warehouse-id) >= 1

header Parameters

If-Match

required

string

...