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

Get Facility Invoice

Billing · REST API reference

Get support
GET/v1/facilities/{facility_id}/invoices/detail
One invoice: every line sharing `number` at this facility, plus its PDF.

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>/invoices/detail?number=<NUMBER>' \
  --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

numberquery · stringrequired

Min length: 1 · Max length: 30

Responses

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

200Successful Response
JSON · generated example
{
  "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

dataInvoiceGroupDetailResponserequired

A group, its lines, its paid state and its document.

Show data schema
documentInvoiceDocumentRef | null
Show document schema
InvoiceDocumentRef | null
Variant 1: InvoiceDocumentRef
file_size_bytesinteger | null
Show file_size_bytes schema
integer | null
Variant 1: integer
Variant 2: null
generated_atstring | null

Format: date-time

Show generated_at schema
string | null
Variant 1: string
Variant 2: null
idstringrequired

Format: uuid

titlestring | null
Show title schema
string | null
Variant 1: string
Variant 2: null
Variant 2: null
null
document_availablebooleanrequired
due_datestring | null

Format: date

Show due_date schema
string | null
Variant 1: string
string
Variant 2: null
null
earliest_effective_datestringrequired

Format: date

entriesInvoiceEntryResponse[]required
Show entries schema
amountstringrequired

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

created_atstringrequired

Format: date-time

descriptionstringrequired
discount_amountstringrequired

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

due_datestring | null

Format: date

Show due_date schema
string | null
Variant 1: string
string
Variant 2: null
null
effective_datestringrequired

Format: date

entry_typestringrequired
idstringrequired

Format: uuid

is_voidedbooleanrequired
ledger_idstringrequired

Format: uuid

outstandingstring | null

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

Show outstanding schema
string | null
Variant 1: string
string
Variant 2: null
null
period_endstring | null

Format: date

Show period_end schema
string | null
Variant 1: string
string
Variant 2: null
null
period_startstring | null

Format: date

Show period_start schema
string | null
Variant 1: string
string
Variant 2: null
null
sourcestring | null
Show source schema
string | null
Variant 1: string
string
Variant 2: null
null
subtotalstringrequired

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

tax_amountstringrequired

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

unit_numberstring | null
Show unit_number schema
string | null
Variant 1: string
string
Variant 2: null
null
entry_countintegerrequired
invoice_numberstringrequired
lease_idsstring[]required
Show lease_ids schema
string
outstandingstringrequired

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

tenant_idsstring[]required
Show tenant_ids schema
string
totalstringrequired

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

total_duestringrequired

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 Facility Invoice | Facily Developers