Session

Create a new session

Creates a new session record.

post/v1/session

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/session
  • Auth: API key in header x-api-key

Request body

stationIdstring required

Station ID where the session was opened.

sessionNumberstring

Session number identifier.

openedBystring required

Name of the user who opened the session.

closedBystring

Name of the user who closed the session.

openTimestring required

Time when the session was opened.

closeTimestring

Time when the session was closed.

openingAmountnumber required

Opening cash amount.

closingReportDatastring

Closing report data in JSON format.

notesstring[]

Notes for the session.

closingNotestring

Note when closing the session.

openingNotestring

Note when opening the session.

currency'USD' | 'EUR' | 'GBP' | 'CAD' | 'AUD' | 'NZD' | 'CHF' | 'CNY' | 'INR' | 'MXN' | 'BRL' | 'ZAR' | 'SGD' | 'HKD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'THB' | 'MYR' | 'PHP' | 'IDR' | 'AED' | 'SAR' | 'ILS' | 'TRY' | 'RUB' | 'HTG' | 'BND' | 'CRC' | 'BDT' | 'UAH' | 'NGN' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BGN' | 'BMD' | 'BOB' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'COP' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'GEL' | 'GHS' | 'GTQ' | 'GYD' | 'HNL' | 'IRR' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MZN' | 'NAD' | 'NIO' | 'NPR' | 'PAB' | 'PEN' | 'PGK' | 'PKR' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SRD' | 'SYP' | 'TJS' | 'TMT' | 'TOP' | 'TTD' | 'TZS' | 'UYU' | 'UZS' | 'VES' | 'WST' | 'XCD' | 'YER' | 'ZMW' | 'CDF' | 'CUP' | 'ERN' | 'FKP' | 'GIP' | 'GMD' | 'KPW' | 'LRD' | 'LSL' | 'MGA' | 'MWK' | 'SCR' | 'SDG' | 'SHP' | 'SLE' | 'SOS' | 'SSP' | 'STN' | 'SZL' | 'VED' | 'XCG' | 'JPY' | 'KRW' | 'VND' | 'CLP' | 'ISK' | 'HUF' | 'TWD' | 'GNF' | 'BIF' | 'DJF' | 'KMF' | 'PYG' | 'RWF' | 'UGX' | 'VUV' | 'XAF' | 'XOF' | 'XPF' | 'KWD' | 'BHD' | 'OMR' | 'JOD' | 'TND' | 'LYD' | 'IQD'

Currency of the session.

minorUnitsnumber

The Minor Units of the Order to convert the amount from minor units to major units.

closingAmountnumber

Closing cash amount.

Example request

{
  "stationId": "507f1f77bcf86cd799439011",
  "sessionNumber": "S-2025-001",
  "openedBy": "John Doe",
  "closedBy": "Jane Smith",
  "openTime": "2025-01-29T09:00:00.000Z",
  "closeTime": "2025-01-29T17:00:00.000Z",
  "openingAmount": 20000,
  "closingReportData": "{}",
  "notes": [
    "Opened on time",
    "Register balanced"
  ],
  "closingAmounts": {
    "cash": 50000,
    "card": 150000,
    "finalPay": 20000
  },
  "closingNote": "All transactions verified",
  "openingNote": "Starting new shift",
  "currency": "USD",
  "closingAmount": 25000
}

Response

The session has been successfully created.

idstring

Unique identifier for the Session.

createdAtstring date-time

Timestamp when the Session was created.

updatedAtstring date-time

Timestamp when the Session was last updated.

companyIdstring

Company ID associated with the Session.

stationIdstring

Station ID where the session was opened.

sessionNumberstring

Session number identifier.

openedBystring

Name of the user who opened the session.

closedBystring

Name of the user who closed the session.

openTimestring date-time

Time when the session was opened.

closeTimestring date-time

Time when the session was closed.

openingAmountnumber

Opening cash amount.

closingReportDatastring

Closing report data in JSON format.

notesstring[]

Notes for the session.

closingNotestring

Note when closing the session.

openingNotestring

Note when opening the session.

currency'USD' | 'EUR' | 'GBP' | 'CAD' | 'AUD' | 'NZD' | 'CHF' | 'CNY' | 'INR' | 'MXN' | 'BRL' | 'ZAR' | 'SGD' | 'HKD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'THB' | 'MYR' | 'PHP' | 'IDR' | 'AED' | 'SAR' | 'ILS' | 'TRY' | 'RUB' | 'HTG' | 'BND' | 'CRC' | 'BDT' | 'UAH' | 'NGN' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BGN' | 'BMD' | 'BOB' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'COP' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'GEL' | 'GHS' | 'GTQ' | 'GYD' | 'HNL' | 'IRR' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MZN' | 'NAD' | 'NIO' | 'NPR' | 'PAB' | 'PEN' | 'PGK' | 'PKR' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SRD' | 'SYP' | 'TJS' | 'TMT' | 'TOP' | 'TTD' | 'TZS' | 'UYU' | 'UZS' | 'VES' | 'WST' | 'XCD' | 'YER' | 'ZMW' | 'CDF' | 'CUP' | 'ERN' | 'FKP' | 'GIP' | 'GMD' | 'KPW' | 'LRD' | 'LSL' | 'MGA' | 'MWK' | 'SCR' | 'SDG' | 'SHP' | 'SLE' | 'SOS' | 'SSP' | 'STN' | 'SZL' | 'VED' | 'XCG' | 'JPY' | 'KRW' | 'VND' | 'CLP' | 'ISK' | 'HUF' | 'TWD' | 'GNF' | 'BIF' | 'DJF' | 'KMF' | 'PYG' | 'RWF' | 'UGX' | 'VUV' | 'XAF' | 'XOF' | 'XPF' | 'KWD' | 'BHD' | 'OMR' | 'JOD' | 'TND' | 'LYD' | 'IQD'

Currency of the session.

minorUnitsnumber

The Minor Units of the Order to convert the amount from minor units to major units.

closingAmountnumber

Closing cash amount.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "stationId": "507f1f77bcf86cd799439011",
  "sessionNumber": "S-2025-001",
  "openedBy": "John Doe",
  "closedBy": "Jane Smith",
  "openTime": "2025-01-29T09:00:00.000Z",
  "closeTime": "2025-01-29T17:00:00.000Z",
  "openingAmount": 20000,
  "closingReportData": "{}",
  "notes": [
    "Opened on time",
    "Register balanced"
  ],
  "closingAmounts": {
    "cash": 50000,
    "card": 150000,
    "finalPay": 20000
  },
  "closingNote": "All transactions verified",
  "openingNote": "Starting new shift",
  "currency": "USD",
  "closingAmount": 25000
}

Changes

No recorded changes to this operation across all 1 revision of this API.