Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
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

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

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

Kind of the source entity

userIdinteger nullable
folioIdsinteger[]

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[]

Exclude transactions with the specified IDs

includeTransactionIdsinteger[]

Include transactions with the specified IDs

simplifiedboolean
dueDatePropertyTimezonestring date
notestring nullable
emailsstring[] nullable

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

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)

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"
  }
}