Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Configs

Updates a config of a specific kind

Update document config.

put/fiscal-document/v1/configs/{documentKind}

Path parameters

documentKind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING' required

Kind of fiscal document

The kind of the fiscal document.

Headers

X-Property-IDinteger required

Property id

Request body

triggerEventsDocumentTriggerEvent[]
showDetailedTaxFeeboolean required
chargeBreakdownboolean required
allowPendingTransactionsboolean
useGuestLangboolean required
dueDaysinteger
sequenceStartNumberinteger nullable
langstring nullable
prefixstring nullable
separatorstring nullable
suffixstring nullable
legalCompanyNamestring nullable
titleobject nullable
showLegalCompanyNameboolean required
includeRoomNumberboolean required
useDocumentNumberboolean required
updateInvoiceOnLinkDocumentboolean
isCompactboolean required
useInvoiceTitleAndNumberingboolean

Flag to determine if invoice title, sequenceStartNumber, prefix and suffix should be used.

useInvoiceDocumentSettingsboolean

Flag to determine if invoice document settings should be used.

showCreditNotesAndReceiptsboolean

Flag to determine if linked credit notes and receipts should be rendered in Invoice.

taxId1string nullable
taxId2string nullable
cpfstring nullable
customTextobject nullable
logoIdinteger nullable
dateDisplay'service_date' | 'transaction_date' | 'both'

Controls which date columns to show on the document

Example request

{
  "title": {
    "en": "Invoice",
    "es": "Factura"
  }
}

Response

OK

propertyIdstring
documentKind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING'

Kind of fiscal document

showDetailedTaxFeeboolean
showCreditNotesAndReceiptsboolean
chargeBreakdownboolean
useGuestLangboolean
allowPendingTransactionsboolean
dueDaysinteger
langstring
prefixstring
suffixstring
separatorstring
legalCompanyNamestring
titleobject
showLegalCompanyNameboolean
includeRoomNumberboolean
useDocumentNumberboolean
isCompactboolean
taxId1string
taxId2string
cpfstring
customTextobject
triggerEventsDocumentTriggerEvent[]
updateInvoiceOnLinkDocumentboolean
useInvoiceDocumentSettingsboolean
useInvoiceTitleAndNumberingboolean
dateDisplay'service_date' | 'transaction_date' | 'both'

Controls which date columns to show on the document