Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Allocate payment associated with receipt to charge transactions.

Allocate payment associated with receipt 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/allocate-payment

Headers

X-Property-IDinteger required

Property id

Request body

receiptIdinteger required

Id of the receipt.

Response

Receipt will be accepted to start the process of document creation according to country rules

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