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.

Path Parameters

id
string
required

Response

201 - application/json
organizationId
string
required
companyId
string | null
required

Subsidiary / company for multi-entity AR. Null only for legacy rows before this column existed.

invoiceNumber
string
required
kind
enum<string>
required
Available options:
STANDARD,
PROFORMA,
CREDIT_NOTE,
DEBIT_NOTE,
DOWN_PAYMENT
customerId
string
required
projectId
string | null
required

Project accounting dimension (optional).

clientId
string | null
required

Client / sub-ledger dimension (optional).

issueDate
string<date-time>
required
dueDate
string<date-time>
required
subtotal
number
required
taxAmount
number
required
total
number
required
currency
string
required
status
enum<string>
required
Available options:
DRAFT,
POSTED,
SENT,
VIEWED,
PARTIALLY_PAID,
PAID,
OVERDUE,
CANCELLED
settlementStatus
enum<string>
required
Available options:
UNPAID,
PARTIALLY_PAID,
PAID
amountPaid
number
required
balanceDue
number
required
postedAt
string<date-time> | null
required

When set, the invoice has been posted to the ledger and must not be edited directly.

postedBy
string | null
required
postedJournalEntryId
string | null
required
notes
string
required
sourceDocumentIds
string[]
required
documentBranding
object
required
sentByEmail
string | null
required

Email of the user who last sent the invoice (issuer notification fallback).

lineItems
object[]
required
allocations
object[]
required
creditNotes
object[]
required
id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
string<date-time>