Skip to main content
GET
/
registers
/
{registerId}
/
closings
List closings
curl --request GET \
  --url https://api.openfiskal.com/v1/registers/{registerId}/closings \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "data": [
    {
      "id": "cls_01HXYZ",
      "object": "<string>",
      "register_id": "<string>",
      "type": "daily",
      "state": "pending",
      "period": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z"
      },
      "summary": {
        "operation_count": 123,
        "total_gross": 123,
        "total_tax": 123,
        "total_by_payment_method": {},
        "by_operation_type": {
          "sales": {
            "count": 123,
            "total_gross": 123
          },
          "refunds": {
            "count": 123,
            "total_gross": 123
          },
          "voids": {
            "count": 123
          },
          "cash_movements": {
            "cash_in_total": 123,
            "cash_out_total": 123
          }
        },
        "tax_breakdown": [
          {
            "rate": "<string>",
            "category": "<string>",
            "taxable_amount": 123,
            "tax_amount": 123
          }
        ]
      },
      "fiscal": {
        "regime": "<string>",
        "z_number": 42,
        "tse_serial": "abc123def456",
        "signature": "aSDinaTvuI8gbWludGxpZnk=",
        "transaction_counter": 123,
        "dsfinvk_export_id": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "links": {
        "pdf": "<string>"
      }
    }
  ],
  "cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Platform API key sent as Authorization: Bearer ofk_platform_.... Platform integrators also pass OpenFiskal-Organization: org_xxx to act on behalf of a merchant.

Headers

OpenFiskal-Organization
string

Merchant organization ID. Required for platform integrators acting on behalf of a specific merchant. Omit when using an organization-scoped API key directly.

Path Parameters

registerId
string
required

Query Parameters

state
enum<string>

Filter by closing state. Use failed to surface closings needing attention.

Available options:
pending,
completed,
transmitted,
failed
type
enum<string>
Available options:
daily,
shift,
monthly,
annual
from
string<date-time>

Filter results to those created at or after this timestamp (ISO 8601).

to
string<date-time>

Filter results to those created at or before this timestamp (ISO 8601).

limit
integer
default:50

Maximum number of results to return per page.

Required range: 1 <= x <= 200
cursor
string

Pagination cursor from a previous response's cursor field. Omit to start from the beginning.

Response

List of closings

object
string
Allowed value: "list"
data
object[]
cursor
string | null