Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Headers

X-Workspace-Id
string<uuid>

Partner / ISV only: UUID of the workspace that owns the client company. Required together with X-Acting-Company-Id when scoping product APIs to a merchant. See /getting-started/multi-tenancy.

X-Acting-Company-Id
string<uuid>

Partner / ISV only: UUID of the client company to act on. Must belong to the workspace in X-Workspace-Id.

Body

application/json
customerId
string<uuid>
required

Customer ID (AR invoice)

issueDate
string
required

Issue date

Example:

"2026-03-15"

dueDate
string
required

Due date

Example:

"2026-04-15"

lineItems
object[]
required

Line items (required). Header subtotal/tax/total are derived server-side.

Minimum array length: 1
companyId
string<uuid>

Company (subsidiary) that owns this AR document. Defaults to the user’s primary company.

kind
enum<string>
default:STANDARD

Invoice document kind (global ERP-style)

Available options:
STANDARD,
PROFORMA,
CREDIT_NOTE,
DEBIT_NOTE,
DOWN_PAYMENT
Example:

"STANDARD"

projectId
string<uuid>

Project accounting dimension

clientId
string<uuid>

Client / sub-ledger dimension

currency
string
default:USD

Currency code (ISO 4217)

Maximum string length: 3
Example:

"USD"

notes
string

Additional notes

Response

Create a new invoice — created

success
boolean
required

Whether the request succeeded

Example:

true

message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

data
object

Endpoint-specific payload