Transaction Rules

<b>BETA:</b> Return an App Transaction Rule.

get/sites/{site-identifier}/transaction-rules/{rule-guid}

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/transaction-rules/{rule-guid}
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

rule-guidstring required

The GUID that identifies an app transaction rule

Response

Success

RuleGUIDstring guid
RuleNumberstring
RuleNamestring
SystemDefinedboolean
Statusstring
RuleOrdernumber
ChartAccountGUIDstring guid

Example response

{
  "RuleGUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70e0",
  "RuleNumber": "5123.3",
  "RuleName": "Transacion rule",
  "SystemDefined": true,
  "Status": "Active/Inactive",
  "ChartAccountGUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70e0",
  "AppliedTo": {
    "GUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70e0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.