/v1/facilities/{facility_id}/invoices/detailAuthentication
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>/invoices/detail?number=<NUMBER>' \
--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
numberquery · stringrequiredMin length: 1 · Max length: 30
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"document_available": false,
"earliest_effective_date": "2026-10-29",
"entries": [
{
"amount": "<VALUE_MATCHING_PATTERN>",
"created_at": "2026-10-29T12:00:00Z",
"description": "string",
"discount_amount": "<VALUE_MATCHING_PATTERN>",
"effective_date": "2026-10-29",
"entry_type": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_voided": false,
"ledger_id": "00000000-0000-4000-8000-000000000001",
"subtotal": "<VALUE_MATCHING_PATTERN>",
"tax_amount": "<VALUE_MATCHING_PATTERN>",
"due_date": "2026-10-29"
}
],
"entry_count": 0,
"invoice_number": "string",
"lease_ids": [
"00000000-0000-4000-8000-000000000001"
],
"outstanding": "<VALUE_MATCHING_PATTERN>",
"tenant_ids": [
"00000000-0000-4000-8000-000000000001"
],
"total": "<VALUE_MATCHING_PATTERN>",
"total_due": "<VALUE_MATCHING_PATTERN>",
"document": {
"id": "00000000-0000-4000-8000-000000000001",
"file_size_bytes": 0,
"generated_at": "2026-10-29T12:00:00Z",
"title": "string"
},
"due_date": "2026-10-29"
},
"meta": {
"request_id": "string"
}
}application/json
dataInvoiceGroupDetailResponserequiredA group, its lines, its paid state and its document.
Show data schema
documentInvoiceDocumentRef | nullShow document schema
InvoiceDocumentRef | nullVariant 1: InvoiceDocumentRef
file_size_bytesinteger | nullShow file_size_bytes schema
integer | nullVariant 1: integer
Variant 2: null
generated_atstring | nullFormat: date-time
Show generated_at schema
string | nullVariant 1: string
Variant 2: null
idstringrequiredFormat: uuid
titlestring | nullShow title schema
string | nullVariant 1: string
Variant 2: null
Variant 2: null
nulldocument_availablebooleanrequireddue_datestring | nullFormat: date
Show due_date schema
string | nullVariant 1: string
stringVariant 2: null
nullearliest_effective_datestringrequiredFormat: date
entriesInvoiceEntryResponse[]requiredShow entries schema
amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
created_atstringrequiredFormat: date-time
descriptionstringrequireddiscount_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
due_datestring | nullFormat: date
Show due_date schema
string | nullVariant 1: string
stringVariant 2: null
nulleffective_datestringrequiredFormat: date
entry_typestringrequiredidstringrequiredFormat: uuid
is_voidedbooleanrequiredledger_idstringrequiredFormat: uuid
outstandingstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show outstanding schema
string | nullVariant 1: string
stringVariant 2: null
nullperiod_endstring | nullFormat: date
Show period_end schema
string | nullVariant 1: string
stringVariant 2: null
nullperiod_startstring | nullFormat: date
Show period_start schema
string | nullVariant 1: string
stringVariant 2: null
nullsourcestring | nullShow source schema
string | nullVariant 1: string
stringVariant 2: null
nullsubtotalstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
unit_numberstring | nullShow unit_number schema
string | nullVariant 1: string
stringVariant 2: null
nullentry_countintegerrequiredinvoice_numberstringrequiredlease_idsstring[]requiredShow lease_ids schema
stringoutstandingstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tenant_idsstring[]requiredShow tenant_ids schema
stringtotalstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_duestringrequiredPattern: ^(?!^[-+.]*$)[+-]?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