Create a fiscal document of the type invoice

post

https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/invoice

Create a fiscal document of the type invoice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

transactionIds

array of int64s

required

deprecated

Include transactions with the specified IDs (deprecated, use includeTransactionIds instead)

transactionIds*

transactionIdToAmount

object | null

Map of transaction ID to amount (in major currency units, e.g., 10.50 for $10.50) for partial transaction inclusion

sourceId

int64

required

≥ 1

sequenceId

int64 | null

≥ 1

sourceKind

string

enum

required

Kind of the source entity

Allowed:

userId

int64 | null

≥ 0

currency

string | null

Invoice currency. Selected transactions are converted into this currency at creation using the property's current exchange rate, which is locked on the issued document, and the converted amounts are fiscalized. Defaults to the property currency when omitted.

recipient

object

manualRecipient

object

folioIds

array of int64s

Include all transactions from the specified folio IDs

folioIds

excludeTransactionIds

array of int64s

Exclude transactions with the specified IDs

excludeTransactionIds

includeTransactionIds

array of int64s

Include transactions with the specified IDs

includeTransactionIds

simplified

boolean

Defaults to false

invoiceType

string | null

enum

Argentina RI only — the ARCA invoice class to issue (Factura A/B/T). Determines the ar-arca-doc-type sent to ARCA and the Punto de Venta series used. Ignored for non-RI / non-AR properties (those always issue C).

Allowed:

packageBreakdown

boolean | null

Per-document override for package breakdown. Null means use property default.

dueDatePropertyTimezone

date

note

string | null

emails

array of strings | null

Optional list of email addresses to send the document to once it is ready

emails

summary

boolean | null

Defaults to false

When true, marks this as a CFDI global/summary invoice (MX only)

summaryFrequency

string | null

enum

Reporting frequency for summary invoices (MX only)

Allowed:

mxCfdiUse

string | null

MX only — SAT c_UsoCFDI code selected in the Create Invoice modal. Overrides the value stored in guest requirements (mx_cfdi_use). A generic RFC (XAXX/XEXX) always forces S01 at issuance time regardless of this value.

Headers

X-Property-ID

int64

required

≥ 1

Property id

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK