Get rental record ledger entries by UUIDs

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

rentalRecords

{unitRentalRecordUuid}

ledgerEntries

get_by_uuids

Get rental record ledger entries by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/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"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids"

payload = { "lineItemLedgerUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lineItemLedgerUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'lineItemLedgerUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids"

	payload := strings.NewReader("{\n  \"lineItemLedgerUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lineItemLedgerUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lineItemLedgerUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "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",
    "itemTypeName": "Rent",
    "taxInvoicedInPennies": 858,
    "taxAppliedFromPaymentInPennies": 400,
    "taxRate": 8.25,
    "taxCodes": {
      "stateTaxCode": "TX-STATE",
      "cityTaxCode": "TX-AUS",
      "countyTaxCode": "TX-TRAVIS",
      "specialTaxCode": "TX-SPECIAL"
    },
    "discountInPennies": 1000,
    "promotionUuid": "6bf96c30-4fb1-11f1-a3fa-b52fba19bc64",
    "payment": {
      "tenderType": "CREDIT/DEBIT",
      "source": "VISA"
    },
    "invoiceStatus": "OPEN"
  }
]

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

unitRentalRecordUuid

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

Rental records 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"

itemTypeName

string

required

Display name of the item type linked to the invoice item.

Example:

"Rent"

taxInvoicedInPennies

number

required

Tax charged by this ledger movement, in pennies (sum of the state, city, county and special components). Signed: negative on promotion, credit memo, void and reversal movements, so summing the movements of an invoice item yields the tax actually charged. 0 when the movement carries no invoiced tax.

Example:

858

taxAppliedFromPaymentInPennies

number

required

Tax settled by this ledger movement, in pennies (sum of the state, city, county and special components applied from a payment). Signed: negative on unapply and reversal movements, so summing the movements yields the tax actually collected. 0 when the movement settles no tax.

Example:

400

taxRate

number

required

Tax rate of the invoice item this movement refers to, as a percentage (e.g. 8.25 = 8.25%). Unlike the amounts above it is an item-level rate, not a per-movement value, so a payment movement carrying no invoiced tax still reports the rate of the charge it settles. 0 when the invoice item is untaxed.

Example:

8.25

taxCodes

object

required

Tax codes carried by this ledger movement, one per jurisdiction. Always present; each code is null when the movement carries none for that jurisdiction.

Show child attributes

discountInPennies

number

required

Realized discount carried by this ledger movement, in pennies. Only promotion movements carry one; signed, so a movement that reverses a promotion is negative and summing the movements yields the discount actually realized. 0 on every other movement.

Example:

1000

promotionUuid

string<uuid> | null

required

UUID of the promotion that drove the discount on this line. Null when no promotion-driven discount.

Example:

"6bf96c30-4fb1-11f1-a3fa-b52fba19bc64"

payment

object | null

required

Payment tender/source details. Null on non-payment lines (INVOICE/CREDIT/etc.).

Show child attributes

invoiceStatus

enum<string>

required

Status of the invoice this ledger entry belongs to

Available options:

OPEN,

OVERDUE,

PARTIAL,

PAID,

VOID,

WRITTEN_OFF

Example:

"OPEN"

Get rental record ledger entries by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/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"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids"

payload = { "lineItemLedgerUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lineItemLedgerUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'lineItemLedgerUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids"

	payload := strings.NewReader("{\n  \"lineItemLedgerUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lineItemLedgerUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/ledgerEntries/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lineItemLedgerUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "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",
    "itemTypeName": "Rent",
    "taxInvoicedInPennies": 858,
    "taxAppliedFromPaymentInPennies": 400,
    "taxRate": 8.25,
    "taxCodes": {
      "stateTaxCode": "TX-STATE",
      "cityTaxCode": "TX-AUS",
      "countyTaxCode": "TX-TRAVIS",
      "specialTaxCode": "TX-SPECIAL"
    },
    "discountInPennies": 1000,
    "promotionUuid": "6bf96c30-4fb1-11f1-a3fa-b52fba19bc64",
    "payment": {
      "tenderType": "CREDIT/DEBIT",
      "source": "VISA"
    },
    "invoiceStatus": "OPEN"
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

ECRI

Ledger Entries

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Payments

Webhooks

Get rental record ledger entries by UUIDs

Headers

Path Parameters

Body

Response