API endpoints: Accounting
The 230 Accounting resources: their published and service-account paths, what may be done with each, and every field with its type.
Every Accounting resource another product can reach, 230 in all. Each one is reached two ways: through the published API at /api/v1/<code> once an administrator has published it (its code is the resource name unless they chose another), or with a service account at /api/accounting/<resource>. The verbs, parameters, filters and answers are the same for every resource and are in API endpoint reference: how to call TRANXACT.
Fields: * means required when creating; (read-only) means it is returned but not accepted on a create or change. org_id, created_at, updated_at, created_by and updated_by are on most records and are set by TRANXACT. The id is a uuid unless the table says otherwise. Field names are the JSON keys.
Asset Accounting
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Asset Classes (asset-classes) | /api/v1/asset-classes · /api/accounting/asset-classes · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, parent_id uuid, category text, cost_account_id uuid, accum_depr_account_id uuid, depr_expense_account_id uuid, disposal_account_id uuid, gain_account_id uuid, loss_account_id uuid, impairment_account_id uuid, revaluation_reserve_account_id uuid, default_life_months integer, default_method text, default_salvage_pct numeric, low_value_threshold numeric, capitalisation_threshold numeric, requires_location boolean, requires_custodian boolean, requires_serial boolean, number_prefix text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Asset Movements (asset-transactions) | /api/v1/asset-transactions · /api/accounting/asset-transactions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), txn_no text (read-only), asset_id* uuid, area_id uuid, txn_type* text, txn_date date, period_code text, amount numeric, quantity numeric, percentage numeric, currency text, from_cost_center_id uuid, to_cost_center_id uuid, from_org_unit_id uuid, to_org_unit_id uuid, from_location text, to_location text, proceeds numeric, net_book_value_at_txn numeric (read-only), gain_loss numeric (read-only), buyer text, reason text, journal_id uuid (read-only), run_id uuid (read-only), reverses_txn_id uuid (read-only), status text (read-only), posted_by uuid (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Depreciation Areas (depreciation-areas) | /api/v1/depreciation-areas · /api/accounting/depreciation-areas · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, area_type text, ledger_id uuid, principle_id uuid, currency text, posts_to_ledger boolean, is_derived boolean, derived_from_area_id uuid, derived_minus_area_id uuid, allows_revaluation boolean, allows_impairment boolean, takes_over_cost boolean, takes_over_life boolean, is_leading boolean, sort_order integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Depreciation Keys (depreciation-keys) | /api/v1/depreciation-keys · /api/accounting/depreciation-keys · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, method text, declining_factor numeric, switch_to_straight_line boolean, period_convention text, depreciate_below_salvage boolean, bonus_first_year_pct numeric, base_unit text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Depreciation Runs (depreciation-runs) | /api/v1/depreciation-runs · /api/accounting/depreciation-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), area_id uuid, period_code* text, period_from* date, period_to* date, run_type text, is_test_run boolean, status text (read-only), asset_count integer (read-only), total_depreciation numeric (read-only), journal_id uuid (read-only), error_count integer (read-only), exceptions jsonb (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Parallel Valuation (asset-valuations) | /api/v1/asset-valuations · /api/accounting/asset-valuations · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), asset_id* uuid, area_id* uuid, depreciation_key_id uuid, acquisition_cost numeric, subsequent_cost numeric, revaluation_amount numeric, impairment_amount numeric, gross_value numeric (read-only), salvage_value numeric, useful_life_months integer, remaining_life_months integer, depreciation_start date, accumulated_depreciation numeric (read-only), accumulated_impairment numeric (read-only), net_book_value numeric (read-only), total_units numeric, units_used numeric, currency text, last_run_period text (read-only), is_fully_depreciated boolean (read-only), is_closed boolean (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Physical Verification (asset-inventories) | /api/v1/asset-inventories · /api/accounting/asset-inventories · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), inventory_no text (read-only), name* text, asset_class_id uuid, cost_center_id uuid, location text, as_of_date date, status text (read-only), counted_by uuid, expected_count integer (read-only), found_count integer (read-only), missing_count integer (read-only), unrecorded_count integer (read-only), write_off_amount numeric (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Assets
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Asset Register (asset-register) | /api/v1/asset-register · /api/accounting/asset-register · /{id} | list, get | id uuid (read-only), asset_no text (read-only), name text (read-only), asset_class text (read-only), acquisition_date date (read-only), cost numeric (read-only), useful_life_months integer (read-only), accumulated_depreciation numeric (read-only), status text (read-only), custodian text (read-only), location text (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), asset_class_id uuid (read-only), parent_asset_id uuid (read-only), sub_number integer (read-only), description text (read-only), serial_no text (read-only), inventory_no text (read-only), manufacturer text (read-only), model text (read-only), quantity numeric (read-only), currency text (read-only), salvage_value numeric (read-only), in_service_date date (read-only), capitalisation_date date (read-only), retirement_date date (read-only), disposal_date date (read-only), disposal_proceeds numeric (read-only), disposal_reason text (read-only), supplier_id uuid (read-only), purchase_order_id uuid (read-only), ap_invoice_id uuid (read-only), custodian_employee_id uuid (read-only), location_id uuid (read-only), is_under_construction boolean (read-only), wbs_element_id uuid (read-only), lease_id uuid (read-only), property_id uuid (read-only), insured_value numeric (read-only), insurance_policy_no text (read-only), barcode text (read-only), last_verified_at date (read-only), notes text (read-only), class_code text (read-only), class_name text (read-only), category text (read-only), cost_center_code text (read-only), cost_center_name text (read-only), org_unit_name text (read-only), custodian_name text (read-only), supplier_name text (read-only), leading_area_id uuid (read-only), leading_area_code text (read-only), gross_value numeric (read-only), accum_depreciation numeric (read-only), net_book_value numeric (read-only), life_months integer (read-only), remaining_life_months integer (read-only), depreciation_start date (read-only), depreciation_key text (read-only), depreciation_method text (read-only), depreciated_pct numeric (read-only), area_count integer (read-only), movement_count integer (read-only), component_count integer (read-only) |
| Assets Held (assets-held) | /api/v1/assets-held · /api/accounting/assets-held · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), asset_no text (read-only), asset_name text (read-only), asset_class text (read-only), serial_no text (read-only), barcode text (read-only), cost numeric (read-only), currency text (read-only), issued_on date (read-only), status text (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_status text (read-only), termination_date date (read-only), holder_name text (read-only), department text (read-only), location_name text (read-only), days_held integer (read-only), holder_is_leaving boolean (read-only), last_movement date (read-only) |
| Assets to Capitalise (assets-to-capitalise) | /api/v1/assets-to-capitalise · /api/accounting/assets-to-capitalise · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), asset_no text (read-only), name text (read-only), description text (read-only), status text (read-only), serial_no text (read-only), quantity numeric (read-only), cost numeric (read-only), currency text (read-only), acquisition_date date (read-only), asset_class_id uuid (read-only), class_code text (read-only), class_name text (read-only), useful_life_months integer (read-only), capital_basis text (read-only), location text (read-only), location_id uuid (read-only), cost_center_id uuid (read-only), cost_center_code text (read-only), supplier_id uuid (read-only), supplier_name text (read-only), purchase_order_id uuid (read-only), po_no text (read-only), receipt_id uuid (read-only), receipt_no text (read-only), receipt_line_id uuid (read-only), po_line_id uuid (read-only), po_line_no integer (read-only), item_id uuid (read-only), item_no text (read-only), item_name text (read-only), org_unit_name text (read-only), waiting_for text (read-only), is_ready boolean (read-only) |
| Custody Trail (asset-custody) | /api/v1/asset-custody · /api/accounting/asset-custody · /{id} | list, get | id uuid (read-only), asset_id uuid (read-only), seq_no integer (read-only), event_type text (read-only), occurred_on date (read-only), reference_no text (read-only), condition text (read-only), acknowledged boolean (read-only), notes text (read-only), asset_no text (read-only), asset_name text (read-only), asset_class text (read-only), asset_status text (read-only), holder_name text (read-only), holder_no text (read-only), holder_status text (read-only), from_name text (read-only), held_by_unit text (read-only), held_at text (read-only), performed_by_name text (read-only) |
| Fixed Assets (fixed-assets) | /api/v1/fixed-assets · /api/accounting/fixed-assets · /{id} | list, get, create, change, delete | id uuid (read-only), asset_no* text, name* text, asset_class text, acquisition_date* date, cost* numeric, useful_life_months integer, accumulated_depreciation numeric, status text, custodian text, location text, org_unit_id uuid (read-only), cost_center_id uuid, profit_center_id uuid, asset_class_id uuid, parent_asset_id uuid (read-only), sub_number integer (read-only), description text, serial_no text, inventory_no text (read-only), manufacturer text (read-only), model text (read-only), quantity numeric (read-only), currency text (read-only), salvage_value numeric, in_service_date date, capitalisation_date date (read-only), retirement_date date (read-only), disposal_date date (read-only), disposal_proceeds numeric (read-only), disposal_reason text (read-only), supplier_id uuid (read-only), purchase_order_id uuid (read-only), ap_invoice_id uuid (read-only), custodian_employee_id uuid (read-only), location_id uuid (read-only), is_under_construction boolean (read-only), wbs_element_id uuid (read-only), lease_id uuid (read-only), property_id uuid (read-only), insured_value numeric (read-only), insurance_policy_no text (read-only), barcode text (read-only), last_verified_at date (read-only), notes text (read-only), issued_on date (read-only), returned_on date (read-only), serial_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), receipt_id uuid (read-only), receipt_line_id uuid (read-only), po_line_id uuid (read-only), item_id uuid (read-only), receipt_unit integer (read-only), capital_basis text (read-only), cancelled_reason text (read-only), capitalisation_journal_id uuid (read-only) |
Bank Connectivity
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Bank Aggregators (bank-aggregators) | /api/v1/bank-aggregators · /api/accounting/bank-aggregators · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), provider* text, label* text, environment text, base_url text, client_id text, client_secret_cipher bytea (read-only), products _text, countries _text, is_default boolean, is_active boolean, redirect_uri text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Bank Catalogue (bank-catalogue) | /api/v1/bank-catalogue · /api/accounting/bank-catalogue · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, short_name text, country text, external_id text, aggregator text, brand_color text, initials text, provider_id uuid, auth_flow text, needs_mfa boolean, products _text, popularity integer, is_active boolean, supports_direct_connect boolean, ofx_url text, ofx_org text, ofx_fid text, ofx_version integer, ofx_app_id text (read-only), ofx_app_ver text (read-only), credential_label text, credential_help text, enrolment_url text, credential_ttl_days integer, supports_oauth boolean, oauth_network text, oauth_authorize_url text, oauth_token_url text, oauth_scopes _text, data_api_base text, data_api_standard text, oauth_uses_pkce boolean, developer_url text, consent_ttl_days integer, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Bank Channels (bank-providers) | /api/v1/bank-providers · /api/accounting/bank-providers · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, short_name text, country text, swift_bic text, routing_number text, website text, docs_url text, support_phone text, integration_types _text, auth_methods _text, statement_formats _text, payment_formats _text, supports_realtime_balance boolean, supports_transaction_feed boolean, supports_webhooks boolean, supports_ach boolean, supports_wire boolean, supports_rtp boolean, supports_positive_pay boolean, default_api_url text, default_sftp_host text, ach_cutoff time without time zone, wire_cutoff time without time zone, bank_timezone text, settlement_days integer, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Bank Data Recipients (bank-data-recipients) | /api/v1/bank-data-recipients · /api/accounting/bank-data-recipients · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), network* text, institution_id uuid, label* text, environment text, client_id text, client_secret_cipher bytea (read-only), redirect_uri text, authorize_url text, token_url text, data_api_base text, scopes _text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Bank Monitoring
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Bank Exchange Log (bank-sync-runs) | /api/v1/bank-sync-runs · /api/accounting/bank-sync-runs · /{id} | list, get | id uuid (read-only), connection_id uuid (read-only), bank_account_id uuid (read-only), run_no text (read-only), sync_type text (read-only), direction text (read-only), status text (read-only), records_received integer (read-only), records_new integer (read-only), records_duplicate integer (read-only), records_matched integer (read-only), duration_ms integer (read-only), cursor_from text (read-only), cursor_to text (read-only), message text (read-only), error text (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Banks & Accounts
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Bank Accounts (bank-accounts) | /api/v1/bank-accounts · /api/accounting/bank-accounts · /{id} | list, get, create, change, delete | id uuid (read-only), name* text, bank_name* text, account_masked* text, currency text, gl_account_id uuid, is_active boolean, org_unit_id uuid (read-only), provider_id uuid (read-only), connection_id uuid (read-only), account_number_cipher bytea (read-only), routing_number text (read-only), iban text (read-only), swift_bic text (read-only), external_account_id text (read-only), account_type text (read-only), purpose text (read-only), ledger_balance numeric (read-only), available_balance numeric (read-only), balance_as_of timestamp with time zone (read-only), overdraft_limit numeric (read-only), minimum_balance numeric (read-only), sync_enabled boolean (read-only), last_sync_at timestamp with time zone (read-only), last_statement_date date (read-only), is_primary boolean (read-only), cost_center_id uuid (read-only), link_session_id uuid (read-only), ofx_bank_id text (read-only), ofx_account_type text (read-only), country text (read-only), iban_masked text (read-only), target_balance numeric (read-only), is_restricted boolean (read-only), restriction_reason text (read-only), interest_rate_pct numeric (read-only), value_date_offset_days integer (read-only), pool_id uuid (read-only), opened_date date (read-only), closed_date date (read-only), signatories text (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Bank Connections (bank-connections) | /api/v1/bank-connections · /api/accounting/bank-connections · /{id} | list, get, create, change, delete | id uuid (read-only), provider_id* uuid, code* text, name* text, environment text, integration_type text, auth_method text, base_url text, token_url text, client_id text, client_secret_cipher bytea (read-only), api_key_cipher bytea (read-only), scopes _text, certificate_cipher bytea (read-only), certificate_expires date, sftp_host text, sftp_port integer, sftp_username text, sftp_key_cipher bytea (read-only), inbound_dir text, outbound_dir text, pgp_key_id text, company_id text, ach_company_id text, ach_company_name text, originator_id text, division_code text, webhook_url text, webhook_secret_cipher bytea (read-only), notification_email text, poll_interval_minutes integer, statement_format text, payment_format text, auto_reconcile boolean, auto_post boolean, match_tolerance numeric, match_window_days integer, platform_connection_id uuid, status text, last_tested_at timestamp with time zone (read-only), last_test_ok boolean (read-only), last_test_message text (read-only), last_sync_at timestamp with time zone (read-only), owner_id uuid, notes text, org_unit_id uuid (read-only), link_session_id uuid (read-only), aggregator_id uuid (read-only), external_item_id text (read-only), ofx_url text (read-only), ofx_org text (read-only), ofx_fid text (read-only), ofx_version integer (read-only), ofx_app_id text (read-only), ofx_app_ver text (read-only), ofx_user_id text (read-only), ofx_password_cipher bytea (read-only), ofx_client_uid text (read-only), credential_stored_at timestamp with time zone (read-only), credential_last_ok_at timestamp with time zone (read-only), credential_expires_at timestamp with time zone (read-only), credential_status text (read-only), credential_message text (read-only), pulled_through date (read-only), oauth_client_id uuid (read-only), oauth_access_cipher bytea (read-only), oauth_refresh_cipher bytea (read-only), oauth_expires_at timestamp with time zone (read-only), consent_expires_at timestamp with time zone (read-only), data_api_base text (read-only), data_api_standard text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Budgeting
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Allotment Status (budget-allotment-status) | /api/v1/budget-allotment-status · /api/accounting/budget-allotment-status · /{budget_line_id} | list, get | budget_line_id uuid (read-only), budget_id uuid (read-only), budget_code text (read-only), fiscal_year integer (read-only), account_no text (read-only), account_name text (read-only), cost_center_code text (read-only), control_basis text (read-only), appropriation numeric (read-only), allotted numeric (read-only), unallotted numeric (read-only), committed numeric (read-only), actual numeric (read-only), available_appropriation numeric (read-only), available_allotment numeric (read-only) |
| Budget Allotments (budget-allotments) | /api/v1/budget-allotments · /api/accounting/budget-allotments · /{id} | list, get | id uuid (read-only), budget_line_id uuid (read-only), allot_date date (read-only), delta numeric (read-only), memo text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Budget Lines (budget-lines) | /api/v1/budget-lines · /api/accounting/budget-lines · /{id} | list, get | id uuid (read-only), budget_id uuid (read-only), line_no integer (read-only), gl_account_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), org_unit_id uuid (read-only), funding_source_id uuid (read-only), period_code text (read-only), amount_planned numeric (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Budgets (budgets) | /api/v1/budgets · /api/accounting/budgets · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, fiscal_year* integer, budget_type text, status text, control_level text, tolerance_pct numeric, owner_employee_id uuid, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), control_basis text |
| Funding Sources (funding-sources) | /api/v1/funding-sources · /api/accounting/funding-sources · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, source_type text, sponsor text, external_ref text, amount_awarded numeric, currency text, start_date date, end_date date, is_restricted boolean, status text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Capital Planning
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Capital Scenarios (asset-scenarios) | /api/v1/asset-scenarios · /api/accounting/asset-scenarios · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, scenario_type text, area_id uuid, baseline_scenario_id uuid, horizon_from date, horizon_months integer, currency text, inflation_pct numeric, capex_growth_pct numeric, disposal_rate_pct numeric, life_extension_months integer, fx_shift_pct numeric, status text (read-only), total_depreciation numeric (read-only), total_capex numeric (read-only), closing_nbv numeric (read-only), peak_period text (read-only), peak_amount numeric (read-only), calculated_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Scenario Assumptions (scenario-assumptions) | /api/v1/scenario-assumptions · /api/accounting/scenario-assumptions · /{id} | list, get, create, change, delete | id uuid (read-only), scenario_id* uuid, line_no integer, assumption text, asset_id uuid, asset_class_id uuid, cost_center_id uuid, description text, effective_date date, amount numeric, quantity numeric, life_months integer, method text, salvage_value numeric, percentage numeric, probability_pct numeric, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Cash Movement
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Bank Feed (bank-transactions) | /api/v1/bank-transactions · /api/accounting/bank-transactions · /{id} | list, get, create, change, delete | id uuid (read-only), bank_account_id uuid (read-only), connection_id uuid (read-only), statement_id uuid (read-only), external_id text (read-only), posted_date date (read-only), value_date date (read-only), direction text (read-only), amount numeric (read-only), running_balance numeric (read-only), currency text (read-only), description text (read-only), counterparty text (read-only), counterparty_account text (read-only), bank_reference text (read-only), customer_reference text (read-only), check_no text (read-only), bai_code text (read-only), transaction_code text (read-only), category text, gl_account_id uuid, cost_center_id uuid, matched_rule_id uuid (read-only), match_status text, match_confidence numeric (read-only), ap_payment_id uuid (read-only), ar_receipt_id uuid (read-only), journal_id uuid (read-only), reconciliation_id uuid (read-only), status text (read-only), raw jsonb (read-only), received_at timestamp with time zone (read-only), seq bigint (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Feed Rules (bank-feed-rules) | /api/v1/bank-feed-rules · /api/accounting/bank-feed-rules · /{id} | list, get, create, change, delete | id uuid (read-only), bank_account_id uuid, code* text, name* text, priority integer, direction text, description_like text, counterparty_like text, bai_code text, min_amount numeric, max_amount numeric, category text, gl_account_id uuid, cost_center_id uuid, auto_post boolean, set_match_status text, hit_count integer (read-only), last_hit_at timestamp with time zone (read-only), is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Payment Batches (payment-batches) | /api/v1/payment-batches · /api/accounting/payment-batches · /{id} | list, get, create, change, delete | id uuid (read-only), connection_id uuid, bank_account_id* uuid, batch_no text (read-only), payment_type text, file_format text, effective_date* date, currency text, item_count integer (read-only), total_amount numeric (read-only), status text (read-only), file_name text (read-only), file_hash text (read-only), file_content text (read-only), trace_number text (read-only), bank_reference text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), transmitted_at timestamp with time zone (read-only), acknowledged_at timestamp with time zone (read-only), rejection_reason text (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Reconciliation (bank-reconciliations) | /api/v1/bank-reconciliations · /api/accounting/bank-reconciliations · /{id} | list, get, create, change, delete | id uuid (read-only), bank_account_id uuid (read-only), statement_id uuid (read-only), reconciliation_no text (read-only), period_start date (read-only), period_end date (read-only), statement_balance numeric (read-only), ledger_balance numeric (read-only), outstanding_deposits numeric (read-only), outstanding_payments numeric (read-only), difference numeric (read-only), matched_count integer (read-only), unmatched_count integer (read-only), status text (read-only), closed_at timestamp with time zone (read-only), closed_by uuid (read-only), notes text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), deposits_in_transit numeric (read-only), outstanding_checks numeric (read-only), book_items jsonb (read-only) |
| Statements (bank-statements) | /api/v1/bank-statements · /api/accounting/bank-statements · /{id} | list, get | id uuid (read-only), bank_account_id uuid (read-only), connection_id uuid (read-only), statement_no text (read-only), bank_statement_ref text (read-only), format text (read-only), statement_date date (read-only), period_start date (read-only), period_end date (read-only), opening_balance numeric (read-only), closing_balance numeric (read-only), currency text (read-only), credit_count integer (read-only), debit_count integer (read-only), credit_total numeric (read-only), debit_total numeric (read-only), status text (read-only), balance_check numeric (read-only), source_name text (read-only), imported_by uuid (read-only), imported_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Consolidation
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Account Mappings (account-mappings) | /api/v1/account-mappings · /api/accounting/account-mappings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), group_id uuid, company_id* uuid, gl_account_id uuid, account_pattern text, group_account_id* uuid, weight numeric, valid_from date, valid_to date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Consolidation Adjustments (consolidation-adjustments) | /api/v1/consolidation-adjustments · /api/accounting/consolidation-adjustments · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), group_id* uuid, adj_no text (read-only), period_code* text, company_id uuid, adjustment_type text, description* text, group_account_id uuid, debit_amount numeric, credit_amount numeric, currency text, reason text, is_recurring boolean, reverses_next_period boolean, status text (read-only), submitted_by uuid (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Consolidation Groups (consolidation-groups) | /api/v1/consolidation-groups · /api/accounting/consolidation-groups · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, parent_group_id uuid, group_currency text, principle_id uuid, ledger_id uuid, fiscal_year_start_month integer, translation_reserve_account_id uuid, goodwill_account_id uuid, minority_interest_account_id uuid, rounding_account_id uuid, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Consolidation Runs (consolidation-runs) | /api/v1/consolidation-runs · /api/accounting/consolidation-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), group_id* uuid, period_code* text, period_from* date, period_to* date, version text, status text (read-only), group_currency text (read-only), entity_total numeric (read-only), translation_diff numeric (read-only), eliminations numeric (read-only), minority_interest numeric (read-only), group_total numeric (read-only), unit_count integer (read-only), line_count integer (read-only), exceptions jsonb (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), published_at timestamp with time zone (read-only), run_by uuid (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Elimination Rules (elimination-rules) | /api/v1/elimination-rules · /api/accounting/elimination-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), group_id uuid, code* text, name* text, rule_type text, debit_account_pattern text, credit_account_pattern text, group_account_id uuid, difference_account_id uuid, tolerance numeric, profit_basis text, sequence_no integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Group Chart of Accounts (group-accounts) | /api/v1/group-accounts · /api/accounting/group-accounts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), group_id uuid, code* text, name* text, account_type* text, parent_id uuid, is_monetary boolean, translation_rate_type text, cash_flow_category text, fs_caption text, sort_order integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Group Members (consolidation-units) | /api/v1/consolidation-units · /api/accounting/consolidation-units · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), group_id* uuid, company_id* uuid, method text, ownership_pct numeric, voting_pct numeric, minority_pct numeric (read-only), local_currency text, acquisition_date date, acquisition_cost numeric, net_assets_acquired numeric, goodwill numeric (read-only), disposal_date date, first_period text, last_period text, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Contract Costing
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Job Contracts (job-contracts) | /api/v1/job-contracts · /api/accounting/job-contracts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), contract_no text (read-only), name* text, project_id uuid, account_id uuid, rev_contract_id uuid, contract_type text, start_date date, end_date date, currency text, contract_value numeric, variation_value numeric, revised_value numeric (read-only), estimated_cost numeric, retention_pct numeric, retention_held numeric, retention_release_date date, advance_payment numeric, advance_recovered numeric, performance_bond numeric, liquidated_damages_rate numeric, progress_method text, status text (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), awarded_at timestamp with time zone (read-only), status_reason text (read-only) |
| Results Analysis (results-analysis) | /api/v1/results-analysis · /api/accounting/results-analysis · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id uuid (read-only), contract_id uuid (read-only), wbs_element_id uuid (read-only), period_code text (read-only), as_of_date date (read-only), method text (read-only), contract_revenue numeric (read-only), cost_to_date numeric (read-only), estimate_to_complete numeric (read-only), estimate_at_completion numeric (read-only), percent_complete numeric (read-only), earned_revenue numeric (read-only), billed_revenue numeric (read-only), revenue_in_excess_of_billings numeric (read-only), billings_in_excess_of_revenue numeric (read-only), recognised_cost numeric (read-only), wip_amount numeric (read-only), accrued_revenue numeric (read-only), deferred_revenue numeric (read-only), profit numeric (read-only), margin_pct numeric (read-only), expected_loss numeric (read-only), loss_provision numeric (read-only), is_loss_making boolean (read-only), journal_id uuid (read-only), status text (read-only), calculated_at timestamp with time zone (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Controlling
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Cost Centers (cost-centers) | /api/v1/cost-centers · /api/accounting/cost-centers · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, is_active boolean, org_unit_id uuid (read-only), parent_id uuid, profit_center_id uuid, center_type text, manager_employee_id uuid, valid_from date, valid_to date, is_blocked boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), responsible_user_id uuid |
| Profit Centers (profit-centers) | /api/v1/profit-centers · /api/accounting/profit-centers · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), parent_id uuid, code* text, name* text, center_type text, manager_employee_id uuid, currency text, valid_from date, valid_to date, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
E-invoicing
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| E-invoices (einvoice-documents) | /api/v1/einvoice-documents · /api/accounting/einvoice-documents · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), document_no text (read-only), invoice_id uuid (read-only), profile_id uuid (read-only), format text (read-only), kind text (read-only), status text (read-only), file_name text (read-only), mime text (read-only), xml text (read-only), pdf bytea (read-only), sha256 text (read-only), validation jsonb (read-only), error_count integer (read-only), warning_count integer (read-only), transport text (read-only), connection_id uuid (read-only), transport_ref text (read-only), sent_at timestamp with time zone (read-only), responded_at timestamp with time zone (read-only), response_message text (read-only), icv bigint (read-only), invoice_hash text (read-only), previous_invoice_hash text (read-only), print_template_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| E-invoicing Connections (einvoice-connections) | /api/v1/einvoice-connections · /api/accounting/einvoice-connections · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, provider_kind text, environment text, base_url text, auth_kind text, username text, secret_cipher bytea (read-only), settings jsonb, is_active boolean, last_status text (read-only), last_message text (read-only), last_used_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| E-invoicing Customer Identifiers (einvoice-party-ids) | /api/v1/einvoice-party-ids · /api/accounting/einvoice-party-ids · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), account_id* uuid, preferred_format text, vat_id text, legal_id text, peppol_scheme text, peppol_id text, leitweg_id text, buyer_reference text, it_codice_destinatario text, it_pec text, it_codice_fiscale text, mx_rfc text, mx_uso_cfdi text, mx_regimen_fiscal text, mx_domicilio_cp text, pl_nip text, street text, city text, postal_code text, subdivision text, country text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| E-invoicing Profiles (einvoice-profiles) | /api/v1/einvoice-profiles · /api/accounting/einvoice-profiles · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), profile_no text (read-only), name* text, country* text, format* text, is_active boolean, is_default boolean, seller_name text, seller_vat_id text, seller_tax_reg_id text, seller_legal_id text, seller_street text, seller_city text, seller_postal_code text, seller_subdivision text, contact_name text, contact_phone text, contact_email text, peppol_scheme text, peppol_id text, it_regime_fiscale text, it_codice_fiscale text, it_progressivo_prefix text, mx_rfc text, mx_regimen_fiscal text, mx_lugar_expedicion text, mx_serie text, pl_nip text, payment_means_code text, iban text, bic text, transport text, connection_id uuid, notes text, auto_submit boolean, retry_max_attempts integer, retry_backoff_minutes integer, invoice_template_id uuid, credit_note_template_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ZATCA API Log (zatca-api-log) | /api/v1/zatca-api-log · /api/accounting/zatca-api-log · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), unit_id uuid (read-only), invoice_id uuid (read-only), kind text (read-only), environment text (read-only), method text (read-only), url text (read-only), request_headers jsonb (read-only), request_body jsonb (read-only), http_status integer (read-only), response_body jsonb (read-only), outcome text (read-only), error text (read-only), duration_ms integer (read-only), idempotency_key text (read-only), attempt integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ZATCA Archive (zatca-archive) | /api/v1/zatca-archive · /api/accounting/zatca-archive · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), invoice_id uuid (read-only), invoice_no text (read-only), kind text (read-only), zatca_uuid uuid (read-only), icv bigint (read-only), invoice_hash text (read-only), previous_invoice_hash text (read-only), zatca_status text (read-only), egs_unit_id uuid (read-only), issued_at timestamp with time zone (read-only), content text (read-only), content_sha256 text (read-only), archived_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ZATCA Dashboard (zatca-dashboard) | /api/v1/zatca-dashboard · /api/accounting/zatca-dashboard · /{id} | list, get | id uuid (read-only), branch_unit_id uuid (read-only), code text (read-only), name text (read-only), common_name text (read-only), egs_serial text (read-only), organization_unit text (read-only), invoice_types text (read-only), location text (read-only), industry text (read-only), environment text (read-only), status text (read-only), is_default boolean (read-only), is_test boolean (read-only), public_key_der bytea (read-only), csr text (read-only), certificate text (read-only), certificate_serial text (read-only), certificate_issuer text (read-only), certificate_expires_at timestamp with time zone (read-only), compliance_csid text (read-only), compliance_request_id text (read-only), production_csid text (read-only), production_csid_expires_at timestamp with time zone (read-only), onboarded_at timestamp with time zone (read-only), last_icv bigint (read-only), last_hash text (read-only), last_invoice_id uuid (read-only), last_stamped_at timestamp with time zone (read-only), notes text (read-only), org_unit_id uuid (read-only), onboarding_step text (read-only), onboarding_step_at timestamp with time zone (read-only), onboarding_message text (read-only), compliance_passed_at timestamp with time zone (read-only), production_request_id text (read-only), pending_public_key_der bytea (read-only), pending_csr text (read-only), renewed_at timestamp with time zone (read-only), certificate_is_sample boolean (read-only), expiry_warned_on date (read-only), clearance_off_seen_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ZATCA Onboarding (zatca-onboarding) | /api/v1/zatca-onboarding · /api/accounting/zatca-onboarding · /{id} | list, get | id uuid (read-only), branch_unit_id uuid (read-only), code text (read-only), name text (read-only), common_name text (read-only), egs_serial text (read-only), organization_unit text (read-only), invoice_types text (read-only), location text (read-only), industry text (read-only), environment text (read-only), status text (read-only), is_default boolean (read-only), is_test boolean (read-only), public_key_der bytea (read-only), csr text (read-only), certificate text (read-only), certificate_serial text (read-only), certificate_issuer text (read-only), certificate_expires_at timestamp with time zone (read-only), compliance_csid text (read-only), compliance_request_id text (read-only), production_csid text (read-only), production_csid_expires_at timestamp with time zone (read-only), onboarded_at timestamp with time zone (read-only), last_icv bigint (read-only), last_hash text (read-only), last_invoice_id uuid (read-only), last_stamped_at timestamp with time zone (read-only), notes text (read-only), org_unit_id uuid (read-only), onboarding_step text (read-only), onboarding_step_at timestamp with time zone (read-only), onboarding_message text (read-only), compliance_passed_at timestamp with time zone (read-only), production_request_id text (read-only), pending_public_key_der bytea (read-only), pending_csr text (read-only), renewed_at timestamp with time zone (read-only), certificate_is_sample boolean (read-only), expiry_warned_on date (read-only), clearance_off_seen_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ZATCA Signing Units (zatca-egs-units) | /api/v1/zatca-egs-units · /api/accounting/zatca-egs-units · /{id} | list, get, create, change, delete | id uuid (read-only), branch_unit_id uuid, code* text, name* text, common_name* text, egs_serial* text, organization_unit text, invoice_types text, location text, industry text, environment text, status text (read-only), is_default boolean, is_test boolean, public_key_der bytea (read-only), csr text (read-only), certificate text (read-only), certificate_serial text (read-only), certificate_issuer text (read-only), certificate_expires_at timestamp with time zone (read-only), compliance_csid text (read-only), compliance_request_id text (read-only), production_csid text (read-only), production_csid_expires_at timestamp with time zone (read-only), onboarded_at timestamp with time zone (read-only), last_icv bigint (read-only), last_hash text (read-only), last_invoice_id uuid (read-only), last_stamped_at timestamp with time zone (read-only), notes text, org_unit_id uuid (read-only), onboarding_step text (read-only), onboarding_step_at timestamp with time zone (read-only), onboarding_message text (read-only), compliance_passed_at timestamp with time zone (read-only), production_request_id text (read-only), pending_public_key_der bytea (read-only), pending_csr text (read-only), renewed_at timestamp with time zone (read-only), certificate_is_sample boolean (read-only), expiry_warned_on date (read-only), clearance_off_seen_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ZATCA Submissions (zatca-submissions) | /api/v1/zatca-submissions · /api/accounting/zatca-submissions · /{id} | list, get | id uuid (read-only), invoice_no text (read-only), customer_account_id uuid (read-only), patient_id uuid (read-only), source_module text (read-only), source_ref text (read-only), invoice_date date (read-only), due_date date (read-only), currency text (read-only), subtotal numeric (read-only), tax numeric (read-only), total numeric (read-only), amount_paid numeric (read-only), status text (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), document_type text (read-only), related_invoice_id uuid (read-only), memo_reason text (read-only), cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), exchange_rate numeric (read-only), base_total numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), invoice_subtype text (read-only), issued_at timestamp with time zone (read-only), supply_date date (read-only), supply_end_date date (read-only), seller_snapshot jsonb (read-only), buyer_snapshot jsonb (read-only), zatca_qr text (read-only), vat_total_sar numeric (read-only), zatca_regime text (read-only), issued_backfilled boolean (read-only), zatca_uuid uuid (read-only), invoice_hash text (read-only), previous_invoice_hash text (read-only), icv bigint (read-only), subtype_changed_by uuid (read-only), subtype_changed_at timestamp with time zone (read-only), backfill_repaired_at timestamp with time zone (read-only), backfill_repair jsonb (read-only), supplier_gstin text (read-only), buyer_gstin text (read-only), supply_state_code text (read-only), place_of_supply text (read-only), is_interstate boolean (read-only), is_reverse_charge boolean (read-only), is_export boolean (read-only), export_type text (read-only), shipping_bill_no text (read-only), cgst_total numeric (read-only), sgst_total numeric (read-only), igst_total numeric (read-only), cess_total numeric (read-only), round_off numeric (read-only), duplicate_reason text (read-only), duplicate_of _text (read-only), duplicate_confirmed_by uuid (read-only), duplicate_confirmed_at timestamp with time zone (read-only), egs_unit_id uuid (read-only), zatca_invoice_type_code text (read-only), zatca_transaction_code text (read-only), zatca_status text (read-only), signed_xml text (read-only), zatca_signed_at timestamp with time zone (read-only), cleared_xml text (read-only), zatca_response jsonb (read-only), submitted_at timestamp with time zone (read-only), cleared_at timestamp with time zone (read-only), zatca_attempts integer (read-only), zatca_next_attempt_at timestamp with time zone (read-only), zatca_last_error text (read-only), payment_means_code text (read-only), eway_bill_required boolean (read-only), gst_doc_series_id uuid (read-only), gst_financial_year text (read-only), draft_invoice_no text (read-only), irn text (read-only), irn_ack_no text (read-only), irn_ack_date timestamp with time zone (read-only), irn_signed_qr text (read-only), irn_status text (read-only), zatca_replaced_by_id uuid (read-only), receivable_account_no text (read-only) |
Finance Automation
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Cash Application (cash-applications) | /api/v1/cash-applications · /api/accounting/cash-applications · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), bank_transaction_id uuid (read-only), ar_invoice_id uuid (read-only), amount numeric (read-only), confidence numeric (read-only), reasons jsonb (read-only), status text (read-only), ar_receipt_id uuid (read-only), applied_via text (read-only), applied_at timestamp with time zone (read-only), applied_by uuid (read-only), decided_reason text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Close Runs (close-job-runs) | /api/v1/close-job-runs · /api/accounting/close-job-runs · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), period_code text (read-only), set_code text (read-only), dry_run boolean (read-only), status text (read-only), steps jsonb (read-only), steps_total integer (read-only), steps_done integer (read-only), stopped_at_step integer (read-only), stop_reason text (read-only), resume_count integer (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Dunning Letters (dunning-letters) | /api/v1/dunning-letters · /api/accounting/dunning-letters · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), ar_invoice_id uuid (read-only), customer_account_id uuid (read-only), level integer (read-only), level_name text (read-only), days_overdue integer (read-only), amount numeric (read-only), currency text (read-only), to_address text (read-only), status text (read-only), note text (read-only), sent_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Dunning Levels (dunning-levels) | /api/v1/dunning-levels · /api/accounting/dunning-levels · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), level* integer, name* text, min_days_overdue* integer, subject* text, body* text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| E-invoice Submissions (einvoice-submissions) | /api/v1/einvoice-submissions · /api/accounting/einvoice-submissions · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), invoice_id uuid (read-only), profile_id uuid (read-only), document_id uuid (read-only), status text (read-only), attempts integer (read-only), max_attempts integer (read-only), next_attempt_at timestamp with time zone (read-only), last_attempt_at timestamp with time zone (read-only), last_error text (read-only), queued_by text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Finance Alerts (finance-alerts) | /api/v1/finance-alerts · /api/accounting/finance-alerts · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), kind text (read-only), subject_key text (read-only), raised_on date (read-only), title text (read-only), detail text (read-only), measured numeric (read-only), threshold numeric (read-only), cost_center_code text (read-only), account_no text (read-only), forecast_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Finance Automation Settings (fin-automation-settings) | /api/v1/fin-automation-settings · /api/accounting/fin-automation-settings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), cash_auto_apply_min numeric, cash_suggest_min numeric, cash_amount_tolerance numeric, cash_tolerance_pct numeric, pay_horizon_days integer, pay_bank_account_id uuid, credit_hold_after_days integer, soft_close_roles _text, budget_variance_pct numeric, cash_floor numeric, forecast_horizon_days integer, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Finance Configuration
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Account Determination (account-determination) | /api/v1/account-determination · /api/accounting/account-determination · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), posting_role* text, item_category_id uuid, customer_category_id uuid, supplier_category_id uuid, ledger_id uuid, account_id* uuid, priority integer, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Analytic Dimensions (analytic-dimensions) | /api/v1/analytic-dimensions · /api/accounting/analytic-dimensions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, is_required boolean, required_account_types text, sort_order integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Automatic Reversals (journal-auto-reversals) | /api/v1/journal-auto-reversals · /api/accounting/journal-auto-reversals · /{id} | list, get | id uuid (read-only), journal_id uuid (read-only), reverse_on date (read-only), status text (read-only), reversal_journal_id uuid (read-only), failure text (read-only), done_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Dimension Rules (dimension-rules) | /api/v1/dimension-rules · /api/accounting/dimension-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, account_from text, account_to text, account_type text, dimension_code* text, mode* text, allowed_values text, message text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Dimension Values (analytic-dimension-values) | /api/v1/analytic-dimension-values · /api/accounting/analytic-dimension-values · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), dimension_id* uuid, code* text, name* text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Exchange Rate Types (rate-types) | /api/v1/rate-types · /api/accounting/rate-types · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, applies_to text, fallback_code text, is_standard boolean (read-only), is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Finance Configuration (fin-config-settings) | /api/v1/fin-config-settings · /api/accounting/fin-config-settings · /{id} | list, get, create, change, delete | id uuid (read-only), ap_price_tolerance_pct numeric, ap_quantity_tolerance_pct numeric, ap_match_option text, honour_item_accounts boolean, role_resolution text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Journal Types (journal-types) | /api/v1/journal-types · /api/accounting/journal-types · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, allowed_sources text, number_range_key text, number_prefix text, requires_approval boolean, auto_reverse boolean, reverse_rule text, reverse_after_days integer, max_backdated_days integer, allowed_account_types text, max_amount numeric, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Ledger Account Map (ledger-account-map) | /api/v1/ledger-account-map · /api/accounting/ledger-account-map · /{id} | list, get, create, change, delete | id uuid (read-only), ledger_id* uuid, from_account_id* uuid, to_account_id* uuid, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Period Close by Module (period-module-closes) | /api/v1/period-module-closes · /api/accounting/period-module-closes · /{id} | list, get | id uuid (read-only), period_code text (read-only), module text (read-only), ledger_id uuid (read-only), status text (read-only), closed_at timestamp with time zone (read-only), closed_by uuid (read-only), reopened_at timestamp with time zone (read-only), reopened_by uuid (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Finance Intelligence
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Assistant Suggestions (ai-suggestions) | /api/v1/ai-suggestions · /api/accounting/ai-suggestions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), suggestion_type text (read-only), document_type text (read-only), document_id uuid (read-only), document_no text (read-only), line_no integer (read-only), suggestion jsonb (read-only), suggested_text text (read-only), confidence numeric (read-only), reasoning text (read-only), basis jsonb (read-only), alternatives jsonb (read-only), model text (read-only), model_version text (read-only), status text, accepted_by uuid (read-only), decided_at timestamp with time zone (read-only), actual_value jsonb (read-only), was_correct boolean (read-only), feedback text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Case Actions (case-actions) | /api/v1/case-actions · /api/accounting/case-actions · /{id} | list, get, create, change, delete | id uuid (read-only), case_id* uuid, line_no integer, action* text, performed_by uuid, performed_at timestamp with time zone (read-only), detail text, amount numeric, document_ref text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Coding Patterns (coding-patterns) | /api/v1/coding-patterns · /api/accounting/coding-patterns · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), pattern_type text, match_key* text, supplier_id uuid, expense_type_id uuid, gl_account_id uuid, cost_center_id uuid, tax_code_id uuid, project_id uuid, observation_count integer, agreement_pct numeric, last_seen_at timestamp with time zone (read-only), is_confirmed boolean, confirmed_by uuid, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Detector Performance (detector-performance) | /api/v1/detector-performance · /api/accounting/detector-performance · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), detector_id uuid (read-only), period_code text (read-only), documents_scanned integer (read-only), signals_raised integer (read-only), cases_opened integer (read-only), true_positives integer (read-only), false_positives integer (read-only), inconclusive integer (read-only), amount_flagged numeric (read-only), amount_confirmed numeric (read-only), amount_recovered numeric (read-only), precision_pct numeric (read-only), alerts_per_finding numeric (read-only), median_resolution_hours numeric (read-only), computed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Narratives (finance-narratives) | /api/v1/finance-narratives · /api/accounting/finance-narratives · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), narrative_type text, period_code text, subject_type text, subject_id uuid, subject_ref text, title text, generated_text text, final_text text, source_figures jsonb, model text, model_version text, status text (read-only), edited_by uuid, approved_by uuid (read-only), approved_at timestamp with time zone (read-only), edit_distance_pct numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Risk Cases (risk-cases) | /api/v1/risk-cases · /api/accounting/risk-cases · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), case_no text (read-only), title* text, domain text, case_type text, severity text, priority integer, amount_at_risk numeric, currency text, subject_type text, subject_id uuid, supplier_id uuid, account_id uuid, employee_id uuid, assigned_to uuid, assigned_at timestamp with time zone (read-only), due_date date, status text (read-only), outcome text, outcome_notes text, recovered_amount numeric, loss_amount numeric, remediation text, deficiency_id uuid, reported_externally boolean, reported_to text, opened_at timestamp with time zone (read-only), resolved_at timestamp with time zone (read-only), closed_at timestamp with time zone (read-only), closed_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Risk Detectors (risk-detectors) | /api/v1/risk-detectors · /api/accounting/risk-detectors · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, domain text, technique text, execution text, runs_before_posting boolean, action text, severity_default text, signal_threshold numeric, case_threshold numeric, amount_threshold numeric, parameters jsonb, rationale text, typical_cause text, suggested_action text, signals_raised integer (read-only), true_positives integer (read-only), false_positives integer (read-only), precision_pct numeric (read-only), is_enabled boolean, is_system boolean (read-only), last_run_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Risk Signals (risk-signals) | /api/v1/risk-signals · /api/accounting/risk-signals · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), detector_id uuid (read-only), detector_code text (read-only), signal_no text (read-only), detected_at timestamp with time zone (read-only), subject_type text (read-only), subject_id uuid (read-only), document_type text (read-only), document_id uuid (read-only), document_no text (read-only), document_date date (read-only), amount numeric (read-only), currency text (read-only), supplier_id uuid (read-only), account_id uuid (read-only), employee_id uuid (read-only), user_id uuid (read-only), score numeric (read-only), severity text (read-only), title text (read-only), explanation text (read-only), evidence jsonb (read-only), observed_value numeric (read-only), expected_value numeric (read-only), deviation_sigma numeric (read-only), related jsonb (read-only), suggested_action text (read-only), action_taken text (read-only), blocked_posting boolean (read-only), status text, case_id uuid (read-only), fingerprint text (read-only), occurrence_count integer (read-only), last_seen_at timestamp with time zone (read-only), model_version text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Financial Close
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Close Checklist (close-template-tasks) | /api/v1/close-template-tasks · /api/accounting/close-template-tasks · /{id} | list, get, create, change, delete | id uuid (read-only), template_id* uuid, seq_no* integer, code* text, name* text, phase text, module text, task_type text, action_key text, action_params jsonb, owner_role text, reviewer_role text, due_day integer, estimated_minutes integer, is_mandatory boolean, is_blocking boolean, requires_evidence boolean, requires_approval boolean, instructions text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Close Checks (close-checks) | /api/v1/close-checks · /api/accounting/close-checks · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_id* uuid, task_id uuid, check_no integer, name* text, check_type text, gl_account_id uuid, gl_balance numeric, subledger_balance numeric, difference numeric (read-only), tolerance numeric, prior_balance numeric, variance_pct numeric, status text (read-only), explanation text, evidence_url text, checked_by uuid (read-only), checked_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Close Tasks (close-tasks) | /api/v1/close-tasks · /api/accounting/close-tasks · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_id uuid (read-only), template_task_id uuid (read-only), seq_no integer (read-only), code text (read-only), name text (read-only), phase text (read-only), module text (read-only), task_type text (read-only), action_key text (read-only), action_params jsonb (read-only), owner_id uuid, reviewer_id uuid, due_date date, status text (read-only), is_mandatory boolean (read-only), is_blocking boolean (read-only), requires_evidence boolean (read-only), requires_approval boolean (read-only), started_at timestamp with time zone (read-only), completed_at timestamp with time zone (read-only), completed_by uuid (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), result jsonb (read-only), result_amount numeric (read-only), journal_id uuid (read-only), error_message text (read-only), skip_reason text (read-only), duration_minutes integer (read-only), instructions text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Close Templates (close-templates) | /api/v1/close-templates · /api/accounting/close-templates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, close_type text, ledger_id uuid, target_working_days integer, description text, is_active boolean, is_system boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Currency Revaluation (fx-revaluation-runs) | /api/v1/fx-revaluation-runs · /api/accounting/fx-revaluation-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), period_code* text, valuation_date* date, ledger_id uuid, functional_currency text, rate_type text, method text, is_test_run boolean, status text (read-only), account_count integer (read-only), unrealised_gain numeric (read-only), unrealised_loss numeric (read-only), net_adjustment numeric (read-only), journal_id uuid (read-only), reversal_journal_id uuid (read-only), close_run_id uuid, exceptions jsonb (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Financial Closes (close-runs) | /api/v1/close-runs · /api/accounting/close-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), name text, template_id uuid, ledger_id uuid, period_code* text, period_from* date, period_to* date, close_type text, current_phase text (read-only), status text (read-only), target_date date, started_at timestamp with time zone (read-only), closed_at timestamp with time zone (read-only), closed_by uuid (read-only), reopen_count integer (read-only), reopen_reason text (read-only), reopened_by uuid (read-only), reopened_at timestamp with time zone (read-only), task_count integer (read-only), completed_count integer (read-only), blocked_count integer (read-only), overdue_count integer (read-only), owner_id uuid, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Recurring Entries & Accruals (recurring-entries) | /api/v1/recurring-entries · /api/accounting/recurring-entries · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, entry_type text, ledger_id uuid, auto_reverse boolean, reverse_on text, frequency text, amount numeric, currency text, total_amount numeric, periods_total integer, periods_run integer (read-only), amount_expression text, start_period text, end_period text, next_period text, cost_center_id uuid, memo_template text, status text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Financial Controls
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Account Reconciliations (account-reconciliations) | /api/v1/account-reconciliations · /api/accounting/account-reconciliations · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), recon_no text (read-only), gl_account_id* uuid, policy_id uuid, close_run_id uuid, period_code* text, as_of_date* date, currency text, gl_balance numeric, supporting_balance numeric, difference numeric (read-only), explained_amount numeric, unexplained_amount numeric, oldest_item_days integer, status text (read-only), prepared_by uuid (read-only), prepared_at timestamp with time zone (read-only), reviewed_by uuid (read-only), reviewed_at timestamp with time zone (read-only), due_date date, evidence_url text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Certifications (certifications) | /api/v1/certifications · /api/accounting/certifications · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), certification_no text (read-only), close_run_id uuid, period_code* text, scope text, scope_ref text, certification_type text, statement text, certifier_id uuid, certifier_title text, has_exceptions boolean (read-only), exceptions_noted text (read-only), status text (read-only), signed_at timestamp with time zone (read-only), signature_hash text (read-only), signed_ip text (read-only), due_date date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Control Frameworks (control-frameworks) | /api/v1/control-frameworks · /api/accounting/control-frameworks · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, authority text, version text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Control Register (financial-controls) | /api/v1/financial-controls · /api/accounting/financial-controls · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), control_no text (read-only), name* text, framework_id uuid, framework_ref text, process text, control_type text, nature text, frequency text, is_key boolean, risk_addressed text, assertion text, owner_employee_id uuid, performer_employee_id uuid, reviewer_employee_id uuid, owner_role text, module text, resource text, system_rule text, enforced_by text, design_description text, operation_description text, evidence_required text, effectiveness text, last_tested_at date, next_test_due date, status text (read-only), is_system boolean (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Control Tests (control-tests) | /api/v1/control-tests · /api/accounting/control-tests · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), control_id* uuid, test_no text (read-only), period_code text, test_date date, test_type text, tester_id uuid, is_independent boolean, population_size integer, sample_size integer, sample_method text, exceptions_found integer, result text (read-only), conclusion text, evidence_url text, reviewed_by uuid, reviewed_at timestamp with time zone (read-only), completed_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Deficiencies (control-deficiencies) | /api/v1/control-deficiencies · /api/accounting/control-deficiencies · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), deficiency_no text (read-only), control_id uuid, test_id uuid, title* text, severity text, source text, identified_at date, description text, root_cause text, potential_impact text, impact_amount numeric, remediation_plan text, owner_employee_id uuid, target_date date, compensating_control_id uuid, status text (read-only), remediated_at date, validated_by uuid, validated_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Journal Approval Rules (journal-approval-rules) | /api/v1/journal-approval-rules · /api/accounting/journal-approval-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, priority integer, journal_type text, source_module text, ledger_id uuid, account_pattern text, amount_threshold numeric, applies_to_manual_only boolean, applies_to_reversals boolean, applies_to_backdated boolean, applies_to_period_end boolean, backdated_days integer, approver_role text, approver_employee_id uuid, approvals_required integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Journal Approvals (journal-approvals) | /api/v1/journal-approvals · /api/accounting/journal-approvals · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), journal_id uuid, proposed_entry jsonb, rule_id uuid, requested_by uuid (read-only), requested_at timestamp with time zone (read-only), amount numeric, reason text, supporting_url text, status text (read-only), approvals_required integer (read-only), approvals_given integer (read-only), decided_at timestamp with time zone (read-only), posted_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Reconciliation Policies (reconciliation-policies) | /api/v1/reconciliation-policies · /api/accounting/reconciliation-policies · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), gl_account_id* uuid, frequency text, source text, risk_rating text, materiality numeric, tolerance numeric, preparer_employee_id uuid, reviewer_employee_id uuid, due_days integer, requires_review boolean, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Reconciling Items (reconciliation-items) | /api/v1/reconciliation-items · /api/accounting/reconciliation-items · /{id} | list, get, create, change, delete | id uuid (read-only), reconciliation_id* uuid, line_no integer, item_type text, description text, amount numeric, item_date date, age_days integer, document_ref text, owner_id uuid, action text, target_date date, is_resolved boolean, resolved_at timestamp with time zone (read-only), journal_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Fund Accounting
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Budget Transfers (budget-transfers) | /api/v1/budget-transfers · /api/accounting/budget-transfers · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), transfer_no text, kind text, transfer_date date, from_budget_line_id uuid, to_budget_line_id uuid, amount* numeric, reason* text, reference text, status text (read-only), from_before numeric (read-only), from_after numeric (read-only), to_before numeric (read-only), to_after numeric (read-only), submitted_by uuid (read-only), submitted_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Derivation Lookup Rows (derivation-lookup-rows) | /api/v1/derivation-lookup-rows · /api/accounting/derivation-lookup-rows · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), lookup_id* uuid, key_1* text, key_2 text, key_3 text, value_code* text, valid_from date, valid_to date, sort_order integer, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Derivation Lookup Tables (derivation-lookups) | /api/v1/derivation-lookups · /api/accounting/derivation-lookups · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, target* text, key_fields* _text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Derivation Rule Sets (derivation-rule-sets) | /api/v1/derivation-rule-sets · /api/accounting/derivation-rule-sets · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, target* text, strategy text, document_types _text, apply_on_save boolean, apply_on_post boolean, sequence_no integer, valid_from date, valid_to date, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Derived Postings (gl-derivation-audit) | /api/v1/gl-derivation-audit · /api/accounting/gl-derivation-audit · /{id} | list, get, create, change, delete | id uuid (read-only), journal_id uuid (read-only), line_no integer (read-only), account_id uuid (read-only), cost_center_id uuid (read-only), description text (read-only), debit numeric (read-only), credit numeric (read-only), profit_center_id uuid (read-only), currency text (read-only), debit_txn numeric (read-only), credit_txn numeric (read-only), partner_org_id uuid (read-only), exchange_rate numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), fund_id uuid (read-only), grant_id uuid (read-only), program_id uuid (read-only), function_id uuid (read-only), derivation_trace jsonb (read-only) |
| Fund Accounting Settings (gl-dimension-settings) | /api/v1/gl-dimension-settings · /api/accounting/gl-dimension-settings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), fund_required boolean, derivation_enabled boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Fund Derivation Rules (derivation-rules) | /api/v1/derivation-rules · /api/accounting/derivation-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), rule_set_id* uuid, code* text, name* text, priority integer, conditions jsonb, condition_expr text, document_types _text, valid_from date, valid_to date, action text, value_code text, copy_field text, lookup_id uuid, expression text, mode text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Funds (funds) | /api/v1/funds · /api/accounting/funds · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, fund_type text, fund_category text (read-only), balance_class text, is_major boolean, restriction text, valid_from date, valid_to date, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Grant Claims (grant-claims) | /api/v1/grant-claims · /api/accounting/grant-claims · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), claim_no text, grant_id* uuid, customer_account_id* uuid, claim_date date, period_from* date, period_to* date, amount numeric, revenue_account_no text, expended_to_date numeric (read-only), claimed_before numeric (read-only), status text (read-only), ar_invoice_id uuid (read-only), notes text, submitted_by uuid (read-only), submitted_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Grants (grant-awards) | /api/v1/grant-awards · /api/accounting/grant-awards · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, grantor* text, grantor_type text, pass_through_entity text, aln text, award_no text, award_amount numeric, currency text, period_from* date, period_to* date, fund_id* uuid, funding_source_id uuid, match_required_pct numeric, indirect_rate_pct numeric, status text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Programs & Functions (gl-programs) | /api/v1/gl-programs · /api/accounting/gl-programs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), kind text, code* text, name* text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
General Ledger
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Chart of Accounts (gl-accounts) | /api/v1/gl-accounts · /api/accounting/gl-accounts · /{id} | list, get, create, change, delete | id uuid (read-only), account_no* text, name* text, account_type* text, is_postable boolean, is_active boolean, org_unit_id uuid (read-only), is_monetary boolean (read-only), is_intercompany boolean (read-only), group_account_code text (read-only), cash_flow_category text (read-only), translation_rate_type text (read-only), requires_partner boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), posting_role text |
| Fiscal Periods (fiscal-periods) | /api/v1/fiscal-periods · /api/accounting/fiscal-periods · /{id} | list, get, create, change, delete | id uuid (read-only), period_code* text, start_date* date, end_date* date, status text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), soft_closed_at timestamp with time zone (read-only), soft_closed_by uuid (read-only), fiscal_year_id uuid, period_no integer, quarter_no integer, is_special boolean |
| Fiscal Year Variants (fiscal-year-variants) | /api/v1/fiscal-year-variants · /api/accounting/fiscal-year-variants · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, kind text, start_month integer, week_anchor_day integer, anchor_rule text, special_periods integer, is_default boolean, origin text (read-only), description text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Fiscal Years (fiscal-years) | /api/v1/fiscal-years · /api/accounting/fiscal-years · /{id} | list, get | id uuid (read-only), variant_id uuid (read-only), year_code integer (read-only), start_date date (read-only), end_date date (read-only), origin text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Journals (journals) | /api/v1/journals · /api/accounting/journals · /{id} | list, get | id uuid (read-only), journal_no text (read-only), journal_date date (read-only), journal_type text (read-only), source_module text (read-only), source_ref text (read-only), memo text (read-only), status text (read-only), total_debit numeric (read-only), total_credit numeric (read-only), posted_by uuid (read-only), org_unit_id uuid (read-only), cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), is_reversal boolean (read-only), ledger_id uuid (read-only), currency text (read-only), exchange_rate numeric (read-only), valuation_run_id uuid (read-only), is_intercompany boolean (read-only), partner_org_id uuid (read-only), elimination_group_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Intercompany
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Intercompany Reconciliation (ic-reconciliations) | /api/v1/ic-reconciliations · /api/accounting/ic-reconciliations · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), recon_no text (read-only), period_code* text, org_a_id* uuid, org_b_id* uuid, currency text, balance_a numeric, balance_b numeric, difference numeric (read-only), tolerance numeric, status text (read-only), agreed_at timestamp with time zone (read-only), agreed_by uuid (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Intercompany Relationships (ic-relationships) | /api/v1/ic-relationships · /api/accounting/ic-relationships · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), from_org_id* uuid, to_org_id* uuid, relationship text, pricing_method text, markup_pct numeric, currency text, payment_terms_days integer, ar_account_id uuid, ap_account_id uuid, auto_mirror boolean, netting_group text, agreement_ref text, valid_from date, valid_to date, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Intercompany Transactions (ic-transactions) | /api/v1/ic-transactions · /api/accounting/ic-transactions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), ic_no text (read-only), relationship_id uuid, from_org_id* uuid, to_org_id* uuid, txn_date date, period_code text, txn_type text, description text, currency text, amount* numeric, tax_amount numeric, transfer_cost numeric, markup_amount numeric (read-only), from_journal_id uuid (read-only), to_journal_id uuid (read-only), from_invoice_id uuid (read-only), to_invoice_id uuid (read-only), status text (read-only), matched_at timestamp with time zone (read-only), dispute_reason text, source_module text, source_ref text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Landed Cost
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Landed Cost Charge Types (landed-cost-charge-types) | /api/v1/landed-cost-charge-types · /api/accounting/landed-cost-charge-types · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, charge_kind text, default_method text, clearing_account_no text, accrual_account_no text, is_inventoriable boolean, expense_account_no text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Landed Cost Templates (landed-cost-templates) | /api/v1/landed-cost-templates · /api/accounting/landed-cost-templates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), template_no text (read-only), name* text, supplier_id uuid, item_id uuid, charge_type_id* uuid, basis text, rate* numeric, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Landed Cost Vouchers (landed-cost-vouchers) | /api/v1/landed-cost-vouchers · /api/accounting/landed-cost-vouchers · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), voucher_no text (read-only), voucher_date date, voucher_kind text, estimate_voucher_id uuid, supplier_id uuid, carrier_id uuid, currency text, status text (read-only), total_charges numeric (read-only), to_inventory numeric (read-only), to_cogs numeric (read-only), to_expense numeric (read-only), accrual_released numeric (read-only), journal_id uuid (read-only), reversal_journal_id uuid (read-only), posted_at timestamp with time zone (read-only), posted_by uuid (read-only), reversed_at timestamp with time zone (read-only), reversal_reason text (read-only), notes text, estimated_receipt_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Lease Accounting
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Lease Charges (lease-charges) | /api/v1/lease-charges · /api/accounting/lease-charges · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), lease_id* uuid, line_no integer, charge_type text, name* text, basis text, amount numeric, rate_pct numeric, frequency text, currency text, gl_account_id uuid, tax_code text, is_advance_on_budget boolean, budget_amount numeric, actual_amount numeric, valid_from date, valid_to date, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Lease Components (lease-components) | /api/v1/lease-components · /api/accounting/lease-components · /{id} | list, get, create, change, delete | id uuid (read-only), lease_id* uuid, line_no integer, name* text, component_type text, rental_unit_id uuid, asset_id uuid, quantity numeric, standalone_price numeric, allocated_amount numeric, allocation_pct numeric, is_separated boolean, useful_life_months integer, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Lease Events (lease-events) | /api/v1/lease-events · /api/accounting/lease-events · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), lease_id* uuid, event_no text (read-only), event_type* text, event_date date, effective_date date, description text, reason text, old_term_months integer, new_term_months integer, old_payment numeric, new_payment numeric, old_rate_pct numeric, new_rate_pct numeric, old_liability numeric (read-only), new_liability numeric (read-only), liability_adjustment numeric (read-only), rou_adjustment numeric (read-only), gain_loss numeric (read-only), new_version integer (read-only), journal_id uuid (read-only), status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Lease Runs (lease-runs) | /api/v1/lease-runs · /api/accounting/lease-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), period_code* text, ledger_id uuid, is_test_run boolean, status text (read-only), lease_count integer (read-only), total_interest numeric (read-only), total_depreciation numeric (read-only), total_payments numeric (read-only), closing_liability numeric (read-only), journal_id uuid (read-only), exceptions jsonb (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Lease Schedule (lease-schedule) | /api/v1/lease-schedule · /api/accounting/lease-schedule · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), lease_id uuid (read-only), ledger_id uuid (read-only), version integer (read-only), period_no integer (read-only), period_code text (read-only), period_date date (read-only), due_date date (read-only), opening_liability numeric (read-only), payment numeric (read-only), interest numeric (read-only), principal numeric (read-only), closing_liability numeric (read-only), opening_rou numeric (read-only), depreciation numeric (read-only), closing_rou numeric (read-only), straight_line_expense numeric (read-only), variable_payment numeric (read-only), is_posted boolean (read-only), is_paid boolean (read-only), journal_id uuid (read-only), ap_invoice_id uuid (read-only), ar_invoice_id uuid (read-only), run_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Leases (leases) | /api/v1/leases · /api/accounting/leases · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), lease_no text (read-only), name* text, role text, lease_type text, classification text, transfers_ownership boolean, purchase_option_reasonably_certain boolean, term_major_part_of_life boolean, pv_substantially_all_fair_value boolean, specialised_asset boolean, is_short_term boolean, is_low_value boolean, counterparty_supplier_id uuid, counterparty_account_id uuid, counterparty_org_id uuid, counterparty_name text, property_id uuid, rental_unit_id uuid, asset_id uuid, head_lease_id uuid, signature_date date, commencement_date date, end_date date, term_months integer, renewal_option_months integer, renewal_reasonably_certain boolean, termination_option_date date, termination_penalty numeric, notice_period_days integer, currency text, payment_amount numeric, payment_frequency text, payment_timing text, first_payment_date date, escalation_type text, escalation_pct numeric, escalation_amount numeric, escalation_months integer, index_name text, index_base_value numeric, variable_payment_basis text, discount_rate_pct numeric, rate_basis text, initial_direct_costs numeric, lease_incentives numeric, prepaid_amount numeric, restoration_provision numeric, security_deposit numeric, residual_guarantee numeric, purchase_option_price numeric, initial_liability numeric (read-only), initial_rou_asset numeric (read-only), total_payments numeric (read-only), total_interest numeric (read-only), principle_id uuid, ledger_id uuid, rou_asset_account_id uuid, liability_account_id uuid, interest_account_id uuid, depreciation_account_id uuid, rent_expense_account_id uuid, cost_center_id uuid, status text (read-only), version integer (read-only), contract_ref text, document_url text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Ledgers & Principles
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Accounting Principles (accounting-principles) | /api/v1/accounting-principles · /api/accounting/accounting-principles · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, framework text, jurisdiction text, description text, lease_standard text, revenue_standard text, inventory_method text, allows_revaluation boolean, capitalises_development boolean, functional_currency_rule text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Currencies (currencies) | /api/v1/currencies · /api/accounting/currencies · /{code} | list, get, create, change, delete | code* text, name* text, symbol text, decimals integer, quote_per integer, is_active boolean, sort_order integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Exchange Rates (exchange-rates) | /api/v1/exchange-rates · /api/accounting/exchange-rates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), from_currency* text, to_currency* text, rate_type text, valid_from* date, rate* numeric, source text, source_ref text, entered_by uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Ledger Assignments (ledger-assignments) | /api/v1/ledger-assignments · /api/accounting/ledger-assignments · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), ledger_id* uuid, company_id* uuid, functional_currency text, is_active boolean, valid_from date, valid_to date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Ledgers (ledgers) | /api/v1/ledgers · /api/accounting/ledgers · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, principle_id* uuid, ledger_type text, base_ledger_id uuid, currency text, fiscal_year_start_month integer, auto_post boolean, is_consolidation_source boolean, status text, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), adjustment_only boolean (read-only) |
Payables & Receivables
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| AP Credit / Debit Memos (ap-memos) | /api/v1/ap-memos · /api/accounting/ap-memos · /{id} | list, get | id uuid (read-only), invoice_no text (read-only), supplier_invoice_no text (read-only), supplier_id uuid (read-only), po_id uuid (read-only), invoice_date date (read-only), due_date date (read-only), currency text (read-only), subtotal numeric (read-only), tax numeric (read-only), total numeric (read-only), status text (read-only), match_result jsonb (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), document_type text (read-only), related_invoice_id uuid (read-only), memo_reason text (read-only), cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), supplier_name text (read-only), related_invoice_no text (read-only), cost_center_code text (read-only) |
| AP Invoices (ap-invoices) | /api/v1/ap-invoices · /api/accounting/ap-invoices · /{id} | list, get, create, change, delete | id uuid (read-only), invoice_no text (read-only), supplier_invoice_no* text, supplier_id* uuid, po_id uuid, invoice_date* date, due_date* date, currency text (read-only), subtotal numeric, tax numeric, total numeric, status text, match_result jsonb (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), document_type text (read-only), related_invoice_id uuid (read-only), memo_reason text, cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), exchange_rate numeric (read-only), base_total numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), supplier_gstin text (read-only), buyer_gstin text (read-only), place_of_supply text (read-only), is_interstate boolean (read-only), is_reverse_charge boolean (read-only), itc_eligibility text (read-only), cgst_total numeric (read-only), sgst_total numeric (read-only), igst_total numeric (read-only), cess_total numeric (read-only), edi_interchange_id uuid (read-only), submitted_via text (read-only), portal_user_id uuid (read-only), receipt_id uuid (read-only), project_id uuid (read-only) |
| AR Credit / Debit Memos (ar-memos) | /api/v1/ar-memos · /api/accounting/ar-memos · /{id} | list, get | id uuid (read-only), invoice_no text (read-only), customer_account_id uuid (read-only), patient_id uuid (read-only), source_module text (read-only), source_ref text (read-only), invoice_date date (read-only), due_date date (read-only), currency text (read-only), subtotal numeric (read-only), tax numeric (read-only), total numeric (read-only), amount_paid numeric (read-only), status text (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), document_type text (read-only), related_invoice_id uuid (read-only), memo_reason text (read-only), cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), customer_name text (read-only), related_invoice_no text (read-only), cost_center_code text (read-only) |
| AR Invoices (ar-invoices) | /api/v1/ar-invoices · /api/accounting/ar-invoices · /{id} | list, get, create, change, delete | id uuid (read-only), invoice_no text (read-only), customer_account_id uuid, patient_id uuid (read-only), source_module text (read-only), source_ref text (read-only), invoice_date* date, due_date* date, currency text (read-only), subtotal numeric, tax numeric, total numeric, amount_paid numeric (read-only), status text, journal_id uuid (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), document_type text (read-only), related_invoice_id uuid (read-only), memo_reason text, cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), exchange_rate numeric (read-only), base_total numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), invoice_subtype text, issued_at timestamp with time zone (read-only), supply_date date, supply_end_date date, seller_snapshot jsonb (read-only), buyer_snapshot jsonb (read-only), zatca_qr text (read-only), vat_total_sar numeric (read-only), zatca_regime text (read-only), issued_backfilled boolean (read-only), zatca_uuid uuid (read-only), invoice_hash text (read-only), previous_invoice_hash text (read-only), icv bigint (read-only), subtype_changed_by uuid (read-only), subtype_changed_at timestamp with time zone (read-only), backfill_repaired_at timestamp with time zone (read-only), backfill_repair jsonb (read-only), supplier_gstin text (read-only), buyer_gstin text (read-only), supply_state_code text (read-only), place_of_supply text (read-only), is_interstate boolean (read-only), is_reverse_charge boolean (read-only), is_export boolean (read-only), export_type text (read-only), shipping_bill_no text (read-only), cgst_total numeric (read-only), sgst_total numeric (read-only), igst_total numeric (read-only), cess_total numeric (read-only), round_off numeric (read-only), duplicate_reason text (read-only), duplicate_of _text (read-only), duplicate_confirmed_by uuid (read-only), duplicate_confirmed_at timestamp with time zone (read-only), egs_unit_id uuid (read-only), zatca_invoice_type_code text (read-only), zatca_transaction_code text (read-only), zatca_status text (read-only), signed_xml text (read-only), zatca_signed_at timestamp with time zone (read-only), cleared_xml text (read-only), zatca_response jsonb (read-only), submitted_at timestamp with time zone (read-only), cleared_at timestamp with time zone (read-only), zatca_attempts integer (read-only), zatca_next_attempt_at timestamp with time zone (read-only), zatca_last_error text (read-only), payment_means_code text (read-only), eway_bill_required boolean (read-only), gst_doc_series_id uuid (read-only), gst_financial_year text (read-only), draft_invoice_no text (read-only), irn text (read-only), irn_ack_no text (read-only), irn_ack_date timestamp with time zone (read-only), irn_signed_qr text (read-only), irn_status text (read-only), zatca_replaced_by_id uuid (read-only), receivable_account_no text (read-only) |
| Customer Receipts (ar-receipts) | /api/v1/ar-receipts · /api/accounting/ar-receipts · /{id} | list, get | id uuid (read-only), receipt_no text (read-only), ar_invoice_id uuid (read-only), receipt_date date (read-only), amount numeric (read-only), method text (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), currency text (read-only), exchange_rate numeric (read-only), base_amount numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Supplier Payments (ap-payments) | /api/v1/ap-payments · /api/accounting/ap-payments · /{id} | list, get | id uuid (read-only), payment_no text (read-only), ap_invoice_id uuid (read-only), payment_date date (read-only), amount numeric (read-only), method text (read-only), bank_account_id uuid (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), currency text (read-only), exchange_rate numeric (read-only), base_amount numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), voids_payment_id uuid (read-only), void_reason text (read-only) |
Permits & Licensing
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Permit Applications (permit-applications) | /api/v1/permit-applications · /api/accounting/permit-applications · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), application_no text (read-only), permit_type_id uuid (read-only), renewal_of_id uuid (read-only), channel text (read-only), status text (read-only), applicant_name text (read-only), applicant_email text (read-only), applicant_phone text (read-only), address text (read-only), parcel_no text (read-only), description text (read-only), quantity numeric (read-only), fee_amount numeric (read-only), fee_paid_at timestamp with time zone (read-only), payment_ref text (read-only), reviewer_id uuid (read-only), decision_note text (read-only), decided_at timestamp with time zone (read-only), submitted_at timestamp with time zone (read-only), source_ip text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Permit Conditions (permit-conditions) | /api/v1/permit-conditions · /api/accounting/permit-conditions · /{id} | list, get, create, change, delete | id uuid (read-only), permit_id* uuid, line_no* integer, condition_text* text, status text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Permit Inspections (permit-inspections) | /api/v1/permit-inspections · /api/accounting/permit-inspections · /{id} | list, get | id uuid (read-only), application_id uuid (read-only), scheduled_for date (read-only), inspector_id uuid (read-only), result text (read-only), findings text (read-only), completed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Permit Types (permit-types) | /api/v1/permit-types · /api/accounting/permit-types · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, category text, base_fee numeric, fee_per_unit numeric, unit_label text, renewal_fee numeric, validity_months integer, renewable boolean, renewal_window_days integer, requires_inspection boolean, public_intake boolean, required_documents _text, standard_conditions text, revenue_account_no text, description text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Permits & Licences (permits) | /api/v1/permits · /api/accounting/permits · /{id} | list, get | id uuid (read-only), permit_no text (read-only), application_id uuid (read-only), permit_type_id uuid (read-only), holder_name text (read-only), holder_email text (read-only), address text (read-only), parcel_no text (read-only), issued_on date (read-only), valid_from date (read-only), expires_on date (read-only), status text (read-only), status_note text (read-only), renewed_by_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Product Costing
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Activity Postings (activity-postings) | /api/v1/activity-postings · /api/accounting/activity-postings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), posting_date date, period_code text, cost_center_id* uuid, activity_type_id* uuid, receiver_type text, receiver_id uuid, receiver_ref text, quantity numeric, rate numeric, amount numeric, fixed_amount numeric, variable_amount numeric, currency text, employee_id uuid, work_center_id uuid, is_revaluation boolean (read-only), run_id uuid (read-only), source_module text, source_ref text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Activity Rates (activity-rates) | /api/v1/activity-rates · /api/accounting/activity-rates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), cost_center_id* uuid, activity_type_id* uuid, fiscal_year* integer, period_code text, version text, fixed_rate numeric, variable_rate numeric, total_rate numeric (read-only), currency text, capacity_quantity numeric, planned_quantity numeric, actual_quantity numeric, planned_cost numeric, actual_cost numeric, valid_from date, valid_to date, is_locked boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Activity Types (activity-types) | /api/v1/activity-types · /api/accounting/activity-types · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, unit text, category text, cost_element_id uuid, component_code text, allowed_receivers _text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cost Components (cost-components) | /api/v1/cost-components · /api/accounting/cost-components · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, sequence_no integer, is_inventoriable boolean, is_cogs boolean, splits_fixed_variable boolean, color text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cost Elements (cost-elements) | /api/v1/cost-elements · /api/accounting/cost-elements · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, element_type text, category text, gl_account_id uuid, component_code text, is_fixed boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cost Estimates (cost-estimates) | /api/v1/cost-estimates · /api/accounting/cost-estimates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), estimate_no text (read-only), item_id* uuid, bom_id uuid, routing_id uuid, costing_variant_id uuid, estimate_type text, lot_size numeric, uom text, currency text, costing_date date, valid_from date, valid_to date, fiscal_year integer, period_code text, total_cost numeric (read-only), unit_cost numeric (read-only), fixed_cost numeric (read-only), variable_cost numeric (read-only), material_cost numeric (read-only), labor_cost numeric (read-only), machine_cost numeric (read-only), overhead_cost numeric (read-only), status text (read-only), released_at timestamp with time zone (read-only), released_by uuid (read-only), supersedes_id uuid (read-only), previous_unit_cost numeric (read-only), revaluation_amount numeric (read-only), revaluation_journal_id uuid (read-only), run_id uuid (read-only), exceptions jsonb (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cost Itemisation (cost-estimate-lines) | /api/v1/cost-estimate-lines · /api/accounting/cost-estimate-lines · /{id} | list, get, create, change, delete | id uuid (read-only), estimate_id uuid (read-only), line_no integer (read-only), level_no integer (read-only), parent_line_no integer (read-only), line_type text (read-only), component_code text (read-only), cost_element_id uuid (read-only), item_id uuid (read-only), activity_type_id uuid (read-only), cost_center_id uuid (read-only), work_center_id uuid (read-only), operation_no integer (read-only), description text (read-only), quantity numeric (read-only), uom text (read-only), price numeric (read-only), price_source text (read-only), scrap_pct numeric (read-only), gross_quantity numeric (read-only), fixed_cost numeric (read-only), variable_cost numeric (read-only), total_cost numeric (read-only), currency text (read-only), source_estimate_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Costing Runs (costing-runs) | /api/v1/costing-runs · /api/accounting/costing-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), name text, costing_variant_id uuid, costing_date date, valid_from date, fiscal_year integer, stage text (read-only), item_selection jsonb, status text (read-only), item_count integer (read-only), costed_count integer (read-only), error_count integer (read-only), total_revaluation numeric (read-only), journal_id uuid (read-only), exceptions jsonb (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), marked_at timestamp with time zone (read-only), marked_by uuid (read-only), released_at timestamp with time zone (read-only), released_by uuid (read-only) |
| Costing Variants (costing-variants) | /api/v1/costing-variants · /api/accounting/costing-variants · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, material_price_source text, activity_price_source text, explode_subassemblies boolean, use_existing_estimate boolean, include_scrap boolean, include_setup boolean, include_overhead boolean, overhead_key text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Material Ledger (material-ledger) | /api/v1/material-ledger · /api/accounting/material-ledger · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), item_id uuid (read-only), warehouse_id uuid (read-only), period_code text (read-only), currency text (read-only), valuation_class text (read-only), opening_quantity numeric (read-only), opening_value numeric (read-only), receipts_quantity numeric (read-only), receipts_value numeric (read-only), issues_quantity numeric (read-only), issues_value numeric (read-only), closing_quantity numeric (read-only), closing_value numeric (read-only), standard_price numeric (read-only), price_difference numeric (read-only), exchange_difference numeric (read-only), production_variance numeric (read-only), periodic_unit_price numeric (read-only), consumed_difference numeric (read-only), stock_difference numeric (read-only), status text (read-only), run_id uuid (read-only), journal_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Overhead Rules (overhead-rules) | /api/v1/overhead-rules · /api/accounting/overhead-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, costing_variant_id uuid, base_component text, base_element_category text, method text, rate_pct numeric, amount_per_unit numeric, credit_cost_center_id uuid, credit_element_id uuid, target_component text, item_group text, plant text, valid_from date, valid_to date, sequence_no integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Variance Analysis (cost-variances) | /api/v1/cost-variances · /api/accounting/cost-variances · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), order_type text (read-only), order_id uuid (read-only), order_ref text (read-only), item_id uuid (read-only), cost_center_id uuid (read-only), period_code text (read-only), variance_type text (read-only), component_code text (read-only), cost_element_id uuid (read-only), target_cost numeric (read-only), actual_cost numeric (read-only), variance_amount numeric (read-only), target_quantity numeric (read-only), actual_quantity numeric (read-only), target_price numeric (read-only), actual_price numeric (read-only), currency text (read-only), is_favourable boolean (read-only), explanation text (read-only), journal_id uuid (read-only), run_id uuid (read-only), calculated_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Profitability
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Margin Levels (pa-margin-levels) | /api/v1/pa-margin-levels · /api/accounting/pa-margin-levels · /{id} | list, get, create, change, delete | id uuid (read-only), scheme_id* uuid, level_no* integer, name* text, value_fields _text, is_subtotal boolean, sort_order integer, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Margin Schemes (pa-margin-schemes) | /api/v1/pa-margin-schemes · /api/accounting/pa-margin-schemes · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, is_default boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Profitability Characteristics (pa-characteristics) | /api/v1/pa-characteristics · /api/accounting/pa-characteristics · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, data_type text, source_type text, source_field text, reference_table text, is_dimension boolean, is_mandatory boolean, sort_order integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Profitability Derivation Rules (pa-derivation-rules) | /api/v1/pa-derivation-rules · /api/accounting/pa-derivation-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, priority integer, characteristic_id* uuid, source_characteristic_id uuid, match_value text, match_pattern text, item_group text, account_type text, country text, derived_value text, derivation text, lookup_table text, lookup_field text, expression text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Profitability Lines (pa-line-items) | /api/v1/pa-line-items · /api/accounting/pa-line-items · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), segment_id uuid (read-only), posting_date date (read-only), period_code text (read-only), fiscal_year integer (read-only), version text (read-only), record_type text (read-only), value_field_id uuid (read-only), value_field text (read-only), amount numeric (read-only), quantity numeric (read-only), uom text (read-only), currency text (read-only), source_module text (read-only), source_type text (read-only), source_id uuid (read-only), source_ref text (read-only), journal_id uuid (read-only), allocation_run_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Profitability Segments (pa-segments) | /api/v1/pa-segments · /api/accounting/pa-segments · /{id} | list, get, create, change, delete | id uuid (read-only), segment_key text (read-only), characteristics jsonb (read-only), account_id uuid (read-only), item_id uuid (read-only), profit_center_id uuid (read-only), cost_center_id uuid (read-only), org_unit_id uuid (read-only), sales_employee_id uuid (read-only), region text (read-only), channel text (read-only), product_group text (read-only), customer_group text (read-only), country text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Value Fields (pa-value-fields) | /api/v1/pa-value-fields · /api/accounting/pa-value-fields · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, field_type text, margin_level integer, sign integer, source text, account_pattern text, cost_component text, formula text, unit text, currency_field boolean, sort_order integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Projects & Portfolios
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Activity Dependencies (activity-dependencies) | /api/v1/activity-dependencies · /api/accounting/activity-dependencies · /{id} | list, get, create, change, delete | id uuid (read-only), project_id* uuid, activity_id* uuid, predecessor_id* uuid, dependency_type text, lag_days numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Milestones (project-milestones) | /api/v1/project-milestones · /api/accounting/project-milestones · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id* uuid, wbs_element_id uuid, milestone_no* text, name* text, milestone_type text, planned_date date, forecast_date date, actual_date date, billing_pct numeric, billing_amount numeric, currency text, progress_pct numeric, ar_invoice_id uuid, rev_billing_id uuid, status text (read-only), confirmed_by uuid (read-only), confirmed_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), achieved_at timestamp with time zone (read-only) |
| Network Activities (project-activities) | /api/v1/project-activities · /api/accounting/project-activities · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id* uuid, wbs_element_id uuid, activity_no* text, name* text, activity_type text, work_center_id uuid, cost_center_id uuid, activity_type_id uuid, assigned_employee_id uuid, supplier_id uuid, planned_start date, planned_end date, actual_start date, actual_end date, duration_days numeric, planned_hours numeric, actual_hours numeric, planned_cost numeric, actual_cost numeric, percent_complete numeric, total_float_days numeric (read-only), is_critical boolean (read-only), constraint_type text, constraint_date date, status text, progress_pct numeric, color text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Portfolios (portfolios) | /api/v1/portfolios · /api/accounting/portfolios · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, parent_id uuid, portfolio_type text, owner_employee_id uuid, sponsor_employee_id uuid, currency text, fiscal_year integer, budget_amount numeric, approved_amount numeric, strategic_weight numeric, financial_weight numeric, risk_weight numeric, capacity_weight numeric, status text, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Project Budgets (project-budgets) | /api/v1/project-budgets · /api/accounting/project-budgets · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id* uuid, wbs_element_id uuid, version text, budget_type text, cost_element_id uuid, period_code text, fiscal_year integer, amount numeric, quantity numeric, currency text, change_type text, change_reason text, approved_by uuid (read-only), approved_at timestamp with time zone (read-only), is_released boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Project Costs (project-costs) | /api/v1/project-costs · /api/accounting/project-costs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id* uuid, wbs_element_id uuid, activity_id uuid, posting_date date, period_code text, value_type text, cost_element_id uuid, component_code text, gl_account_id uuid, description text, quantity numeric, uom text, unit_price numeric, amount numeric, currency text, hours numeric, employee_id uuid, supplier_id uuid, item_id uuid, source_module text, source_type text, source_id uuid (read-only), source_ref text, journal_id uuid (read-only), is_billable boolean, is_billed boolean (read-only), ar_invoice_id uuid (read-only), is_settled boolean (read-only), settlement_run_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Project Programs (programs) | /api/v1/programs · /api/accounting/programs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, portfolio_id uuid, parent_id uuid, manager_employee_id uuid, sponsor_employee_id uuid, start_date date, end_date date, currency text, budget_amount numeric, benefit_description text, benefit_amount numeric, benefit_measure text, benefit_realised numeric, benefit_due_date date, status text, health text, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Project Resources (project-resources) | /api/v1/project-resources · /api/accounting/project-resources · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id* uuid, wbs_element_id uuid, activity_id uuid, employee_id uuid, role_name text, skill text, is_named boolean, from_date date, to_date date, allocation_pct numeric, planned_hours numeric, actual_hours numeric, cost_rate numeric, bill_rate numeric, currency text, status text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Projects (projects) | /api/v1/projects · /api/accounting/projects · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_no text (read-only), name* text, program_id uuid, portfolio_id uuid, parent_id uuid, project_type text, cost_object_type text, account_id uuid, opportunity_id uuid, rev_contract_id uuid, manager_employee_id uuid, sponsor_employee_id uuid, cost_center_id uuid, profit_center_id uuid, baseline_start date, baseline_end date, planned_start date, planned_end date, actual_start date, actual_end date, currency text, budget_amount numeric, approved_amount numeric, contract_value numeric, estimate_at_completion numeric, estimate_to_complete numeric, percent_complete numeric, progress_method text, allow_direct_postings boolean, settlement_receiver_type text, settlement_receiver_id uuid, asset_id uuid, status text (read-only), health text, priority text, risk_level text, approved_by uuid (read-only), approved_at timestamp with time zone (read-only), closed_at timestamp with time zone (read-only), description text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), released_at timestamp with time zone (read-only), released_by uuid (read-only), status_reason text (read-only) |
| Risks & Issues (project-risks) | /api/v1/project-risks · /api/accounting/project-risks · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id* uuid, wbs_element_id uuid, risk_no* text, title* text, category text, risk_type text, probability text, impact text, exposure_amount numeric, probability_pct numeric, expected_value numeric (read-only), mitigation text, owner_employee_id uuid, due_date date, status text (read-only), raised_at date, closed_at date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Work Breakdown (wbs-elements) | /api/v1/wbs-elements · /api/accounting/wbs-elements · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), project_id* uuid, parent_id uuid, wbs_code* text, outline_no text, level_no integer, sort_path text (read-only), name* text, element_type text, is_planning_element boolean, is_account_assignment boolean, is_billing_element boolean, cost_center_id uuid, profit_center_id uuid, asset_id uuid, responsible_employee_id uuid, baseline_start date, baseline_end date, planned_start date, planned_end date, actual_start date, actual_end date, planned_hours numeric, actual_hours numeric, currency text, budget_amount numeric, planned_cost numeric, planned_revenue numeric, percent_complete numeric, progress_method text, weight numeric, status text (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), released_at timestamp with time zone (read-only), closed_at timestamp with time zone (read-only) |
Real Estate
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Properties (properties) | /api/v1/properties · /api/accounting/properties · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, parent_id uuid, property_type text, tenure text, address_line1 text, address_line2 text, city text, region text, postal_code text, country text, latitude numeric, longitude numeric, gross_area_sqm numeric, net_lettable_sqm numeric, common_area_sqm numeric, floors integer, units integer, parking_spaces integer, year_built integer, asset_id uuid, cost_center_id uuid, book_value numeric, market_value numeric, valuation_date date, valuer text, currency text, manager_employee_id uuid, status text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Rental Units (rental-units) | /api/v1/rental-units · /api/accounting/rental-units · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), property_id* uuid, code* text, name text, unit_type text, floor_no text, area_sqm numeric, service_charge_share_pct numeric, capacity integer, condition text, asking_rent_per_sqm numeric, currency text, status text, available_from date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Service Charge Settlement (service-charge-settlements) | /api/v1/service-charge-settlements · /api/accounting/service-charge-settlements · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), settlement_no text (read-only), property_id* uuid, period_from* date, period_to* date, period_code text, total_actual_cost numeric, total_budgeted numeric, total_collected numeric (read-only), vacancy_share numeric, landlord_share numeric, recoverable_cost numeric (read-only), balance numeric (read-only), apportionment_basis text, currency text, status text (read-only), issued_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Regulatory Reporting
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| XBRL Concepts (xbrl-concepts) | /api/v1/xbrl-concepts · /api/accounting/xbrl-concepts · /{id} | list, get | id uuid (read-only), taxonomy_id uuid (read-only), name text (read-only), qname text (read-only), label text (read-only), statement text (read-only), period_type text (read-only), balance text (read-only), data_type text (read-only), default_source text (read-only), calc_parent text (read-only), calc_weight smallint (read-only), dimension text (read-only), sort_order integer (read-only), is_total boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| XBRL Filings (xbrl-filings) | /api/v1/xbrl-filings · /api/accounting/xbrl-filings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), filing_no text (read-only), taxonomy_id* uuid, period_from* date, period_to* date, entity_name text, entity_identifier* text, identifier_scheme text, currency text, decimals integer, display_scale integer, shares_outstanding numeric, status text (read-only), fact_count integer (read-only), error_count integer (read-only), warning_count integer (read-only), validation jsonb (read-only), instance_xml text (read-only), ixbrl_html text (read-only), generated_at timestamp with time zone (read-only), generated_by uuid (read-only), filed_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| XBRL Mappings (xbrl-mappings) | /api/v1/xbrl-mappings · /api/accounting/xbrl-mappings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), mapping_no text (read-only), taxonomy_id* uuid, concept_id* uuid, source_kind text, statement_line text, account_no text, account_from text, account_to text, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| XBRL Taxonomies (xbrl-taxonomies) | /api/v1/xbrl-taxonomies · /api/accounting/xbrl-taxonomies · /{id} | list, get | id uuid (read-only), code text (read-only), name text (read-only), framework text (read-only), version text (read-only), prefix text (read-only), namespace text (read-only), entry_point text (read-only), concepts_from text (read-only), default_scheme text (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Revenue Recognition
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Billing Schedule (rev-billings) | /api/v1/rev-billings · /api/accounting/rev-billings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), contract_id* uuid, obligation_id uuid, line_no integer, billing_date date, period_code text, description text, amount numeric, tax_amount numeric, currency text, billing_type text, ar_invoice_id uuid, status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Performance Obligations (rev-obligations) | /api/v1/rev-obligations · /api/accounting/rev-obligations · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), contract_id* uuid, line_no integer, name* text, template_id uuid, item_id uuid, obligation_type text, quantity numeric, contract_price numeric, ssp_unit numeric, ssp_total numeric, ssp_method text, timing text, measure text, start_date date, end_date date, term_months integer, estimated_cost numeric, actual_cost numeric, units_total numeric, units_delivered numeric, percent_complete numeric, satisfied_date date, revenue_account_id uuid, deferred_account_id uuid, cost_center_id uuid, status text (read-only), is_distinct boolean, combined_with_id uuid, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), satisfied_by uuid (read-only) |
| Recognition Schedule (rev-schedule) | /api/v1/rev-schedule · /api/accounting/rev-schedule · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), contract_id uuid (read-only), obligation_id uuid (read-only), ledger_id uuid (read-only), period_code text (read-only), period_date date (read-only), period_no integer (read-only), planned_revenue numeric (read-only), recognised_revenue numeric (read-only), planned_cost numeric (read-only), recognised_cost numeric (read-only), cumulative_recognised numeric (read-only), percent_complete numeric (read-only), is_recognised boolean (read-only), run_id uuid (read-only), journal_id uuid (read-only), recognised_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Revenue Contracts (rev-contracts) | /api/v1/rev-contracts · /api/accounting/rev-contracts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), contract_no text (read-only), name* text, account_id uuid, opportunity_id uuid, sales_order_id uuid, project_id uuid, contract_date date, start_date date, end_date date, term_months integer, currency text, contract_value numeric, variable_consideration numeric, constraint_amount numeric, refund_liability numeric, transaction_price numeric (read-only), has_financing_component boolean, financing_rate_pct numeric, commission_amount numeric, fulfilment_cost numeric, modifies_contract_id uuid (read-only), modification_type text (read-only), version integer (read-only), status text (read-only), allocated_at timestamp with time zone (read-only), allocated_by uuid (read-only), principle_id uuid, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), completed_by uuid (read-only), completed_at timestamp with time zone (read-only) |
| Revenue Runs (rev-runs) | /api/v1/rev-runs · /api/accounting/rev-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), period_code* text, period_from* date, period_to* date, ledger_id uuid, is_test_run boolean, status text (read-only), contract_count integer (read-only), obligation_count integer (read-only), total_revenue numeric (read-only), total_cost numeric (read-only), deferred_movement numeric (read-only), journal_id uuid (read-only), exceptions jsonb (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Revenue Templates (rev-templates) | /api/v1/rev-templates · /api/accounting/rev-templates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, timing text, measure text, trigger_event text, default_term_months integer, revenue_account_id uuid, deferred_account_id uuid, unbilled_account_id uuid, capitalise_costs boolean, cost_asset_account_id uuid, cost_expense_account_id uuid, is_distinct boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Standalone Selling Prices (ssp-catalog) | /api/v1/ssp-catalog · /api/accounting/ssp-catalog · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), item_id uuid, product_family text, obligation_type text, currency text, ssp_amount numeric, ssp_pct_of_list numeric, method text, range_low numeric, range_high numeric, tolerance_pct numeric, basis_note text, valid_from date, valid_to date, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Settlement & Allocation
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Allocation Cycles (allocation-cycles) | /api/v1/allocation-cycles · /api/accounting/allocation-cycles · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, cycle_type text, ledger_id uuid, version text, sequence_no integer, is_iterative boolean, max_iterations integer, convergence_threshold numeric, frequency text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Allocation Runs (allocation-runs) | /api/v1/allocation-runs · /api/accounting/allocation-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), cycle_id uuid, period_code* text, posting_date date, version text, is_test_run boolean, status text (read-only), iterations integer (read-only), residual_amount numeric (read-only), sender_count integer (read-only), receiver_count integer (read-only), allocated_amount numeric (read-only), unallocated_amount numeric (read-only), journal_id uuid (read-only), close_run_id uuid, exceptions jsonb (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Allocation Segments (allocation-segments) | /api/v1/allocation-segments · /api/accounting/allocation-segments · /{id} | list, get, create, change, delete | id uuid (read-only), cycle_id* uuid, segment_no* integer, name* text, sender_type text, sender_pattern text, sender_group text, cost_element_pattern text, sender_pct numeric, sender_rule text, fixed_amount numeric, receiver_type text, receiver_pattern text, receiver_group text, driver_id uuid, basis text, assessment_element_id uuid, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cost Drivers (cost-drivers) | /api/v1/cost-drivers · /api/accounting/cost-drivers · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, unit text, driver_type text, source text, source_query text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Driver Values (driver-values) | /api/v1/driver-values · /api/accounting/driver-values · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), driver_id* uuid, period_code* text, receiver_type text, receiver_id uuid, receiver_code text, quantity numeric, source text, entered_by uuid, entered_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Fixed Allocation Split (allocation-receivers) | /api/v1/allocation-receivers · /api/accounting/allocation-receivers · /{id} | list, get, create, change, delete | id uuid (read-only), segment_id* uuid, line_no integer, receiver_type text, receiver_id uuid, receiver_code text, percentage numeric, portion numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Settlement Rules (settlement-rules) | /api/v1/settlement-rules · /api/accounting/settlement-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), source_type* text, source_id* uuid, line_no integer, receiver_type* text, receiver_id uuid, receiver_code text, basis text, percentage numeric, equivalence numeric, fixed_amount numeric, cost_element_group text, settlement_type text, valid_from date, valid_to date, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Settlement Runs (settlement-runs) | /api/v1/settlement-runs · /api/accounting/settlement-runs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), period_code* text, settlement_date date, source_type text, ledger_id uuid, settlement_type text, is_test_run boolean, status text (read-only), source_count integer (read-only), settled_amount numeric (read-only), unsettled_amount numeric (read-only), journal_id uuid (read-only), close_run_id uuid, exceptions jsonb (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Tax
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Deferred Tax (deferred-tax-balances) | /api/v1/deferred-tax-balances · /api/accounting/deferred-tax-balances · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), item_id* uuid, period_code* text, as_of_date* date, book_base numeric, tax_base numeric, temporary_difference numeric (read-only), tax_rate_pct numeric, deferred_tax numeric, opening_balance numeric, movement numeric, through_equity numeric, rate_change_effect numeric, journal_id uuid (read-only), is_posted boolean (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Deferred Tax Items (deferred-tax-items) | /api/v1/deferred-tax-items · /api/accounting/deferred-tax-items · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, category text, jurisdiction_id uuid, source_type text, book_area_id uuid, tax_area_id uuid, gl_account_id uuid, difference_type text, tax_rate_pct numeric, recognition_basis text, recognised_pct numeric, expected_reversal_years integer, dta_account_id uuid, dtl_account_id uuid, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Exemption Certificates (tax-exemptions) | /api/v1/tax-exemptions · /api/accounting/tax-exemptions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), certificate_no* text, account_id uuid, supplier_id uuid, jurisdiction_id uuid, tax_code_id uuid, exemption_type text, reason text, valid_from date, valid_to date, document_url text, verified_by uuid, verified_at timestamp with time zone, status text (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Line Tax Detail (document-tax-lines) | /api/v1/document-tax-lines · /api/accounting/document-tax-lines · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), document_type text (read-only), document_id uuid (read-only), document_no text (read-only), line_id uuid (read-only), line_no integer (read-only), document_date date (read-only), jurisdiction_id uuid (read-only), jurisdiction_code text (read-only), jurisdiction_name text (read-only), level text (read-only), state_code text (read-only), tax_code_id uuid (read-only), tax_code text (read-only), sourcing text (read-only), outcome text (read-only), rate_pct numeric (read-only), gross_amount numeric (read-only), taxable_base numeric (read-only), exempt_amount numeric (read-only), tax_amount numeric (read-only), exemption_id uuid (read-only), classification_id uuid (read-only), reason text (read-only), ship_to jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Return Boxes (return-boxes) | /api/v1/return-boxes · /api/accounting/return-boxes · /{id} | list, get, create, change, delete | id uuid (read-only), template_id* uuid, box_code* text, name* text, sequence_no integer, box_type text, direction text, formula text, sign integer, is_editable boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Return Templates (return-templates) | /api/v1/return-templates · /api/accounting/return-templates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, authority_id uuid, jurisdiction_id uuid, tax_type text, frequency text, filing_days integer, payment_days integer, form_code text, submission_format text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Tax Authorities (tax-authorities) | /api/v1/tax-authorities · /api/accounting/tax-authorities · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, country text, registration_no text, authority_type text, filing_portal text, contact_email text, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Tax Classifications (tax-classifications) | /api/v1/tax-classifications · /api/accounting/tax-classifications · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, scheme text, external_code text, jurisdiction_id uuid, default_tax_code_id uuid, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Tax Codes (tax-codes) | /api/v1/tax-codes · /api/accounting/tax-codes · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, jurisdiction_id uuid, tax_type text, direction text, treatment text, is_reverse_charge boolean, is_recoverable boolean, recoverable_pct numeric, input_account_id uuid, output_account_id uuid, expense_account_id uuid, reporting_group text, is_default boolean, valid_from date, valid_to date, is_active boolean, description text, zatca_category text, exemption_reason_code text, exemption_reason text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Tax Determination (tax-determination-rules) | /api/v1/tax-determination-rules · /api/accounting/tax-determination-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, priority integer, transaction_type text, ship_from_country text, ship_from_region text, ship_to_country text, ship_to_region text, jurisdiction_id uuid, classification_id uuid, item_id uuid, account_id uuid, supplier_id uuid, partner_registered boolean, partner_exempt boolean, amount_min numeric, amount_max numeric, tax_code_id* uuid, tax_code_2_id uuid, tax_code_3_id uuid, valid_from date, valid_to date, is_active boolean, reason text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Tax Jurisdictions (tax-jurisdictions) | /api/v1/tax-jurisdictions · /api/accounting/tax-jurisdictions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, parent_id uuid, authority_id uuid, level text, country text, region text, postal_from text, postal_to text, is_registered boolean, registration_no text, registered_from date, registered_to date, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), einvoice_regime text, name_ar text, sourcing_rule text, levies_sales_tax boolean, zatca_phase2 boolean, zatca_phase2_from date, zatca_archive_years integer (read-only) |
| Tax Rates (tax-rates) | /api/v1/tax-rates · /api/accounting/tax-rates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), tax_code_id* uuid, rate_pct numeric, amount_per_unit numeric, unit text, threshold_min numeric, threshold_max numeric, valid_from* date, valid_to date, legislation_ref text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Tax Returns (tax-returns) | /api/v1/tax-returns · /api/accounting/tax-returns · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), return_no text (read-only), template_id uuid, authority_id uuid, jurisdiction_id uuid, tax_type text, period_code* text, period_from* date, period_to* date, due_date date, currency text, output_tax numeric (read-only), input_tax numeric (read-only), adjustments numeric, net_payable numeric (read-only), paid_amount numeric (read-only), paid_date date (read-only), penalty_amount numeric (read-only), interest_amount numeric (read-only), status text (read-only), amends_return_id uuid (read-only), amendment_no integer (read-only), filed_at timestamp with time zone (read-only), filed_by uuid (read-only), filing_reference text (read-only), acknowledgement_no text (read-only), submission_payload text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), journal_id uuid (read-only), close_run_id uuid (read-only), transaction_count integer (read-only), exceptions jsonb (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Tax Transactions (tax-transactions) | /api/v1/tax-transactions · /api/accounting/tax-transactions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), txn_date date (read-only), tax_point_date date (read-only), period_code text (read-only), document_type text (read-only), document_id uuid (read-only), document_no text (read-only), line_no integer (read-only), direction text (read-only), tax_code_id uuid (read-only), tax_code text (read-only), jurisdiction_id uuid (read-only), classification_id uuid (read-only), account_id uuid (read-only), supplier_id uuid (read-only), partner_registration text (read-only), partner_country text (read-only), currency text (read-only), exchange_rate numeric (read-only), taxable_base numeric (read-only), tax_amount numeric (read-only), non_taxable_amount numeric (read-only), rate_pct numeric (read-only), recoverable_amount numeric (read-only), irrecoverable_amount numeric (read-only), is_reverse_charge boolean (read-only), exemption_id uuid (read-only), journal_id uuid (read-only), return_id uuid (read-only), is_reported boolean (read-only), corrects_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Taxability Rules (tax-taxability-rules) | /api/v1/tax-taxability-rules · /api/accounting/tax-taxability-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), jurisdiction_id* uuid, classification_id* uuid, treatment text, rate_pct numeric, max_unit_price numeric, applies_to_lower_levels boolean, valid_from date, valid_to date, legislation_ref text, notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| VAT Exemption Codes (vatex-codes) | /api/v1/vatex-codes · /api/accounting/vatex-codes · /{id} | list, get | id uuid (read-only), scheme text (read-only), code text (read-only), vat_category text (read-only), name_en text (read-only), name_ar text (read-only), free_text boolean (read-only), sort_order integer (read-only), is_active boolean (read-only), source text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Withholding (withholding-transactions) | /api/v1/withholding-transactions · /api/accounting/withholding-transactions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), withholding_type_id* uuid, supplier_id uuid, account_id uuid, employee_id uuid, document_type text, document_id uuid, document_no text, txn_date date, period_code text, currency text, gross_amount numeric, base_amount numeric, rate_pct numeric, withheld_amount numeric, net_paid numeric, treaty_applied boolean, treaty_country text, certificate_no text, certificate_issued_at timestamp with time zone (read-only), remitted boolean, remittance_date date, remittance_ref text, return_id uuid (read-only), journal_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Withholding Types (withholding-types) | /api/v1/withholding-types · /api/accounting/withholding-types · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, jurisdiction_id uuid, authority_id uuid, category text, rate_pct numeric, treaty_rate_pct numeric, threshold_amount numeric, threshold_basis text, base text, liability_account_id uuid, remittance_frequency text, certificate_required boolean, valid_from date, valid_to date, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Travel & Expense
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Card Transactions (card-transactions) | /api/v1/card-transactions · /api/accounting/card-transactions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), card_id* uuid, employee_id uuid, external_id text, transaction_date* date, posted_date date, merchant text, merchant_category_code text, city text, country text, currency text, amount numeric, billing_currency text, billing_amount numeric, exchange_rate numeric, detail jsonb, expense_line_id uuid, status text (read-only), matched_at timestamp with time zone (read-only), dispute_reason text, statement_ref text, statement_date date, journal_id uuid (read-only), imported_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Expense Claims (expense-claims) | /api/v1/expense-claims · /api/accounting/expense-claims · /{id} | list, get, create, change, delete | id uuid (read-only), report_no text (read-only), employee_id uuid (read-only), travel_request_id uuid (read-only), title text (read-only), period_start date (read-only), period_end date (read-only), currency text (read-only), total_amount numeric (read-only), reimbursable numeric (read-only), company_paid numeric (read-only), advance_applied numeric (read-only), violation_count integer (read-only), cost_center_id uuid (read-only), status text (read-only), submitted_at timestamp with time zone (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), rejection_reason text (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), claimant_id uuid (read-only), submitted_on_behalf boolean (read-only), project_id uuid, wbs_element_id uuid, period_code text, total_approved numeric (read-only), due_to_company numeric (read-only), tax_reclaimable numeric (read-only), billable_amount numeric (read-only), audit_status text (read-only), audit_reason text (read-only), auditor_id uuid (read-only), audited_at timestamp with time zone (read-only), audit_findings text, risk_score numeric (read-only), policy_violations jsonb (read-only), ap_invoice_id uuid (read-only), ap_payment_id uuid (read-only), payroll_run_id uuid (read-only), paid_at timestamp with time zone (read-only), notes text, exchange_rate numeric (read-only), base_total_amount numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Expense Lines (expense-lines) | /api/v1/expense-lines · /api/accounting/expense-lines · /{id} | list, get, create, change, delete | id uuid (read-only), report_id* uuid, line_no* integer, expense_date* date, expense_type* text, description text, merchant text, amount* numeric, currency text, exchange_rate numeric, base_amount numeric (read-only), is_billable boolean, is_company_paid boolean (read-only), card_id uuid (read-only), has_receipt boolean, receipt_ref text, gl_account_id uuid, cost_center_id uuid, policy_id uuid (read-only), violation text (read-only), violation_severity text (read-only), org_unit_id uuid (read-only), expense_type_id uuid, city text, country text, tax_amount numeric, tax_code_id uuid, reclaimable_tax numeric, quantity numeric, rate numeric, distance numeric, distance_unit text, nights integer, attendees integer, attendee_names text, project_id uuid, wbs_element_id uuid, account_id uuid, is_billed boolean (read-only), is_personal boolean, is_taxable_benefit boolean (read-only), payment_method text, card_transaction_id uuid, booking_id uuid, receipt_id uuid, approved_amount numeric (read-only), adjustment_reason text (read-only), status text (read-only), policy_violations jsonb (read-only), justification text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), fund_id uuid (read-only), grant_id uuid (read-only), program_id uuid (read-only), function_id uuid (read-only), derivation_trace jsonb (read-only) |
| Expense Types (expense-types) | /api/v1/expense-types · /api/accounting/expense-types · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, category text, gl_account_id uuid, tax_code_id uuid, tax_recoverable boolean, receipt_required_above numeric, requires_attendees boolean, requires_purpose boolean, requires_project boolean, calculation text, is_billable_default boolean, is_taxable_benefit boolean, sort_order integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Mileage Rates (mileage-rates) | /api/v1/mileage-rates · /api/accounting/mileage-rates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, country text, region text, grade text, vehicle_type text, currency text, amount numeric, unit text, tier_from numeric, tier_to numeric, tax_free_rate numeric, source text, valid_from date, valid_to date, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Receipts (expense-receipts) | /api/v1/expense-receipts · /api/accounting/expense-receipts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), employee_id uuid, uploaded_by uuid, file_name text, file_url text, mime_type text, file_size integer, content_hash text, extracted_merchant text, extracted_date date, extracted_amount numeric, extracted_currency text, extracted_tax numeric, extracted_tax_no text, extraction_confidence numeric, extraction_engine text, extracted_at timestamp with time zone (read-only), raw_text text, line_id uuid, status text (read-only), match_variance numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Travel Bookings (travel-bookings) | /api/v1/travel-bookings · /api/accounting/travel-bookings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), booking_no text (read-only), request_id uuid, employee_id uuid, booking_type text, supplier_id uuid, vendor_name text, confirmation_no text, ticket_no text, pnr text, from_location text, to_location text, depart_at timestamp with time zone, arrive_at timestamp with time zone, nights integer, cabin_class text, currency text, amount numeric, tax_amount numeric, lowest_fare numeric, savings numeric (read-only), is_refundable boolean, is_used boolean, credit_amount numeric, credit_expiry date, co2_kg numeric, payment_method text, card_id uuid, ap_invoice_id uuid, status text (read-only), source text, policy_violations jsonb (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Treasury
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Cash Forecast (cash-forecasts) | /api/v1/cash-forecasts · /api/accounting/cash-forecasts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), forecast_no text (read-only), name* text, version integer (read-only), supersedes_id uuid (read-only), as_of_date date, horizon_from* date, horizon_to* date, grain text, currency text, scenario text, collection_delay_days integer, payment_delay_days integer, revenue_shift_pct numeric, fx_shift_pct numeric, opening_balance numeric, total_inflow numeric (read-only), total_outflow numeric (read-only), closing_balance numeric (read-only), minimum_balance numeric (read-only), minimum_date date (read-only), has_shortfall boolean (read-only), shortfall_amount numeric (read-only), status text (read-only), accuracy_pct numeric (read-only), calculated_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cash Forecast Lines (forecast-lines) | /api/v1/forecast-lines · /api/accounting/forecast-lines · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), forecast_id* uuid, line_no* integer, liquidity_item_id uuid, bank_account_id uuid, expected_date* date, period_bucket text, direction* text, description text, currency text, amount numeric, base_amount numeric, exchange_rate numeric, confidence_pct numeric, weighted_amount numeric (read-only), contractual_date date, delay_days integer, source_type text, source_id uuid, source_ref text, account_id uuid, supplier_id uuid, is_committed boolean, is_manual boolean, actual_date date, actual_amount numeric, variance_days integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cash Pools (cash-pools) | /api/v1/cash-pools · /api/accounting/cash-pools · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, pool_type text, header_account_id uuid, currency text, sweep_frequency text, sweep_time time without time zone, credit_rate_pct numeric, debit_rate_pct numeric, rate_basis text, margin_pct numeric, day_count text, ic_receivable_account_id uuid, ic_payable_account_id uuid, interest_income_account_id uuid, interest_expense_account_id uuid, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Covenant Tests (covenant-tests) | /api/v1/covenant-tests · /api/accounting/covenant-tests · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), covenant_id* uuid, test_date* date, period_code text, actual_value numeric, threshold numeric, headroom numeric, result text, breach_notified boolean, waiver_ref text, tested_by uuid, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Daily Cash Positions (cash-positions) | /api/v1/cash-positions · /api/accounting/cash-positions · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), position_date* date, bank_account_id uuid, currency text, ledger_balance numeric, available_balance numeric, value_dated_balance numeric, uncleared_amount numeric, reporting_currency text, exchange_rate numeric, reporting_balance numeric, overdraft_used numeric, headroom numeric, is_restricted boolean, source text, captured_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), gl_account_id uuid (read-only) |
| Debt & Instruments (financial-instruments) | /api/v1/financial-instruments · /api/accounting/financial-instruments · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), instrument_no text (read-only), name* text, instrument_type text, direction text, counterparty text, counterparty_supplier_id uuid, counterparty_org_id uuid, bank_account_id uuid, currency text, principal_amount numeric, outstanding_amount numeric, facility_limit numeric, drawn_amount numeric, trade_date date, value_date date, maturity_date date, rate_type text, interest_rate_pct numeric, reference_rate text, margin_pct numeric, day_count text, payment_frequency text, buy_currency text, sell_currency text, buy_amount numeric, sell_amount numeric, contract_rate numeric, is_hedge boolean, hedge_type text, hedged_item text, hedge_ratio numeric, effectiveness_pct numeric, fair_value numeric, fair_value_date date, accrued_interest numeric, principal_account_id uuid, interest_account_id uuid, fair_value_account_id uuid, status text (read-only), contract_ref text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Debt Covenants (debt-covenants) | /api/v1/debt-covenants · /api/accounting/debt-covenants · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), instrument_id* uuid, code* text, name* text, covenant_type text, measure text, formula text, operator text, threshold numeric, test_frequency text, next_test_date date, cure_period_days integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Debt Service Schedule (instrument-schedule) | /api/v1/instrument-schedule · /api/accounting/instrument-schedule · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), instrument_id* uuid, period_no* integer, due_date* date, period_code text, opening_principal numeric, principal_payment numeric, interest_payment numeric, fee_payment numeric, total_payment numeric (read-only), closing_principal numeric, rate_pct numeric, currency text, is_paid boolean, paid_date date, paid_amount numeric, journal_id uuid (read-only), ap_payment_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Guarantees & Letters of Credit (bank-guarantees) | /api/v1/bank-guarantees · /api/accounting/bank-guarantees · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), guarantee_no text (read-only), name* text, guarantee_type text, direction text, issuing_bank text, bank_account_id uuid, beneficiary text, account_id uuid, supplier_id uuid, project_id uuid, contract_id uuid, currency text, amount numeric, current_amount numeric, is_reducing boolean, issue_date date, effective_date date, expiry_date date, claim_period_days integer, cash_margin numeric, commission_pct numeric, commission_paid numeric, auto_renew boolean, renewal_notice_days integer, status text (read-only), released_at timestamp with time zone (read-only), claim_amount numeric, claim_date date, reference text, document_url text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Liquidity Categories (liquidity-items) | /api/v1/liquidity-items · /api/accounting/liquidity-items · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, parent_id uuid, direction text, category text, source text, account_pattern text, sort_order integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Pool Participants (pool-participants) | /api/v1/pool-participants · /api/accounting/pool-participants · /{id} | list, get, create, change, delete | id uuid (read-only), pool_id* uuid, bank_account_id* uuid, company_id uuid, target_balance numeric, minimum_balance numeric, maximum_balance numeric, sweep_direction text, borrowing_limit numeric, credit_rate_pct numeric, debit_rate_pct numeric, joined_date date, left_date date, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Pool Sweeps (pool-sweeps) | /api/v1/pool-sweeps · /api/accounting/pool-sweeps · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), pool_id* uuid, sweep_no text (read-only), sweep_date date, value_date date, status text (read-only), participant_count integer (read-only), total_swept_in numeric (read-only), total_swept_out numeric (read-only), header_balance_before numeric (read-only), header_balance_after numeric (read-only), journal_id uuid (read-only), payment_batch_id uuid (read-only), executed_at timestamp with time zone (read-only), run_by uuid (read-only), exceptions jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
Workforce Planning
| Resource | Endpoints | Operations | Fields |
|---|---|---|---|
| Planned Positions (workforce-lines) | /api/v1/workforce-lines · /api/accounting/workforce-lines · /{id} | list, get, create, change, delete | id uuid (read-only), plan_id* uuid, line_no* integer, position_id uuid, employee_id uuid, cost_center_id uuid, org_unit_id uuid (read-only), project_id uuid, wbs_element_id uuid, job_title text, grade text, location text, worker_type text, action text, fte numeric, start_date date, end_date date, months_in_plan numeric, currency text, base_salary numeric, allowances numeric, bonus numeric, commission numeric, overtime numeric, employer_tax numeric, benefits numeric, pension numeric, other_cost numeric, total_cost numeric (read-only), increase_pct numeric, effective_increase_date date, capitalised_pct numeric, billable_pct numeric, requisition_id uuid (read-only), probability_pct numeric, status text (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Workforce by Period (workforce-periods) | /api/v1/workforce-periods · /api/accounting/workforce-periods · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), plan_id* uuid, line_id uuid, cost_center_id uuid, period_code* text, period_date* date, fte numeric, headcount numeric, base_cost numeric, loaded_cost numeric, actual_cost numeric, variance numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Workforce Cost Plans (workforce-plans) | /api/v1/workforce-plans · /api/accounting/workforce-plans · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, fiscal_year* integer, version text, baseline_plan_id uuid, period_from* date, period_to* date, currency text, cost_center_id uuid, merit_increase_pct numeric, promotion_budget_pct numeric, attrition_pct numeric, benefit_load_pct numeric, employer_tax_pct numeric, opening_headcount numeric (read-only), closing_headcount numeric (read-only), average_fte numeric (read-only), total_base_cost numeric (read-only), total_loaded_cost numeric (read-only), hire_count integer (read-only), leaver_count integer (read-only), status text (read-only), submitted_by uuid (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), calculated_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |