CLcloudbeds
Fiscal Documents

Create a fiscal document of the type credit note

Create a fiscal document of the type credit note.

post/fiscal-document/v1/fiscal-documents/credit-note

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/credit-note
  • 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

sequenceIdinteger nullable
invoiceIdinteger required
reasonstring nullable
notestring nullable
userIdinteger nullable

Ignored. The document is attributed to the authenticated user.

method'VOID' | 'ADJUSTMENT' required
transactionIdsinteger[]

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

folioIdsinteger[]

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[]

Exclude transactions with the specified IDs

includeTransactionIdsinteger[]

Include transactions with the specified IDs

packageBreakdownboolean nullable

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

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.

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.