API docs by Redocly

Abaks API (1.0)

Download OpenAPI specification:Download

License: ISC

This API allows interacting with Abaks

List Periods

Responses

Response samples

Content type
application/json;charset=utf-8
[
  • {
    }
]

Create a Period

Request Body schema: application/json;charset=utf-8
from
required
string <date> (Day)
required
object (AmountA)
name
required
string
to
required
string <date> (Day)

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "from": "2016-07-22",
  • "initialBalance": {
    },
  • "name": "string",
  • "to": "2016-07-22"
}

Response samples

Content type
application/json;charset=utf-8
{
  • "periodId": "string"
}

Fetch a Period

path Parameters
periodId
required
string

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "period": {
    }
}

Create an Entry

path Parameters
periodId
required
string
Request Body schema: application/json;charset=utf-8
required
object (AmountA)
category
required
string
comment
required
string
date
required
string <date> (Day)
entryId
required
integer [ -9223372036854776000 .. 9223372036854776000 ]
required
object or object or object or object (EntryStateA)

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "amount": {
    },
  • "category": "string",
  • "comment": "string",
  • "date": "2016-07-22",
  • "entryId": -9223372036854776000,
  • "state": {
    }
}

Delete an Entry

path Parameters
periodId
required
string
entryId
required
integer [ -9223372036854776000 .. 9223372036854776000 ]
Request Body schema: application/json;charset=utf-8
comment
required
string

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "comment": "string"
}

ChangeAmount an Entry

path Parameters
periodId
required
string
entryId
required
integer [ -9223372036854776000 .. 9223372036854776000 ]
Request Body schema: application/json;charset=utf-8
required
object (AmountA)

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "amount": {
    }
}

Comment an Entry

path Parameters
periodId
required
string
entryId
required
integer [ -9223372036854776000 .. 9223372036854776000 ]
Request Body schema: application/json;charset=utf-8
comment
required
string

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "comment": "string"
}

Mark an Entry in conflit

path Parameters
periodId
required
string
entryId
required
integer [ -9223372036854776000 .. 9223372036854776000 ]
Request Body schema: application/json;charset=utf-8
comment
required
string

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "comment": "string"
}

Validate an Entry

path Parameters
periodId
required
string
entryId
required
integer [ -9223372036854776000 .. 9223372036854776000 ]

Responses