CLcloudbeds
Fiscal Documents

Get payment allocation transactions

Retrieves payment allocations.

get/fiscal-document/v1/fiscal-documents/allocations

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/allocations
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
      Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: read:reservation

Query parameters

sourceIdsinteger[]

source IDs.

sourceIdentifiersstring[]

source Identifiers.

sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER'

Kind of the source entity

Filter by source kind.

receiptIdsinteger[]

document IDs.

Headers

X-Property-IDinteger required

Property id

Response

OK

receipt_idinteger
source_idinteger
source_identifierstring
source_kind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER'

Kind of the source entity

Example response

[
  {
    "receipt_id": 8878321883381,
    "source_id": 8878321883383,
    "source_identifier": "HGJXJF",
    "allocations": [
      {
        "transaction_id": 8878321883388,
        "allocated_amount": 3.68
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.