API reference documentation for all modules located at: https://dev.folio.org/reference/api/
...
| Folio Attribute (Module/Path:Object) | Folio Data Element Description | Parameters/Query | |
|---|---|---|---|
| Table name: mod-finance-storage/transactions | |||
| Transaction ID (mod-finance-storage:transactions:id) | The UUID of a transaction | Will provide the Id's for all transactions needed for this report. The ID itself does not connect with other tables. Connection from transactions will be done via fiscal year, fund, and invoice tables. | Transaction Amountbe needed to link mod-invoice-storage and mod-finance-storage. Connects with mod-finance-storage/transactions/sourceInvoiceId. |
| Table Name: mode-finance-storage/fiscal_years | |||
| Fiscal Year ID (mod-finance-storage/transactions:amount) | The expenditure amount associated with a particular financial transaction | The ACRL statistical survey asks libraries to report the sum of all expenditures within a given category (i.e., "ongoing" or "one-time"), for a specified time period (e.g., fiscal year 2019). This report should return a sum of transaction amounts, as filtered by other elements. | |
| Transaction Type (mod-finance-storage/finance-storage/transactions:transactionType) | Describes the type of transaction, based on the pre-defined categories of: allocation, credit, encumbrance, payment, and transfer. | This element will be used to account for expenditures, when transactionType parameter will be selected to "Payment" and "Credit". One may wish to also include encumbrances, in which case the transactionType "encumbrances" parameter will be selected. | |
| fiscal_years | Fiscal Year ID (mod-finance-storage/fiscal_years:id) | UUID for a specific fiscal year | Will be used to provide a key time-based filter point. Provides a join point between mod-finance-storage/transactions and mod-finance-storage/fiscal-years. Connects with: mod-finance-storage/transactions:fiscalYearId |
| Fiscal Year Name (mod-finance-storage/fiscal-years:name) | The name of the fiscal year period | Provides a key time-based filter point for this report. ACRL reporting involves all transactions for a specific fiscal year period. | |
| Fiscal Year Code (mod-finance-storage/finance-storage/fiscal-years:code) | The code of the fiscal year period | Provides the code of the fiscal year. ACRL reporting involves all transactions for a specific fiscal year period. Ex: FY2020 | |
| Table Name: mode-finance-storage/funds | |||
Fund ID (mod-finance-storage/funds:Id) | UUID for a specific fund | Provides a join between transactions, budgets, and funds. Connects to: mod-finance-storage/transactions:fromFundId and mod-finance-storage/budgets:fundId | |
| Fund Name (mod-finance-storage/funds:name) | Provides the name of the fund | This report is asking for a total amount spent in a specific fiscal year for "shipping" and "binding". A specific fund is usually created for both, therefore filtering by fund will give us the total amount for each fund. | |
| Table Name: mod-finance-storage/Ledgers | |||
Ledger ID (mod-finance-storage/ledgers:Id) | UUID for a specific ledger | Provides a join between mod-finance-storage/finance-storage/funds and mod-finance-storage/ledgers. Connects with mod-finance-storage/funds:ledger:id | |
| Ledger Name (mod-finance-storage/ledgers:name) | Provides the name of the ledger | Supports filtering by ledger. | |
| Table Name: mode-finance-storage/Invoices | |||
| Invoice ID (mod-invoice-storage/invoices:id) | UUID of the invoice | Provides a join between mod-orders-storage/invoices and mod-orders-storage/orders_invoice_relns. This will give us access to mod-orders-storage/po_lines through mod-orders-storage/orders_invoice_relns . Connects with mod-orders-storage/orders_invoice-relns:invoiceId | |
| Table Name: mode-orders-storage/orders | |||
| Order ID (mod-orders-storage/orders:id) | UUID for a specific order | Provides a join between mod-order-storage/po_lines/purchaseOrderId and mod-storage/orders. Connects to: mod-orders-storage/po_lines:purchaseOrderId. This will allow us to pull order details related to an invoice. | |
| Order Type (mod-orders-storage/orders:order_type) | Provides the label for the order type ( One-Time or Ongoing) | Will be needed to get "One-time" or" Ongoing" expenditures. The ACRL report is asking for a sum of all expenditures for each category. Should be able to filter by order type. | |
| Table Name: mode-circulation-storage/items | |||
| Item ID (mod-inventory-storage/item-storage/items:id) | The UUID of an item | May not be needed for the ACRL report itself but will be needed to create a bridge between Pieces and Material Type. | |
| Table Name: mode-inventory-storage/ Material Types | |||
| Material Type ID (mod-inventory-storage/material_types:id) | UUID associated with any particular material type | Provides a join point between mod-inventory-storage/items:materialTypeId and mod-inventory-storage/material_type:id . Connects with mod-inventory-storage/items:materialTypeId. It will be needed to filter by material type name. | |
| Material Type Name (mod-inventory-storage/item-storage/material_types:name) | Label for the material type (e.g., "book") | Provides a means to filter by material type. Ex: Book, DVD, Microform etc. Will be needed to provide the format/type of the order. (Book, ER, DVD etc.) | |
| Table name: mod-inventory-storage/locations | |||
| Location ID (mod-inventory-storage/location/locations:id) | UUID of the location | Provides a join between mod-inventory-storage/location/locations and mod-inventory-storage/pieces:locationId. This will allow us to pull location for each piece (Pieces is in LDP) For the ACRL report, filtering by location may be needed. | |
| Location name (mod-inventory-storage/location/locations:name) | Name of the location | Will allow us to filter by location. One may also decide to suppress a specific location. | |
| Table Name: mod-inventory-storage/institutions | |||
| Institution ID (mod-inventory-storage/institutions:id) | UUID for an Institution | Provides a join point between mod-inventory-storage/location/locations and mod-inventory-storage/institutions (In LDP). This allows us to pull the name and code of an institution. Connects to mod-inventory-storage/location/locations:institutions:id | |
| Institution Name (mod-inventory-storage/institutions:name | Name of the Institution | Provides the Institution Name. | |
| Table Name: mod-inventory-storage/Campuses | |||
| Campus ID (mod-inventory-storage/campuses:id) | UUID for a Campus | Provides a join point between mod-inventory-storage/location/locations and mod-inventory-storage/campuses (In LDP). This allows us to pull name and code of a campus. Connects with mod-inventory-storage/location/locations:campusId | |
| Campus Name (mod-inventory-storage/campuses:name) | Name of the Campus | Provides the Campus Name in report. | |
| Table Name: mod-inventory-storage/Libraries | |||
| Library ID (mod-inventory-storage/libraries:id) | UUID of a Library | Provides a join point between mod-inventory-storage/location/locations and mod-inventory-storage/libraries (In LDP). This will allows us to pull name and code of a library. Connects with mod-inventory-storage/location/locations:libraryId | |
| Library Name (mod-inventory-storage/libraries:name | Name of the Library | Provides the Library Name. | |
| Table name: mod-orders-storage: po_lines | |||
| PO lines ID: (mod-orders-storage/po_lines:id) | The UUID of a PO Line | Will be used to connect to the table 'pieces' in order to be able to get to material types and location. Connects with mod-orders-storage/pieces:PoLineId. | |
| Po PO lines Order Format name: (mod-orders-storage/po-lines/order-format:name) | Provides the format of the item purchased | Will provide in the report the format name of the order. (Electronic Resource, Physical Resource, P/E Mix,Other). | |
| Table name: mod-orders-storage/pieces | |||
| Pieces Id: (mod-orders-storage/pieces:id) | The UUID of a Piece | Will be used to connect with the Locations table. Act as a bridge between mod-orders-storage/pieces and mode-orders-inventory/location/locations. Connects with mod-orders-storage/pieces:locationId. | |
| Table Name: mod-orders-storage/orders_invoice_relns | |||
| Orders_Invoice_relns ID (mod-orders-storage/orders_invoice_relns:id) | The UUID of a relationship between order and invoice | Provides a join between mod-orders-storage/invoices and mod-orders-storage/orders. Connects with mod-orders-storage/orders_invoice_relns:purchaseOrdeId. |
...