/v1/facilities/{facility_id}/day-receiptsAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --request GET \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/day-receipts' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · stringrequiredFormat: uuid
datequery · string | nullThe 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
{
"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
dataDayReceiptsResponserequiredOne business day's receipts at a facility, by tender, on the posted basis.
Show data schema
added_since_closeAddedSinceCloseResponse | nullrequiredSet when the day has a live close: what was posted after it.
Show added_since_close schema
AddedSinceCloseResponse | nullSet when the day has a live close: what was posted after it.
Variant 1: AddedSinceCloseResponse
paymentsintegerrequiredPayments posted after the close.
payments_totalstringrequiredTheir sum.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
voidsintegerrequiredSame-day voids made after the close.
voids_totalstringrequiredTheir sum.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Variant 2: null
nullbusiness_datestringrequiredThe facility-local business date read.
Format: date
close_idstring | nullrequiredThe day's live close; null while the day is open.
Format: uuid
Show close_id schema
string | nullThe day's live close; null while the day is open.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe facility.
Format: uuid
facility_todaystringrequiredThe facility's today.
Format: date
in_use_sincestring | nullrequiredThe 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 | nullThe facility's earliest live close; a day is not closed only on or after it. Null before the first.
Variant 1: string
stringVariant 2: null
nulllinesDayReceiptLineResponse[]requiredOne per payment posted that day.
Show lines schema
after_closebooleanrequiredPosted after the day's live close, which did not count it.
amountstringrequiredWhat the payment brought in.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
entry_modestring | nullrequiredstored, 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 | nullstored, 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
stringVariant 2: null
nullpayment_idstring | nullrequiredThe payment.
Format: uuid
Show payment_id schema
string | nullThe payment.
Variant 1: string
stringVariant 2: null
nullpayment_numberstring | nullrequiredThe payment's number.
Show payment_number schema
string | nullThe payment's number.
Variant 1: string
stringVariant 2: null
nullposted_atstringrequiredWhen its ledger entry was posted: what puts it on this day. Given at the facility's UTC offset.
Format: date-time
received_onstringrequiredThe received date it was keyed for; earlier than the day when keyed late.
Format: date
recorded_by_namestring | nullrequiredWho recorded it.
Show recorded_by_name schema
string | nullWho recorded it.
Variant 1: string
stringVariant 2: null
nullreferencestring | nullrequiredA 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 | nullA 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
stringVariant 2: null
nullsettled_atstring | nullrequiredWhen the processor settled it, at the facility's UTC offset.
Format: date-time
Show settled_at schema
string | nullWhen the processor settled it, at the facility's UTC offset.
Variant 1: string
stringVariant 2: null
nullsourcestringrequiredstaff, autopay, portal or migration.
tenantstring | nullrequiredThe tenant's display name.
Show tenant schema
string | nullThe tenant's display name.
Variant 1: string
stringVariant 2: null
nulltenderstringrequiredcash, check, money_order, card, ach or other.
unit_numbersstring[]requiredThe units of the leases it paid.
Show unit_numbers schema
stringvoided_same_daybooleanrequiredVoided on its own posted day: in voided_total, out of system_total.
other_movementsDayOtherMovementResponse[]requiredVoids of earlier payments, refunds, ACH returns and chargebacks posted that day.
Show other_movements schema
amountstringrequiredMoney out, unsigned.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
kindstringrequiredearlier_void, refund, ach_return or chargeback.
Values: "earlier_void", "refund", "ach_return", "chargeback"
payment_idstring | nullrequiredThe payment it belongs to.
Format: uuid
Show payment_id schema
string | nullThe payment it belongs to.
Variant 1: string
stringVariant 2: null
nullpayment_numberstring | nullrequiredThat payment's number.
Show payment_number schema
string | nullThat payment's number.
Variant 1: string
stringVariant 2: null
nullposted_atstringrequiredWhen it was posted, at the facility's UTC offset.
Format: date-time
surcharge_amountstring | nullrequiredThe 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 | nullThe 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
stringVariant 2: null
nulltenderstringrequiredThe tender of the payment it belongs to.
tendersDayTenderResponse[]requiredcash, check, money_order, card, ach, then other when the day holds one.
Show tenders schema
expected_totalstringrequiredExpected count: system_total plus surcharge_total.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
kindstringrequireddrawer (cash, check, money order, other) or electronic (card, ach).
Values: "drawer", "electronic"
not_yet_settled_totalstring | nullrequiredOn 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 | nullOn 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
stringVariant 2: null
nullpayment_countintegerrequiredPayments received; a payment split across two ledgers counts once.
received_totalstringrequiredThe payments posted that day in this tender.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
surcharge_totalstringrequiredThe card surcharge of the payments received and not voided that day. Outside system_total.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
system_totalstringrequiredreceived_total less voided_total. Receipts only.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tenderstringrequiredcash, check, money_order, card, ach or other.
void_countintegerrequiredSame-day voids.
voided_totalstringrequiredVoids posted that day of payments posted that day.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired