Close accounting period

POST

/api/accounting/periods/{id}/close

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Responses

200

Default Response

Media typeapplication/json

object

period

required

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

preCloseChecks

required

object

draftJournalsCount

required

integer

pendingApprovalsCount

required

integer

unappliedReceivedPaymentsCount

required

integer

unreconciledBankItemsCount

required

integer

Example

{
  "period": {
    "status": "open"
  }
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}