Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Create receipt for a payment.

Create a receipt for a payment and optionally specify allocations per transaction. In case of no allocations, a 'Simple receipt' will be created that can later be allocated to charge transactions. The amounts of all allocations must be equal to the payment amount. The transactions should not be fully allocated already and the amount allocated should not be more than the remaining balance on the transaction. All transactions not part of an invoice will be added to newly created invoice.

post/fiscal-document/v1/fiscal-documents/receipt

Headers

X-Property-IDinteger required

Property id

Request body

transactionIdinteger nullable

Id of the transaction associated to a payment. This parameter is mutually exclusive with paymentId.

paymentIdinteger nullable

Id of the payment. This parameter is mutually exclusive with transactionId.

invoiceIdinteger nullable

Id of invoice that receipt should be applied to. Ignored if allocations are presented.

sequenceIdinteger nullable
skipIntegrationboolean

At the moment this can only be set to True on Italy to skip the integration, for italy this case is needed to avoid Printing the Receipt

handwrittenboolean

Indicates this is a handwritten receipt created during POS unavailability. Only allowed for properties with Fiskaltrust integration enabled.

userIdinteger required
sourceIdinteger required
sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER' required

Kind of the source entity

Response

Receipt successfully created

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