Get GL accounts by UUIDs for a facility

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

glAccounts

get_by_uuids

Get GL accounts by UUIDs for a facility

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/glAccounts/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "glAccountUuids": [
    "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f"
  ]
}
'

import requests

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

payload = { "glAccountUuids": ["9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d", "1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f"] }
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({
    glAccountUuids: ['9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d', '1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/glAccounts/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}/glAccounts/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([
    'glAccountUuids' => [
        '9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d',
        '1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f'
    ]
  ]),
  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}/glAccounts/get_by_uuids"

	payload := strings.NewReader("{\n  \"glAccountUuids\": [\n    \"9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n    \"1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f\"\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}/glAccounts/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"glAccountUuids\": [\n    \"9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n    \"1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/glAccounts/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  \"glAccountUuids\": [\n    \"9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n    \"1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f\"\n  ]\n}"

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

[
  {
    "glAccountUuid": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "facilityUuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "glCode": "4000",
    "accountName": "Revenue - Rent",
    "accountCategory": "Revenue",
    "accountingBasis": "ACCRUAL"
  }
]

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

glAccountUuids

string<uuid>[]

required

Array of GL account UUIDs to retrieve data for

Example:

[
  "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f"
]

Response

200 - application/json

Successfully retrieved GL account data

glAccountUuid

string<uuid>

required

UUID of the GL account. It is the same identifier the ledger entries route reports per movement.

Example:

"9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"

facilityUuid

string<uuid>

required

UUID of the facility the account was requested for. Accounts are held by the organization behind the facility, not by the facility itself; this echoes the facility in the request path so a chart of accounts pulled facility by facility stays keyed.

Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

glCode

string | null

required

GL code of the account, as entered by the operator in Settings → Billing & Taxes → GL Accounts. Null until they enter one; it is the field to map against an external chart of accounts.

Example:

"4000"

accountName

string

required

Name of the GL account. The accrual and cash accounts of the same item usually share this name, so read accountingBasis to tell them apart.

Example:

"Revenue - Rent"

accountCategory

enum<string>

required

Chart-of-accounts category the account falls under, which decides whether it is debited or credited by a movement.

Available options:

Asset,

Liability,

Revenue,

Expense,

Equity,

Contra-Revenue,

Contra-Liability

Example:

"Revenue"

accountingBasis

enum<string>

required

Accounting basis the account belongs to. ACCRUAL recognises the amount when the invoice is issued, CASH when the money is received.

Available options:

ACCRUAL,

CASH

Example:

"ACCRUAL"

Get GL accounts by UUIDs for a facility

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/glAccounts/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "glAccountUuids": [
    "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f"
  ]
}
'

import requests

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

payload = { "glAccountUuids": ["9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d", "1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f"] }
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({
    glAccountUuids: ['9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d', '1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/glAccounts/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}/glAccounts/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([
    'glAccountUuids' => [
        '9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d',
        '1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f'
    ]
  ]),
  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}/glAccounts/get_by_uuids"

	payload := strings.NewReader("{\n  \"glAccountUuids\": [\n    \"9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n    \"1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f\"\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}/glAccounts/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"glAccountUuids\": [\n    \"9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n    \"1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/glAccounts/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  \"glAccountUuids\": [\n    \"9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n    \"1c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f\"\n  ]\n}"

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

[
  {
    "glAccountUuid": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "facilityUuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "glCode": "4000",
    "accountName": "Revenue - Rent",
    "accountCategory": "Revenue",
    "accountingBasis": "ACCRUAL"
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

GL Accounts

ECRI

Journal Entries

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 GL accounts by UUIDs for a facility

Headers

Path Parameters

Body

Response