Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Day Receipts
Search the full API reference Esc to close

Get Day Receipts

Billing · REST API reference

Get support
GET/v1/facilities/{facility_id}/day-receipts
One business day's receipts at the facility, by tender, on the posted basis.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/day-receipts' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · stringrequired

Format: uuid

datequery · string | null

The facility-local business date; defaults to the facility's today.

Format: date

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "added_since_close": {
      "payments": 0,
      "payments_total": "<VALUE_MATCHING_PATTERN>",
      "voids": 0,
      "voids_total": "<VALUE_MATCHING_PATTERN>"
    },
    "business_date": "2026-10-29",
    "close_id": "00000000-0000-4000-8000-000000000001",
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "facility_today": "2026-10-29",
    "in_use_since": "2026-10-29",
    "lines": [
      {
        "after_close": false,
        "amount": "<VALUE_MATCHING_PATTERN>",
        "entry_mode": "string",
        "payment_id": "00000000-0000-4000-8000-000000000001",
        "payment_number": "string",
        "posted_at": "2026-10-29T12:00:00Z",
        "received_on": "2026-10-29",
        "recorded_by_name": "string",
        "reference": "string",
        "settled_at": "2026-10-29T12:00:00Z",
        "source": "string",
        "tenant": "string",
        "tender": "string",
        "unit_numbers": [
          "string"
        ],
        "voided_same_day": false
      }
    ],
    "other_movements": [
      {
        "amount": "<VALUE_MATCHING_PATTERN>",
        "kind": "earlier_void",
        "payment_id": "00000000-0000-4000-8000-000000000001",
        "payment_number": "string",
        "posted_at": "2026-10-29T12:00:00Z",
        "surcharge_amount": "<VALUE_MATCHING_PATTERN>",
        "tender": "string"
      }
    ],
    "tenders": [
      {
        "expected_total": "<VALUE_MATCHING_PATTERN>",
        "kind": "drawer",
        "not_yet_settled_total": "<VALUE_MATCHING_PATTERN>",
        "payment_count": 0,
        "received_total": "<VALUE_MATCHING_PATTERN>",
        "surcharge_total": "<VALUE_MATCHING_PATTERN>",
        "system_total": "<VALUE_MATCHING_PATTERN>",
        "tender": "string",
        "void_count": 0,
        "voided_total": "<VALUE_MATCHING_PATTERN>"
      }
    ]
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataDayReceiptsResponserequired

One business day's receipts at a facility, by tender, on the posted basis.

Show data schema
added_since_closeAddedSinceCloseResponse | nullrequired

Set when the day has a live close: what was posted after it.

Show added_since_close schema
AddedSinceCloseResponse | null

Set when the day has a live close: what was posted after it.

Variant 1: AddedSinceCloseResponse
paymentsintegerrequired

Payments posted after the close.

payments_totalstringrequired

Their sum.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

voidsintegerrequired

Same-day voids made after the close.

voids_totalstringrequired

Their sum.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Variant 2: null
null
business_datestringrequired

The facility-local business date read.

Format: date

close_idstring | nullrequired

The day's live close; null while the day is open.

Format: uuid

Show close_id schema
string | null

The day's live close; null while the day is open.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility.

Format: uuid

facility_todaystringrequired

The facility's today.

Format: date

in_use_sincestring | nullrequired

The facility's earliest live close; a day is not closed only on or after it. Null before the first.

Format: date

Show in_use_since schema
string | null

The facility's earliest live close; a day is not closed only on or after it. Null before the first.

Variant 1: string
string
Variant 2: null
null
linesDayReceiptLineResponse[]required

One per payment posted that day.

Show lines schema
after_closebooleanrequired

Posted after the day's live close, which did not count it.

amountstringrequired

What the payment brought in.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

entry_modestring | nullrequired

stored, keyed, terminal (a card reader) or external; null for cash, check and money order, for an imported payment and for one taken before the field existed.

Show entry_mode schema
string | null

stored, keyed, terminal (a card reader) or external; null for cash, check and money order, for an imported payment and for one taken before the field existed.

Variant 1: string
string
Variant 2: null
null
payment_idstring | nullrequired

The payment.

Format: uuid

Show payment_id schema
string | null

The payment.

Variant 1: string
string
Variant 2: null
null
payment_numberstring | nullrequired

The payment's number.

Show payment_number schema
string | null

The payment's number.

Variant 1: string
string
Variant 2: null
null
posted_atstringrequired

When its ledger entry was posted: what puts it on this day. Given at the facility's UTC offset.

Format: date-time

received_onstringrequired

The received date it was keyed for; earlier than the day when keyed late.

Format: date

recorded_by_namestring | nullrequired

Who recorded it.

Show recorded_by_name schema
string | null

Who recorded it.

Variant 1: string
string
Variant 2: null
null
referencestring | nullrequired

A check's or money order's number; a stored card's or bank account's last four; the last four a card reader reported, else blank; a card or ACH recorded from outside: the processor's transaction id.

Show reference schema
string | null

A check's or money order's number; a stored card's or bank account's last four; the last four a card reader reported, else blank; a card or ACH recorded from outside: the processor's transaction id.

Variant 1: string
string
Variant 2: null
null
settled_atstring | nullrequired

When the processor settled it, at the facility's UTC offset.

Format: date-time

Show settled_at schema
string | null

When the processor settled it, at the facility's UTC offset.

Variant 1: string
string
Variant 2: null
null
sourcestringrequired

staff, autopay, portal or migration.

tenantstring | nullrequired

The tenant's display name.

Show tenant schema
string | null

The tenant's display name.

Variant 1: string
string
Variant 2: null
null
tenderstringrequired

cash, check, money_order, card, ach or other.

unit_numbersstring[]required

The units of the leases it paid.

Show unit_numbers schema
string
voided_same_daybooleanrequired

Voided on its own posted day: in voided_total, out of system_total.

other_movementsDayOtherMovementResponse[]required

Voids of earlier payments, refunds, ACH returns and chargebacks posted that day.

Show other_movements schema
amountstringrequired

Money out, unsigned.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

kindstringrequired

earlier_void, refund, ach_return or chargeback.

Values: "earlier_void", "refund", "ach_return", "chargeback"

payment_idstring | nullrequired

The payment it belongs to.

Format: uuid

Show payment_id schema
string | null

The payment it belongs to.

Variant 1: string
string
Variant 2: null
null
payment_numberstring | nullrequired

That payment's number.

Show payment_number schema
string | null

That payment's number.

Variant 1: string
string
Variant 2: null
null
posted_atstringrequired

When it was posted, at the facility's UTC offset.

Format: date-time

surcharge_amountstring | nullrequired

The share of the card surcharge a refund or a card chargeback returned; 0.00 on a chargeback of an ACH payment returned after settlement; null on an ACH return. In no total.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show surcharge_amount schema
string | null

The share of the card surcharge a refund or a card chargeback returned; 0.00 on a chargeback of an ACH payment returned after settlement; null on an ACH return. In no total.

Variant 1: string
string
Variant 2: null
null
tenderstringrequired

The tender of the payment it belongs to.

tendersDayTenderResponse[]required

cash, check, money_order, card, ach, then other when the day holds one.

Show tenders schema
expected_totalstringrequired

Expected count: system_total plus surcharge_total.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

kindstringrequired

drawer (cash, check, money order, other) or electronic (card, ach).

Values: "drawer", "electronic"

not_yet_settled_totalstring | nullrequired

On ach only: the accepted ACH still unsettled at the end of the day, or now when the day is the facility's today. Null on every other tender.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show not_yet_settled_total schema
string | null

On ach only: the accepted ACH still unsettled at the end of the day, or now when the day is the facility's today. Null on every other tender.

Variant 1: string
string
Variant 2: null
null
payment_countintegerrequired

Payments received; a payment split across two ledgers counts once.

received_totalstringrequired

The payments posted that day in this tender.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

surcharge_totalstringrequired

The card surcharge of the payments received and not voided that day. Outside system_total.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

system_totalstringrequired

received_total less voided_total. Receipts only.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

tenderstringrequired

cash, check, money_order, card, ach or other.

void_countintegerrequired

Same-day voids.

voided_totalstringrequired

Voids posted that day of payments posted that day.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll billing operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get Day Receipts | Facily Developers