API Reference

Create a fiscal document of the type pro forma invoice

post
https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/pro-forma-invoice/preview

Create a fiscal document of the type pro forma invoice.

Pro Forma Invoice Characteristics:

  • Contains pending transactions that are subject to change
  • Includes payment information
  • Transactions are NOT locked (unlike regular invoices)
  • Can be converted to regular invoices later when transactions are posted
  • Has its own sequence numbering and settings
Body Params
transactionIds
array of int64s
required
deprecated

List of pending transaction IDs to include in the pro forma invoice (deprecated, use includeTransactionIds instead)

transactionIds*
transactionIdToAmount
object | null

Map of transaction ID to amount (in major currency units, e.g., 10.50 for $10.50) for partial transaction inclusion

paymentIds
array of int64s

List of payment IDs associated with the pending transactions

paymentIds
int64
required
≥ 1
int64 | null
≥ 1
string
enum
required

Kind of the source entity

Allowed:
int64 | null
≥ 0
recipient
object
required
date

Date for the pro forma invoice (defaults to current date if not provided)

folioIds
array of int64s

Include all transactions from the specified folio IDs

folioIds
excludeTransactionIds
array of int64s

Exclude transactions with the specified IDs

excludeTransactionIds
includeTransactionIds
array of int64s

Include transactions with the specified IDs

includeTransactionIds
Headers
int64
required
≥ 1

Property id

Response

Updated 5 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/octet-stream
Updated 5 months ago