CLcloudbeds
Fiscal Documents

Create a fiscal document of the type invoice

Create a fiscal document of the type invoice.

post/fiscal-document/v1/fiscal-documents/invoice

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/invoice
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
      Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: write:reservation

Headers

X-Property-IDinteger required

Property id

Request body

transactionIdsinteger[] required

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

transactionIdToAmountobject nullable

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

transactionIdToDisplayAmountobject nullable

Map of transaction ID to amount in the invoice currency (major units, as in displayAmount) for partial transaction inclusion, recorded on the document exactly as given. Takes precedence over transactionIdToAmount for the same transaction. When the invoice currency is the property currency it behaves like transactionIdToAmount.

sourceIdinteger required
sequenceIdinteger nullable
sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER' required

Kind of the source entity

userIdinteger nullable

Ignored. The document is attributed to the authenticated user.

currencystring nullable

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.

folioIdsinteger[]

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[]

Exclude transactions with the specified IDs

includeTransactionIdsinteger[]

Include only the transactions with these IDs. With folioIds they are added on top of the folios' transactions instead. Empty or omitted means every not-yet-invoiced transaction of the source (or of folioIds when given) minus excludeTransactionIds, payments included and pending transactions only when the property allows them. Transactions listed in transactionIdToAmount are added automatically. Ignored when the deprecated transactionIds is set.

simplifiedboolean
invoiceType'A' | 'B' | 'T' nullable

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).

packageBreakdownboolean nullable

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

dueDatePropertyTimezonestring date
notestring nullable
emailsstring[] nullable

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

subjectstring nullable

Optional per-send override for the email subject. When omitted or blank, the subject is resolved from the property's email template, falling back to the service default. Supports the same [Placeholder] tokens as template subjects.

summaryboolean nullable

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

summaryFrequency'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'BIMONTHLY' nullable

Reporting frequency for summary invoices (MX only)

mxCfdiUsestring nullable

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.

Example request

{
  "sourceId": 100,
  "sourceKind": "RESERVATION",
  "includeTransactionIds": [
    123,
    456
  ],
  "recipient": {
    "type": "GUEST",
    "id": 1
  }
}

Response

OK

idstring
kind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING'

Kind of fiscal document

status'COMPLETED' | 'VOIDED' | 'PAID' | 'PENDING_INTEGRATION' | 'PARTIALLY_PAID' | 'COMPLETED_INTEGRATION' | 'FAILED_INTEGRATION' | 'CORRECTION_NEEDED' | 'CANCELED' | 'CANCEL_REQUESTED' | 'OPEN' | 'REQUESTED' | 'VOID_REQUESTED' | 'FAILED' | 'MANUALLY_RECONCILED' | 'REJECTED' | 'ACCEPTED' | 'PENDING_TRANSACTION' | 'ALLOCATED' | 'APPLIED'

Status of the fiscal document

linkedTostring

Example response

{
  "governmentIntegration": {
    "folioFiscal": "9B3E26F4-1234-4A5B-8C9D-ABCDEF012345",
    "ext": {
      "ar-arca-doc-type": "6",
      "arca-cae-expiry": "2026-10-02"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.