How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Facilio Client Credits API

Client credit notes for refunds and transaction adjustments. Track credit amounts, line items, and approval status for client-related credits.

Facilio Client Credits API is one of 35 APIs that Facilio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Client Credits. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 5.0.0.

Requests are made against a single base URL, https://{region}.facilioapis.com/{app_name}/api/v5.

6 operations 3 paths 8 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
5.0.0
Base URL
https://us.facilioapis.com/maintenance/api/v5
Authentication
API Key, OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 2

Facilio Client Credits API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (apiKey). It supports OAuth 2.0 (oauth2) using the authorizationCode and password flows. By default, every request must be authenticated.

  • apiKey — Personal access token
  • oauth2 — Supports authorizationcode and password grant types

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Client Credits 6

Client credit notes for refunds and transaction adjustments. Track credit amounts, line items, and approval status for client-related credits.

GET
/clientCredit
List client credits
listClientCredits 9 params → 200401
POST
/clientCredit
Create a client credit
createClientCredit body → 201400401
GET
/clientCredit/{id}
Get a client credit
getClientCredit 3 params → 200401404
PATCH
/clientCredit/{id}
Update a client credit
updateClientCredit 1 param body → 200400401404
DELETE
/clientCredit/{id}
Delete a client credit
deleteClientCredit 1 param → 200401404
GET
/clientCredit/metadata
Get client credit field schema
getClientCreditMetadata 1 param → 200401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ClientCredit (26 properties), CreditNoteLineItem (11 properties), FacilioField (10 properties), Address (9 properties). Each schema is shown below with its type and property counts.

CreditNoteLineItem
object
Credit note line item.
11 properties
Error
object
Error response
2 properties
ModuleMetaResponse
object
Response body for GET /{moduleName}/metadata.
2 properties
FacilioField
object
Schema descriptor for a single field within a module.
10 properties
Address
object
Postal address. Used for site/building locations, storeroom locations, vendor/client/tenant addresses, and quote/invoice billing & shipping addresses.
9 properties
ClientCredit
object
Client credit note with line items.
26 properties
User
object
Expanded object for lookups to the users module. On list API, user lookups return {id} only unless ?expand= includes that field. When expanded (single-record G…
4 properties
FacilioModule
object
A single entry in the module catalogue returned by GET /modules.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

facilio-client-credits-api-openapi.yml Raw ↑

Other APIs Facilio publishes across the network.

Facilio Assets API
Facilio Buildings API
Facilio Client Contacts API
Facilio Clients API
Facilio Common API
Facilio Custom Modules API
Facilio Floors API
Facilio Inventory Requests API
Facilio Invoices API
Facilio Item Types API
Facilio Items API
Facilio Picklists API
Where this information came from

This is an independent, third-party profile of Facilio Client Credits API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.