Skip to content
Vespy API

List accounting periods

GET
/api/accounting/periods
curl --request GET \
  --url https://api.getvespy.com/api/accounting/periods \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
periods
required
Array<object>
object
closedAt
required
string format: date-time
nullable
closedByUserId
required
string format: uuid
nullable
createdAt
required
string format: date-time
endDate
required
string format: date
fiscalYear
required
integer
id
required
string format: uuid
organizationId
required
string format: uuid
periodNumber
required
integer
>= 1 <= 12
reopenReason
required
string
nullable
reopenedAt
required
string format: date-time
nullable
reopenedByUserId
required
string format: uuid
nullable
startDate
required
string format: date
status
required
string
Allowed values: open soft_closed closed reopened
updatedAt
required
string format: date-time
Example
{
  "periods": [
    {
      "status": "open"
    }
  ]
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}