Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
ledgerEntries
/
get_by_uuids
Get facility ledger entries by UUIDs
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/ledgerEntries/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "lineItemLedgerUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"
  ]
}
'
[
  {
    "lineItemLedgerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "invoiceUuid": "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
    "unitRentalRecordUuid": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
    "ledgerEntryItemTypeUuid": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
    "ledgerEntryStartDate": "2024-01-15T10:30:00.000Z",
    "ledgerEntryEndDate": "2024-01-15T10:30:00.000Z",
    "invoiceItemBalance": 15000,
    "invoiceItemDescription": "Monthly Storage Fee",
    "invoiceItemOriginalBalance": 15000,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "invoiceDueDate": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "transactionType": "INVOICE",
    "itemTypeCategory": "COVERAGE"
  }
]

Documentation Index

Fetch the complete documentation index at: https://api.monument.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

​
facilityUuid
string
required

Body

application/json
​
lineItemLedgerUuids
string<uuid>[]
required

Array of ledger entry UUIDs to retrieve data for

Example:
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"
]

Response

Ledger entry details retrieved successfully

​
lineItemLedgerUuid
string<uuid>
required

UUID of the ledger entry

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
invoiceUuid
string<uuid>
required

UUID of the invoice

Example:

"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"

​
unitRentalRecordUuid
string<uuid>
required

UUID of the rental record associated with this ledger entry

Example:

"5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"

​
ledgerEntryItemTypeUuid
string<uuid>
required

UUID of the item type

Example:

"5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"

​
ledgerEntryStartDate
string<date-time>
required

Start date of the ledger entry service period

Example:

"2024-01-15T10:30:00.000Z"

​
ledgerEntryEndDate
string<date-time>
required

End date of the ledger entry service period

Example:

"2024-01-15T10:30:00.000Z"

​
invoiceItemBalance
number
required

Current balance of the invoice item in pennies

Example:

15000

​
invoiceItemDescription
string | null
required

Description of the invoice item

Example:

"Monthly Storage Fee"

​
invoiceItemOriginalBalance
number | null
required

Original balance of the invoice item

Example:

15000

​
createdAt
string<date-time>
required

Date when the ledger entry was created

Example:

"2024-01-15T10:30:00.000Z"

​
invoiceDueDate
string<date-time>
required

Invoice due date

Example:

"2024-01-15T10:30:00.000Z"

​
updatedAt
string<date-time>
required

Date when the ledger entry was last updated

Example:

"2024-01-20T15:45:00.000Z"

​
transactionType
enum<string>
required

Type of transaction for this ledger entry

Available options:
PAYMENT,
CREDIT,
BAD_DEBT_WRITE_OFF,
REFUND,
VOID,
INVOICE,
CREDIT_MEMO,
TRANSFER_CREDIT,
REVERSED_CREDIT,
FAILED_PAYMENT_REVERSAL,
VOID_INVOICE,
VOID_CHECK,
CHARGEBACK,
DEBIT_MEMO,
AUCTION_PAYMENT,
AUCTION_PAYOUT,
BALANCE_TRANSFER
Example:

"INVOICE"

​
itemTypeCategory
string | null
required

Category of the item type linked to the invoice item. Null if the invoice item has no linked item type.

Example:

"COVERAGE"