@nightsquawktech/appfolio-mcp-server 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMMERCIAL.md +35 -0
- package/LICENSE +661 -0
- package/README.md +127 -0
- package/dist/catalog/index.json +1511 -0
- package/dist/catalog/report-spec.js +27 -0
- package/dist/catalog/reports/account_totals.json +112 -0
- package/dist/catalog/reports/additional_fees.json +73 -0
- package/dist/catalog/reports/aged_payables_summary.json +124 -0
- package/dist/catalog/reports/aged_receivables_detail.json +132 -0
- package/dist/catalog/reports/amenities_by_property.json +73 -0
- package/dist/catalog/reports/annual_budget_comparative.json +138 -0
- package/dist/catalog/reports/annual_budget_forecast.json +125 -0
- package/dist/catalog/reports/appfolio_stack_usage.json +112 -0
- package/dist/catalog/reports/association_work_order.json +232 -0
- package/dist/catalog/reports/balance_sheet.json +124 -0
- package/dist/catalog/reports/balance_sheet_comparative.json +126 -0
- package/dist/catalog/reports/balance_sheet_comparison.json +113 -0
- package/dist/catalog/reports/bank_account_association.json +94 -0
- package/dist/catalog/reports/bill_detail.json +183 -0
- package/dist/catalog/reports/board_of_directors.json +87 -0
- package/dist/catalog/reports/budget_comparative.json +162 -0
- package/dist/catalog/reports/budget_comparison.json +141 -0
- package/dist/catalog/reports/cancelled_processes.json +122 -0
- package/dist/catalog/reports/cash_flow.json +158 -0
- package/dist/catalog/reports/cash_flow_comparison.json +158 -0
- package/dist/catalog/reports/cash_flow_detail.json +129 -0
- package/dist/catalog/reports/charge_detail.json +198 -0
- package/dist/catalog/reports/chart_of_accounts.json +22 -0
- package/dist/catalog/reports/check_register.json +181 -0
- package/dist/catalog/reports/check_register_detail.json +181 -0
- package/dist/catalog/reports/completed_processes.json +117 -0
- package/dist/catalog/reports/delinquency.json +164 -0
- package/dist/catalog/reports/delinquency_as_of.json +155 -0
- package/dist/catalog/reports/deposit_register.json +51 -0
- package/dist/catalog/reports/dues_roll.json +89 -0
- package/dist/catalog/reports/dues_roll_itemized.json +113 -0
- package/dist/catalog/reports/eligible_debt_summary.json +73 -0
- package/dist/catalog/reports/email_delivery_errors.json +104 -0
- package/dist/catalog/reports/expense_distribution.json +109 -0
- package/dist/catalog/reports/expense_register.json +149 -0
- package/dist/catalog/reports/fixed_assets.json +111 -0
- package/dist/catalog/reports/flows_assigned_tasks.json +103 -0
- package/dist/catalog/reports/fund_balance_sheet.json +113 -0
- package/dist/catalog/reports/fund_balance_sheet_active_funds.json +113 -0
- package/dist/catalog/reports/fund_income_statement.json +132 -0
- package/dist/catalog/reports/general_ledger.json +166 -0
- package/dist/catalog/reports/gross_potential_rent_enhanced.json +102 -0
- package/dist/catalog/reports/guest_card_inquiries.json +177 -0
- package/dist/catalog/reports/guest_cards.json +161 -0
- package/dist/catalog/reports/historical_advertised_rent.json +92 -0
- package/dist/catalog/reports/homeowner_delinquency.json +143 -0
- package/dist/catalog/reports/homeowner_delinquency_as_of.json +161 -0
- package/dist/catalog/reports/homeowner_directory.json +126 -0
- package/dist/catalog/reports/homeowner_ledger.json +59 -0
- package/dist/catalog/reports/homeowner_prepayment_balance.json +127 -0
- package/dist/catalog/reports/homeowner_resale.json +107 -0
- package/dist/catalog/reports/homeowner_vehicle_info.json +104 -0
- package/dist/catalog/reports/import_variances.json +41 -0
- package/dist/catalog/reports/in_progress_workflows.json +181 -0
- package/dist/catalog/reports/inactive_guest_cards.json +134 -0
- package/dist/catalog/reports/income_register.json +131 -0
- package/dist/catalog/reports/income_statement.json +130 -0
- package/dist/catalog/reports/income_statement_comparative.json +140 -0
- package/dist/catalog/reports/income_statement_comparison.json +135 -0
- package/dist/catalog/reports/income_statement_date_range.json +134 -0
- package/dist/catalog/reports/inspection_detail.json +107 -0
- package/dist/catalog/reports/insurance_enforcement.json +22 -0
- package/dist/catalog/reports/insurance_usage.json +92 -0
- package/dist/catalog/reports/inventory_status.json +73 -0
- package/dist/catalog/reports/inventory_usage.json +131 -0
- package/dist/catalog/reports/keys_detail.json +131 -0
- package/dist/catalog/reports/late_fee_policy_comparison.json +135 -0
- package/dist/catalog/reports/lease_expiration_detail.json +147 -0
- package/dist/catalog/reports/lease_expiration_summary.json +95 -0
- package/dist/catalog/reports/lease_history.json +147 -0
- package/dist/catalog/reports/leasing_agent_performance.json +54 -0
- package/dist/catalog/reports/leasing_funnel_performance.json +113 -0
- package/dist/catalog/reports/leasing_summary.json +92 -0
- package/dist/catalog/reports/loans.json +95 -0
- package/dist/catalog/reports/occupancy_custom_fields.json +73 -0
- package/dist/catalog/reports/occupancy_summary.json +95 -0
- package/dist/catalog/reports/owner1099.json +135 -0
- package/dist/catalog/reports/owner1099_detail.json +156 -0
- package/dist/catalog/reports/owner_custom_fields.json +73 -0
- package/dist/catalog/reports/owner_directory.json +101 -0
- package/dist/catalog/reports/owner_leasing.json +115 -0
- package/dist/catalog/reports/owner_withholdings.json +170 -0
- package/dist/catalog/reports/payment_plans.json +128 -0
- package/dist/catalog/reports/premium_leads_billing_detail.json +70 -0
- package/dist/catalog/reports/project_budget_detail.json +56 -0
- package/dist/catalog/reports/project_directory.json +144 -0
- package/dist/catalog/reports/property_budget.json +83 -0
- package/dist/catalog/reports/property_custom_fields.json +73 -0
- package/dist/catalog/reports/property_directory.json +73 -0
- package/dist/catalog/reports/property_group_directory.json +85 -0
- package/dist/catalog/reports/property_performance.json +115 -0
- package/dist/catalog/reports/property_staff_assignments.json +73 -0
- package/dist/catalog/reports/prospect_source_tracking.json +92 -0
- package/dist/catalog/reports/purchase_order.json +163 -0
- package/dist/catalog/reports/receivables_activity.json +138 -0
- package/dist/catalog/reports/renewal_summary.json +134 -0
- package/dist/catalog/reports/rent_roll.json +114 -0
- package/dist/catalog/reports/rent_roll_commercial.json +106 -0
- package/dist/catalog/reports/rent_roll_itemized.json +125 -0
- package/dist/catalog/reports/rentable_items.json +97 -0
- package/dist/catalog/reports/rental_applications.json +118 -0
- package/dist/catalog/reports/renter_directory.json +60 -0
- package/dist/catalog/reports/resident_financial_activity.json +107 -0
- package/dist/catalog/reports/screening_assessments.json +104 -0
- package/dist/catalog/reports/screening_usage.json +92 -0
- package/dist/catalog/reports/security_deposit_funds_detail.json +141 -0
- package/dist/catalog/reports/showings.json +123 -0
- package/dist/catalog/reports/student_housing_rent_roll_by_bed.json +125 -0
- package/dist/catalog/reports/surveys_summary.json +118 -0
- package/dist/catalog/reports/tenant_debt_collections_status.json +90 -0
- package/dist/catalog/reports/tenant_directory.json +120 -0
- package/dist/catalog/reports/tenant_ledger.json +72 -0
- package/dist/catalog/reports/tenant_tickler.json +102 -0
- package/dist/catalog/reports/tenant_transactions_summary.json +97 -0
- package/dist/catalog/reports/tenant_unpaid_charges_summary.json +147 -0
- package/dist/catalog/reports/tenant_vehicle_info.json +107 -0
- package/dist/catalog/reports/trial_balance.json +104 -0
- package/dist/catalog/reports/trial_balance_by_property.json +104 -0
- package/dist/catalog/reports/trust_account_balance.json +116 -0
- package/dist/catalog/reports/trust_account_balance_detail.json +112 -0
- package/dist/catalog/reports/twelve_month_cash_flow.json +157 -0
- package/dist/catalog/reports/twelve_month_income_statement.json +147 -0
- package/dist/catalog/reports/unit_custom_fields.json +73 -0
- package/dist/catalog/reports/unit_directory.json +80 -0
- package/dist/catalog/reports/unit_inspection.json +95 -0
- package/dist/catalog/reports/unit_turn_detail.json +104 -0
- package/dist/catalog/reports/unit_vacancy.json +143 -0
- package/dist/catalog/reports/unpaid_balances_by_month.json +181 -0
- package/dist/catalog/reports/upcoming_activities.json +142 -0
- package/dist/catalog/reports/vendor1099.json +84 -0
- package/dist/catalog/reports/vendor_custom_fields.json +22 -0
- package/dist/catalog/reports/vendor_directory.json +134 -0
- package/dist/catalog/reports/vendor_ledger.json +122 -0
- package/dist/catalog/reports/vendor_ledger_enhanced.json +122 -0
- package/dist/catalog/reports/violation_detail.json +122 -0
- package/dist/catalog/reports/work_order.json +254 -0
- package/dist/catalog/reports/work_order_labor_summary.json +148 -0
- package/dist/catalog-db/endpoint-spec.js +22 -0
- package/dist/catalog-db/endpoints/delete_inspections_inspectionid.json +21 -0
- package/dist/catalog-db/endpoints/delete_inventories_id.json +21 -0
- package/dist/catalog-db/endpoints/delete_properties_propertyid_marketing_photos_marketingphotoid.json +27 -0
- package/dist/catalog-db/endpoints/delete_properties_propertyid_photos_photoid.json +27 -0
- package/dist/catalog-db/endpoints/delete_units_unitid_photos_photoid.json +27 -0
- package/dist/catalog-db/endpoints/delete_work_orders_workorderid_attachments_attachmentid.json +27 -0
- package/dist/catalog-db/endpoints/get_bank_accounts.json +58 -0
- package/dist/catalog-db/endpoints/get_bills.json +185 -0
- package/dist/catalog-db/endpoints/get_ca_associations.json +106 -0
- package/dist/catalog-db/endpoints/get_ca_bank_balances.json +101 -0
- package/dist/catalog-db/endpoints/get_ca_board_members.json +146 -0
- package/dist/catalog-db/endpoints/get_ca_homeowner_ledgers.json +70 -0
- package/dist/catalog-db/endpoints/get_ca_homeowners.json +151 -0
- package/dist/catalog-db/endpoints/get_ca_renters.json +132 -0
- package/dist/catalog-db/endpoints/get_ca_rules.json +76 -0
- package/dist/catalog-db/endpoints/get_ca_units.json +130 -0
- package/dist/catalog-db/endpoints/get_ca_violations.json +119 -0
- package/dist/catalog-db/endpoints/get_charges.json +76 -0
- package/dist/catalog-db/endpoints/get_corporate_entities.json +88 -0
- package/dist/catalog-db/endpoints/get_custom_fields.json +120 -0
- package/dist/catalog-db/endpoints/get_delinquent_charges.json +88 -0
- package/dist/catalog-db/endpoints/get_gl_accounts.json +115 -0
- package/dist/catalog-db/endpoints/get_gl_details.json +154 -0
- package/dist/catalog-db/endpoints/get_inventories.json +131 -0
- package/dist/catalog-db/endpoints/get_inventory_locations.json +70 -0
- package/dist/catalog-db/endpoints/get_jobs.json +79 -0
- package/dist/catalog-db/endpoints/get_journal_entries.json +137 -0
- package/dist/catalog-db/endpoints/get_late_fee_policies.json +148 -0
- package/dist/catalog-db/endpoints/get_leads.json +248 -0
- package/dist/catalog-db/endpoints/get_leads_notes.json +83 -0
- package/dist/catalog-db/endpoints/get_leases.json +70 -0
- package/dist/catalog-db/endpoints/get_leases_renewal_pricings.json +52 -0
- package/dist/catalog-db/endpoints/get_listings.json +259 -0
- package/dist/catalog-db/endpoints/get_occupancies_documents.json +70 -0
- package/dist/catalog-db/endpoints/get_owner_groups.json +230 -0
- package/dist/catalog-db/endpoints/get_owners.json +258 -0
- package/dist/catalog-db/endpoints/get_owners_attachments.json +82 -0
- package/dist/catalog-db/endpoints/get_owners_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_owners_ownerid.json +247 -0
- package/dist/catalog-db/endpoints/get_payables.json +138 -0
- package/dist/catalog-db/endpoints/get_portfolios.json +70 -0
- package/dist/catalog-db/endpoints/get_properties.json +267 -0
- package/dist/catalog-db/endpoints/get_properties_attachments.json +76 -0
- package/dist/catalog-db/endpoints/get_properties_marketing_photos.json +76 -0
- package/dist/catalog-db/endpoints/get_properties_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_properties_photos.json +76 -0
- package/dist/catalog-db/endpoints/get_property_groups.json +84 -0
- package/dist/catalog-db/endpoints/get_recurring_charges.json +106 -0
- package/dist/catalog-db/endpoints/get_rental_applications.json +186 -0
- package/dist/catalog-db/endpoints/get_rental_applications_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_showings.json +99 -0
- package/dist/catalog-db/endpoints/get_tenant_ledgers.json +82 -0
- package/dist/catalog-db/endpoints/get_tenants.json +273 -0
- package/dist/catalog-db/endpoints/get_tenants_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_unit_types.json +168 -0
- package/dist/catalog-db/endpoints/get_units.json +359 -0
- package/dist/catalog-db/endpoints/get_units_attachments.json +76 -0
- package/dist/catalog-db/endpoints/get_units_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_units_photos.json +70 -0
- package/dist/catalog-db/endpoints/get_users.json +88 -0
- package/dist/catalog-db/endpoints/get_vendors.json +317 -0
- package/dist/catalog-db/endpoints/get_vendors_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_work_orders.json +322 -0
- package/dist/catalog-db/endpoints/get_work_orders_attachments.json +83 -0
- package/dist/catalog-db/endpoints/patch_bills_billid.json +156 -0
- package/dist/catalog-db/endpoints/patch_ca_violations_violationid.json +71 -0
- package/dist/catalog-db/endpoints/patch_inspections_inspectionid.json +77 -0
- package/dist/catalog-db/endpoints/patch_inventories_id.json +113 -0
- package/dist/catalog-db/endpoints/patch_inventory_locations_id.json +52 -0
- package/dist/catalog-db/endpoints/patch_journal_entries_journalentryid.json +90 -0
- package/dist/catalog-db/endpoints/patch_leads_guestcardid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_leads_leadid.json +162 -0
- package/dist/catalog-db/endpoints/patch_leases_leaseid.json +52 -0
- package/dist/catalog-db/endpoints/patch_owner_groups_id.json +72 -0
- package/dist/catalog-db/endpoints/patch_owners_ownerid.json +344 -0
- package/dist/catalog-db/endpoints/patch_owners_ownerid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_portfolios_portfolioid.json +46 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid.json +333 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid_marketing_photos_marketingphotoid.json +46 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid_photos_photoid.json +46 -0
- package/dist/catalog-db/endpoints/patch_property_groups_propertygroupid.json +40 -0
- package/dist/catalog-db/endpoints/patch_recurring_charges_recurringchargeid.json +89 -0
- package/dist/catalog-db/endpoints/patch_rental_applications_rentalapplicationid.json +47 -0
- package/dist/catalog-db/endpoints/patch_rental_applications_rentalapplicationid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_showings_showingid.json +69 -0
- package/dist/catalog-db/endpoints/patch_tenants_bulk.json +131 -0
- package/dist/catalog-db/endpoints/patch_tenants_tenantid.json +48 -0
- package/dist/catalog-db/endpoints/patch_tenants_tenantid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_unit_types_unittypeid.json +126 -0
- package/dist/catalog-db/endpoints/patch_units_unitid.json +296 -0
- package/dist/catalog-db/endpoints/patch_units_unitid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_units_unitid_photos_photoid.json +46 -0
- package/dist/catalog-db/endpoints/patch_vendors_vendorid.json +263 -0
- package/dist/catalog-db/endpoints/patch_vendors_vendorid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_work_orders_workorderid.json +273 -0
- package/dist/catalog-db/endpoints/patch_work_orders_workorderid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/post_bank_accounts_bulk.json +167 -0
- package/dist/catalog-db/endpoints/post_bills.json +160 -0
- package/dist/catalog-db/endpoints/post_bills_billid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_bills_bulk.json +185 -0
- package/dist/catalog-db/endpoints/post_bills_bulk_async.json +192 -0
- package/dist/catalog-db/endpoints/post_ca_violations.json +63 -0
- package/dist/catalog-db/endpoints/post_ca_violations_violationid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_charges.json +56 -0
- package/dist/catalog-db/endpoints/post_charges_bulk.json +70 -0
- package/dist/catalog-db/endpoints/post_charges_bulk_async.json +70 -0
- package/dist/catalog-db/endpoints/post_charges_chargeid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_corporate_gl_accounts_bulk.json +71 -0
- package/dist/catalog-db/endpoints/post_gl_accounts_bulk.json +77 -0
- package/dist/catalog-db/endpoints/post_inspections.json +70 -0
- package/dist/catalog-db/endpoints/post_inspections_bulk.json +76 -0
- package/dist/catalog-db/endpoints/post_inspections_inspectionid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_inventories.json +105 -0
- package/dist/catalog-db/endpoints/post_inventories_bulk.json +119 -0
- package/dist/catalog-db/endpoints/post_inventory_locations.json +44 -0
- package/dist/catalog-db/endpoints/post_inventory_locations_bulk.json +58 -0
- package/dist/catalog-db/endpoints/post_journal_entries.json +101 -0
- package/dist/catalog-db/endpoints/post_journal_entries_bulk.json +115 -0
- package/dist/catalog-db/endpoints/post_journal_entries_journalentryid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_late_fee_policies_bulk.json +115 -0
- package/dist/catalog-db/endpoints/post_leads.json +204 -0
- package/dist/catalog-db/endpoints/post_leads_guestcardid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_occupancies_occupancyid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_owner_groups.json +96 -0
- package/dist/catalog-db/endpoints/post_owners.json +330 -0
- package/dist/catalog-db/endpoints/post_owners_bulk.json +203 -0
- package/dist/catalog-db/endpoints/post_owners_ownerid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_owners_ownerid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_properties_bulk.json +245 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_marketing_photos.json +52 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_photos.json +40 -0
- package/dist/catalog-db/endpoints/post_recurring_charges.json +81 -0
- package/dist/catalog-db/endpoints/post_recurring_charges_bulk.json +95 -0
- package/dist/catalog-db/endpoints/post_rental_applications_rentalapplicationid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_rental_applications_rentalapplicationid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_showings.json +62 -0
- package/dist/catalog-db/endpoints/post_tenants_bulk.json +161 -0
- package/dist/catalog-db/endpoints/post_tenants_tenantid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_unit_types_bulk.json +138 -0
- package/dist/catalog-db/endpoints/post_units_bulk.json +236 -0
- package/dist/catalog-db/endpoints/post_units_unitid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_units_unitid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_units_unitid_photos.json +40 -0
- package/dist/catalog-db/endpoints/post_vendors.json +279 -0
- package/dist/catalog-db/endpoints/post_vendors_bulk.json +279 -0
- package/dist/catalog-db/endpoints/post_vendors_vendorid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_work_orders.json +251 -0
- package/dist/catalog-db/endpoints/post_work_orders_workorderid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_work_orders_workorderid_notes.json +40 -0
- package/dist/catalog-db/endpoints/put_leases_renewal_pricings_bulk.json +58 -0
- package/dist/catalog-db/endpoints/put_units_pricing_matrices_bulk.json +58 -0
- package/dist/catalog-db/endpoints/put_units_pricing_matrices_bulk_async.json +46 -0
- package/dist/catalog-db/endpoints/put_units_unitid_pricing_matrices.json +66 -0
- package/dist/catalog-db/index.json +1894 -0
- package/dist/clients/appfolio-client.js +131 -0
- package/dist/clients/appfolio-db-client.js +186 -0
- package/dist/helpers/register-db-tools.js +27 -0
- package/dist/helpers/register-report-tools.js +27 -0
- package/dist/index.js +10 -0
- package/dist/server/appfolio-mcp-server.js +18 -0
- package/dist/tools/call-endpoint.js +109 -0
- package/dist/tools/describe-endpoint.js +63 -0
- package/dist/tools/describe-report.js +55 -0
- package/dist/tools/list-endpoints.js +90 -0
- package/dist/tools/list-reports.js +58 -0
- package/dist/tools/run-report.js +102 -0
- package/package.json +42 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operationId": "post_inventories",
|
|
3
|
+
"resource": "inventories",
|
|
4
|
+
"name": "Create Inventory",
|
|
5
|
+
"method": "POST",
|
|
6
|
+
"path": "/inventories",
|
|
7
|
+
"description": "Create a new inventory item",
|
|
8
|
+
"deprecated": false,
|
|
9
|
+
"writeOperation": true,
|
|
10
|
+
"pagination": false,
|
|
11
|
+
"requestBody": {
|
|
12
|
+
"required": true,
|
|
13
|
+
"description": "Inventory object",
|
|
14
|
+
"attributes": [
|
|
15
|
+
{
|
|
16
|
+
"name": "Name",
|
|
17
|
+
"type": "string",
|
|
18
|
+
"required": true,
|
|
19
|
+
"description": "The name of the inventory item."
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "Cost",
|
|
23
|
+
"type": "string <decimal>",
|
|
24
|
+
"required": true,
|
|
25
|
+
"description": "The cost of the inventory item."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "Quantity",
|
|
29
|
+
"type": "integer",
|
|
30
|
+
"required": true,
|
|
31
|
+
"description": "The current quantity of the inventory item."
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "LocationId",
|
|
35
|
+
"type": "string <uuid>",
|
|
36
|
+
"required": true,
|
|
37
|
+
"description": "Unique identifier of the inventory location where this item is stored."
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "Reorder",
|
|
41
|
+
"type": "integer",
|
|
42
|
+
"required": false,
|
|
43
|
+
"description": "The quantity threshold at which the inventory item should be reordered."
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "Description",
|
|
47
|
+
"type": "string",
|
|
48
|
+
"required": false,
|
|
49
|
+
"description": "A brief summary or description of the inventory item."
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"name": "PartNumber",
|
|
53
|
+
"type": "string",
|
|
54
|
+
"required": false,
|
|
55
|
+
"description": "The part number of the inventory item."
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "Shelf",
|
|
59
|
+
"type": "string",
|
|
60
|
+
"required": false,
|
|
61
|
+
"description": "The shelf or bin location where the inventory item is stored."
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "Category",
|
|
65
|
+
"type": "string",
|
|
66
|
+
"required": false,
|
|
67
|
+
"description": "The category of the inventory item. If the category does not exist it will be created."
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "VendorId",
|
|
71
|
+
"type": "string <uuid>",
|
|
72
|
+
"required": false,
|
|
73
|
+
"description": "Unique identifier of the vendor associated with the inventory item."
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "GlAccountId",
|
|
77
|
+
"type": "string <uuid>",
|
|
78
|
+
"required": false,
|
|
79
|
+
"description": "Unique identifier of the general ledger account associated with the inventory item."
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"name": "MarkUpType",
|
|
83
|
+
"type": "string",
|
|
84
|
+
"required": false,
|
|
85
|
+
"description": "The type of markup applied to the inventory item. Valid values are Percentage or Fixed Amount. Required when MarkUp is provided.",
|
|
86
|
+
"enum": ["Percentage", "Fixed Amount"]
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"name": "MarkUp",
|
|
90
|
+
"type": "number",
|
|
91
|
+
"required": false,
|
|
92
|
+
"description": "The markup value applied to the inventory item."
|
|
93
|
+
}
|
|
94
|
+
]
|
|
95
|
+
},
|
|
96
|
+
"responseFields": [
|
|
97
|
+
{
|
|
98
|
+
"name": "Id",
|
|
99
|
+
"type": "string <uuid>",
|
|
100
|
+
"required": false,
|
|
101
|
+
"description": "Unique identifier for the created inventory item"
|
|
102
|
+
}
|
|
103
|
+
],
|
|
104
|
+
"requestSample": "{\n \"Name\": \"HVAC Filter\",\n \"Cost\": \"15.50\",\n \"Quantity\": \"25\",\n \"LocationId\": \"630964fb-bc9b-4f9a-b649-01cfe309ccc2\",\n \"Description\": \"20x25x1 air filter\",\n \"PartNumber\": \"HVAC-20-25-1\",\n \"Shelf\": \"A3\",\n \"MarkUpType\": \"Percentage\",\n \"MarkUp\": \"20.0\"\n}"
|
|
105
|
+
}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operationId": "post_inventories_bulk",
|
|
3
|
+
"resource": "inventories",
|
|
4
|
+
"name": "Bulk Create Inventories",
|
|
5
|
+
"method": "POST",
|
|
6
|
+
"path": "/inventories/bulk",
|
|
7
|
+
"description": "Create inventory items in bulk. Returns a JobId that can be used to retrieve the results of the bulk creation.",
|
|
8
|
+
"deprecated": false,
|
|
9
|
+
"writeOperation": true,
|
|
10
|
+
"pagination": false,
|
|
11
|
+
"requestBody": {
|
|
12
|
+
"required": true,
|
|
13
|
+
"description": "Inventory objects",
|
|
14
|
+
"attributes": [
|
|
15
|
+
{
|
|
16
|
+
"name": "data",
|
|
17
|
+
"type": "array",
|
|
18
|
+
"required": false,
|
|
19
|
+
"description": "Array of inventory objects to create in bulk",
|
|
20
|
+
"attributes": [
|
|
21
|
+
{
|
|
22
|
+
"name": "ReferenceId",
|
|
23
|
+
"type": "string",
|
|
24
|
+
"required": true,
|
|
25
|
+
"description": "Transient unique ID assigned by the developer. Used to reference individual inventory items in the bulk creation. Must be unique within the request."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "Name",
|
|
29
|
+
"type": "string",
|
|
30
|
+
"required": true,
|
|
31
|
+
"description": "The name of the inventory item."
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "Cost",
|
|
35
|
+
"type": "string <decimal>",
|
|
36
|
+
"required": true,
|
|
37
|
+
"description": "The cost of the inventory item."
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "Quantity",
|
|
41
|
+
"type": "string",
|
|
42
|
+
"required": true,
|
|
43
|
+
"description": "The current quantity of the inventory item."
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "LocationId",
|
|
47
|
+
"type": "string <uuid>",
|
|
48
|
+
"required": true,
|
|
49
|
+
"description": "Unique identifier of the inventory location where this item is stored."
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"name": "Reorder",
|
|
53
|
+
"type": "string",
|
|
54
|
+
"required": false,
|
|
55
|
+
"description": "The quantity threshold at which the inventory item should be reordered."
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "Description",
|
|
59
|
+
"type": "string",
|
|
60
|
+
"required": false,
|
|
61
|
+
"description": "A brief summary or description of the inventory item."
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "PartNumber",
|
|
65
|
+
"type": "string",
|
|
66
|
+
"required": false,
|
|
67
|
+
"description": "The part number of the inventory item."
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "Shelf",
|
|
71
|
+
"type": "string",
|
|
72
|
+
"required": false,
|
|
73
|
+
"description": "The shelf or bin location where the inventory item is stored."
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "Category",
|
|
77
|
+
"type": "string",
|
|
78
|
+
"required": false,
|
|
79
|
+
"description": "The category of the inventory item. If the category does not exist it will be created."
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"name": "VendorId",
|
|
83
|
+
"type": "string <uuid>",
|
|
84
|
+
"required": false,
|
|
85
|
+
"description": "Unique identifier of the vendor associated with the inventory item."
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "GlAccountId",
|
|
89
|
+
"type": "string <uuid>",
|
|
90
|
+
"required": false,
|
|
91
|
+
"description": "Unique identifier of the general ledger account associated with the inventory item."
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "MarkUpType",
|
|
95
|
+
"type": "string",
|
|
96
|
+
"required": false,
|
|
97
|
+
"description": "The type of markup applied to the inventory item. Valid values are Percentage or Fixed Amount. Required when MarkUp is provided.",
|
|
98
|
+
"enum": ["Percentage", "Fixed Amount"]
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "MarkUp",
|
|
102
|
+
"type": "string",
|
|
103
|
+
"required": false,
|
|
104
|
+
"description": "The markup value applied to the inventory item."
|
|
105
|
+
}
|
|
106
|
+
]
|
|
107
|
+
}
|
|
108
|
+
]
|
|
109
|
+
},
|
|
110
|
+
"responseFields": [
|
|
111
|
+
{
|
|
112
|
+
"name": "JobId",
|
|
113
|
+
"type": "string <uuid>",
|
|
114
|
+
"required": false,
|
|
115
|
+
"description": "Unique identifier of the bulk creation job, used to retrieve the results"
|
|
116
|
+
}
|
|
117
|
+
],
|
|
118
|
+
"requestSample": "{\n \"data\": [\n {}\n ]\n}"
|
|
119
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operationId": "post_inventory_locations",
|
|
3
|
+
"resource": "inventory_locations",
|
|
4
|
+
"name": "Create an Inventory Location",
|
|
5
|
+
"method": "POST",
|
|
6
|
+
"path": "/inventory_locations",
|
|
7
|
+
"description": "Creates a new inventory location",
|
|
8
|
+
"deprecated": false,
|
|
9
|
+
"writeOperation": true,
|
|
10
|
+
"pagination": false,
|
|
11
|
+
"requestBody": {
|
|
12
|
+
"required": true,
|
|
13
|
+
"description": "Inventory Location object",
|
|
14
|
+
"attributes": [
|
|
15
|
+
{
|
|
16
|
+
"name": "Name",
|
|
17
|
+
"type": "string",
|
|
18
|
+
"required": true,
|
|
19
|
+
"description": "The name of the inventory location"
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "Description",
|
|
23
|
+
"type": "string",
|
|
24
|
+
"required": false,
|
|
25
|
+
"description": "A brief summary or description of the inventory location"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "PropertyId",
|
|
29
|
+
"type": "string <uuid>",
|
|
30
|
+
"required": false,
|
|
31
|
+
"description": "Unique identifier of the property associated with the inventory location"
|
|
32
|
+
}
|
|
33
|
+
]
|
|
34
|
+
},
|
|
35
|
+
"responseFields": [
|
|
36
|
+
{
|
|
37
|
+
"name": "Id",
|
|
38
|
+
"type": "string <uuid>",
|
|
39
|
+
"required": false,
|
|
40
|
+
"description": "Unique identifier of the created inventory location"
|
|
41
|
+
}
|
|
42
|
+
],
|
|
43
|
+
"requestSample": "{\n \"Name\": \"Main Warehouse\",\n \"Description\": \"Primary storage location\",\n \"PropertyId\": \"1abcde23-c543-456e-abc9-123456789cba\"\n}"
|
|
44
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operationId": "post_inventory_locations_bulk",
|
|
3
|
+
"resource": "inventory_locations",
|
|
4
|
+
"name": "Bulk Create Inventory Locations",
|
|
5
|
+
"method": "POST",
|
|
6
|
+
"path": "/inventory_locations/bulk",
|
|
7
|
+
"description": "Create inventory locations in bulk",
|
|
8
|
+
"deprecated": false,
|
|
9
|
+
"writeOperation": true,
|
|
10
|
+
"pagination": false,
|
|
11
|
+
"requestBody": {
|
|
12
|
+
"required": true,
|
|
13
|
+
"description": "Inventory Location objects",
|
|
14
|
+
"attributes": [
|
|
15
|
+
{
|
|
16
|
+
"name": "data",
|
|
17
|
+
"type": "array",
|
|
18
|
+
"required": false,
|
|
19
|
+
"description": "Array of inventory location objects to create in bulk",
|
|
20
|
+
"attributes": [
|
|
21
|
+
{
|
|
22
|
+
"name": "ReferenceId",
|
|
23
|
+
"type": "string",
|
|
24
|
+
"required": true,
|
|
25
|
+
"description": "Transient unique ID assigned by the developer. Used to reference individual inventory locations in the bulk-creation of inventory locations."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "Name",
|
|
29
|
+
"type": "string",
|
|
30
|
+
"required": true,
|
|
31
|
+
"description": "The name of the inventory location"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "Description",
|
|
35
|
+
"type": "string",
|
|
36
|
+
"required": false,
|
|
37
|
+
"description": "A brief summary or description of the inventory location"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "PropertyId",
|
|
41
|
+
"type": "string <uuid>",
|
|
42
|
+
"required": false,
|
|
43
|
+
"description": "Unique identifier of the property associated with the inventory location"
|
|
44
|
+
}
|
|
45
|
+
]
|
|
46
|
+
}
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
"responseFields": [
|
|
50
|
+
{
|
|
51
|
+
"name": "JobId",
|
|
52
|
+
"type": "string <uuid>",
|
|
53
|
+
"required": false,
|
|
54
|
+
"description": "Unique identifier of the bulk creation job"
|
|
55
|
+
}
|
|
56
|
+
],
|
|
57
|
+
"requestSample": "{\n \"data\": [\n {}\n ]\n}"
|
|
58
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operationId": "post_journal_entries",
|
|
3
|
+
"resource": "journal_entries",
|
|
4
|
+
"name": "Create Journal Entries",
|
|
5
|
+
"method": "POST",
|
|
6
|
+
"path": "/journal_entries",
|
|
7
|
+
"description": "Create a journal entry",
|
|
8
|
+
"deprecated": false,
|
|
9
|
+
"writeOperation": true,
|
|
10
|
+
"pagination": false,
|
|
11
|
+
"requestBody": {
|
|
12
|
+
"required": true,
|
|
13
|
+
"description": "Journal Entry object",
|
|
14
|
+
"attributes": [
|
|
15
|
+
{
|
|
16
|
+
"name": "EntryDate",
|
|
17
|
+
"type": "string",
|
|
18
|
+
"required": true,
|
|
19
|
+
"description": "The date the journal entry was created. Valid format is \"YYYY-MM-DD\" e.g. \"2022-03-03\"."
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "PropertyId",
|
|
23
|
+
"type": "string <uuid>",
|
|
24
|
+
"required": true,
|
|
25
|
+
"description": "Unique identifier of the property or association related to the journal entry"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "LineItems",
|
|
29
|
+
"type": "array",
|
|
30
|
+
"required": true,
|
|
31
|
+
"description": "Array of line-item objects. Two or more line-item objects must be passed to create a journal entry. The sum of the total debits must equal the total credits for all line-item objects.",
|
|
32
|
+
"attributes": [
|
|
33
|
+
{
|
|
34
|
+
"name": "Credit",
|
|
35
|
+
"type": "string <decimal>",
|
|
36
|
+
"required": false,
|
|
37
|
+
"description": "The credit amount. Total debits and credits must be equal. For example, if line-item 1 has a credit of \"10.00\", line-item 2 must have a debit of \"10.00\"."
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "Debit",
|
|
41
|
+
"type": "string <decimal>",
|
|
42
|
+
"required": false,
|
|
43
|
+
"description": "The debit amount. Total debits and credits must be equal. For example, if line-item 1 has a credit of \"10.00\", line-item 2 must have a debit of \"10.00\"."
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "Description",
|
|
47
|
+
"type": "string",
|
|
48
|
+
"required": false,
|
|
49
|
+
"description": "A brief, informative description of the journal entry's line item"
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"name": "GlAccountId",
|
|
53
|
+
"type": "string <uuid>",
|
|
54
|
+
"required": false,
|
|
55
|
+
"description": "Unique identifier of the general ledger account associated with the journal entry line item"
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "ReferenceNumber",
|
|
59
|
+
"type": "string",
|
|
60
|
+
"required": false,
|
|
61
|
+
"description": "The reference number representing the transaction in your ledger. This will be automatically assigned unless provided."
|
|
62
|
+
}
|
|
63
|
+
]
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"name": "AccountingBasis",
|
|
67
|
+
"type": "string",
|
|
68
|
+
"required": false,
|
|
69
|
+
"description": "The accounting basis for the journal entry. Defaults to All.",
|
|
70
|
+
"enum": ["All", "CashOnly", "AccrualOnly"]
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "ScheduledReversalDate",
|
|
74
|
+
"type": "string <date>",
|
|
75
|
+
"required": false,
|
|
76
|
+
"description": "The date on which this journal entry should be automatically reversed. Must not be before EntryDate."
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "Id",
|
|
80
|
+
"type": "string <uuid>",
|
|
81
|
+
"required": false,
|
|
82
|
+
"description": "Unique identifier of the journal entry"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "Remarks",
|
|
86
|
+
"type": "string",
|
|
87
|
+
"required": false,
|
|
88
|
+
"description": "A description or summary of the journal entry"
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
},
|
|
92
|
+
"responseFields": [
|
|
93
|
+
{
|
|
94
|
+
"name": "Id",
|
|
95
|
+
"type": "string <uuid>",
|
|
96
|
+
"required": false,
|
|
97
|
+
"description": "Unique identifier of the created journal entry"
|
|
98
|
+
}
|
|
99
|
+
],
|
|
100
|
+
"requestSample": "{\n \"EntryDate\": \"2022-02-01\",\n \"PropertyId\": \"71c5cb28-547f-11ec-bfa5-02975b268737\",\n \"ReferenceNumber\": \"123\",\n \"Remarks\": \"Payroll November\",\n \"AccountingBasis\": \"All\",\n \"ScheduledReversalDate\": \"2022-03-01\",\n \"LineItems\": [\n {},\n {}\n ]\n}"
|
|
101
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operationId": "post_journal_entries_bulk",
|
|
3
|
+
"resource": "journal_entries",
|
|
4
|
+
"name": "Bulk Create Journal Entries",
|
|
5
|
+
"method": "POST",
|
|
6
|
+
"path": "/journal_entries/bulk",
|
|
7
|
+
"description": "Create journal entries in bulk",
|
|
8
|
+
"deprecated": false,
|
|
9
|
+
"writeOperation": true,
|
|
10
|
+
"pagination": false,
|
|
11
|
+
"requestBody": {
|
|
12
|
+
"required": true,
|
|
13
|
+
"description": "Journal Entry objects",
|
|
14
|
+
"attributes": [
|
|
15
|
+
{
|
|
16
|
+
"name": "data",
|
|
17
|
+
"type": "array",
|
|
18
|
+
"required": false,
|
|
19
|
+
"description": "Array of JournalEntry objects",
|
|
20
|
+
"attributes": [
|
|
21
|
+
{
|
|
22
|
+
"name": "EntryDate",
|
|
23
|
+
"type": "string",
|
|
24
|
+
"required": true,
|
|
25
|
+
"description": "The date the journal entry was created. Valid format is \"YYYY-MM-DD\" e.g. \"2022-03-03\"."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "PropertyId",
|
|
29
|
+
"type": "string <uuid>",
|
|
30
|
+
"required": true,
|
|
31
|
+
"description": "Unique identifier of the property or association related to the journal entry"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "LineItems",
|
|
35
|
+
"type": "array",
|
|
36
|
+
"required": true,
|
|
37
|
+
"description": "Array of line-item objects. Two or more line-item objects must be passed to create a journal entry. The sum of the total debits must equal the total credits for all line-item objects.",
|
|
38
|
+
"attributes": [
|
|
39
|
+
{
|
|
40
|
+
"name": "Credit",
|
|
41
|
+
"type": "string",
|
|
42
|
+
"required": false,
|
|
43
|
+
"description": "The credit amount. Total debits and credits must be equal."
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "Debit",
|
|
47
|
+
"type": "string",
|
|
48
|
+
"required": false,
|
|
49
|
+
"description": "The debit amount. Total debits and credits must be equal."
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"name": "Description",
|
|
53
|
+
"type": "string",
|
|
54
|
+
"required": false,
|
|
55
|
+
"description": "A brief, informative description of the journal entry's line item"
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "GlAccountId",
|
|
59
|
+
"type": "string",
|
|
60
|
+
"required": false,
|
|
61
|
+
"description": "Unique identifier of the general ledger account associated with the journal entry line item"
|
|
62
|
+
}
|
|
63
|
+
]
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"name": "ReferenceId",
|
|
67
|
+
"type": "string",
|
|
68
|
+
"required": true,
|
|
69
|
+
"description": "Transient unique ID assigned by the developer. Used to reference an individual journal entry in the bulk-creation of journal entries."
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "ReferenceNumber",
|
|
73
|
+
"type": "string",
|
|
74
|
+
"required": false,
|
|
75
|
+
"description": "The reference number representing the transaction in your ledger. This will be automatically assigned unless provided."
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "AccountingBasis",
|
|
79
|
+
"type": "string",
|
|
80
|
+
"required": false,
|
|
81
|
+
"description": "The accounting basis for the journal entry. Defaults to All.",
|
|
82
|
+
"enum": ["All", "CashOnly", "AccrualOnly"]
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "ScheduledReversalDate",
|
|
86
|
+
"type": "string <date>",
|
|
87
|
+
"required": false,
|
|
88
|
+
"description": "The date on which this journal entry should be automatically reversed. Must not be before EntryDate."
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"name": "Id",
|
|
92
|
+
"type": "string <uuid>",
|
|
93
|
+
"required": false,
|
|
94
|
+
"description": "Unique identifier of the journal entry"
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
"name": "Remarks",
|
|
98
|
+
"type": "string",
|
|
99
|
+
"required": false,
|
|
100
|
+
"description": "A description or summary of the journal entry"
|
|
101
|
+
}
|
|
102
|
+
]
|
|
103
|
+
}
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
"responseFields": [
|
|
107
|
+
{
|
|
108
|
+
"name": "JobId",
|
|
109
|
+
"type": "string <uuid>",
|
|
110
|
+
"required": false,
|
|
111
|
+
"description": "Unique identifier of the bulk job"
|
|
112
|
+
}
|
|
113
|
+
],
|
|
114
|
+
"requestSample": "{\n \"data\": [\n {}\n ]\n}"
|
|
115
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operationId": "post_journal_entries_journalentryid_attachments",
|
|
3
|
+
"resource": "journal_entries",
|
|
4
|
+
"name": "Create Journal Entry Attachment",
|
|
5
|
+
"method": "POST",
|
|
6
|
+
"path": "/journal_entries/{JournalEntryId}/attachments",
|
|
7
|
+
"description": "Upload an attachment to a journal entry",
|
|
8
|
+
"deprecated": false,
|
|
9
|
+
"writeOperation": true,
|
|
10
|
+
"pagination": false,
|
|
11
|
+
"pathParams": [
|
|
12
|
+
{
|
|
13
|
+
"name": "JournalEntryId",
|
|
14
|
+
"type": "string <uuid>",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The journal entry to which the file will be attached"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"requestBody": {
|
|
20
|
+
"required": true,
|
|
21
|
+
"description": "Attachment object (multipart/form-data)",
|
|
22
|
+
"attributes": [
|
|
23
|
+
{
|
|
24
|
+
"name": "File",
|
|
25
|
+
"type": "string",
|
|
26
|
+
"required": false,
|
|
27
|
+
"description": "Filename.file-extension",
|
|
28
|
+
"format": "binary"
|
|
29
|
+
}
|
|
30
|
+
]
|
|
31
|
+
},
|
|
32
|
+
"responseFields": [
|
|
33
|
+
{
|
|
34
|
+
"name": "Id",
|
|
35
|
+
"type": "string <uuid>",
|
|
36
|
+
"required": false,
|
|
37
|
+
"description": "Unique identifier of the journal_entries attachment"
|
|
38
|
+
}
|
|
39
|
+
],
|
|
40
|
+
"requestSample": "{\n \"File\": \"/path/to/file.pdf\"\n}"
|
|
41
|
+
}
|