POST Setup/Funder/{funderID}/Rules

Request Information

URI Parameters

NameDescriptionTypeAdditional information
funderID

integer

Required

Body Parameters

FunderRuleDTO
NameDescriptionTypeAdditional information
FunderRuleID

integer

None.

FunderID

integer

None.

BUID

integer

None.

BUName

string

None.

Type

FunderRuleType

None.

GroupID

integer

None.

GroupName

string

None.

StartDate

date

None.

StopDate

date

None.

GLCode

string

None.

BillingRateTableID

integer

None.

InAdvance

boolean

None.

BillingFrequencyType

BillingFrequencyType

None.

BillingInvoiceStartDateDayOfWeek

string

None.

InvoiceValidationType

InvoiceValidationType

None.

StatementType

StatementType

None.

InvoiceDateType

InvoiceDateType

None.

InvoiceItemGroupDateType

InvoiceItemGroupDateType

None.

MonthDay

integer

None.

ExcludeExpiryDate

boolean

None.

InAdvanceResidentFrequency

boolean

None.

Comments

string

None.

ShouldGenerateSeparationInterestOnRefundableDeposits

boolean

None.

BaseInterestRate

integer

None.

MaximumPermissibleInterestRate

integer

None.

RecordState

RecordState

None.

Created

AuditDataDTO

None.

LastUpdated

AuditDataDTO

None.

Settings

Collection of FunderRuleSettingsDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "funderRuleID": 1,
  "funderID": 2,
  "buid": 3,
  "buName": "sample string 4",
  "type": 1,
  "groupID": 1,
  "groupName": "sample string 5",
  "startDate": "2024-12-04T07:46:57.0847696+00:00",
  "stopDate": "2024-12-04T07:46:57.0847696+00:00",
  "glCode": "sample string 7",
  "billingRateTableID": 8,
  "inAdvance": true,
  "billingFrequencyType": 2,
  "billingInvoiceStartDateDayOfWeek": "sample string 10",
  "invoiceValidationType": 1,
  "statementType": 1,
  "invoiceDateType": 1,
  "invoiceItemGroupDateType": 1,
  "monthDay": 1,
  "excludeExpiryDate": true,
  "inAdvanceResidentFrequency": true,
  "comments": "sample string 13",
  "shouldGenerateSeparationInterestOnRefundableDeposits": true,
  "baseInterestRate": 1,
  "maximumPermissibleInterestRate": 1,
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T07:46:57.0847696+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:46:57 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:46:57.0847696+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:46:57 AM"
  },
  "settings": [
    {
      "settingID": 1,
      "funderRuleID": 1,
      "name": "sample string 2",
      "nameValuePairs": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:46:57.0847696+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:57 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:46:57.0847696+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:57 AM"
      },
      "summary": "sample string 2"
    },
    {
      "settingID": 1,
      "funderRuleID": 1,
      "name": "sample string 2",
      "nameValuePairs": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:46:57.0847696+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:57 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:46:57.0847696+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:57 AM"
      },
      "summary": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<FunderRuleDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <BUID>3</BUID>
  <BUName>sample string 4</BUName>
  <BaseInterestRate>1</BaseInterestRate>
  <BillingFrequencyType>Days7</BillingFrequencyType>
  <BillingInvoiceStartDateDayOfWeek>sample string 10</BillingInvoiceStartDateDayOfWeek>
  <BillingRateTableID>8</BillingRateTableID>
  <Comments>sample string 13</Comments>
  <Created>
    <DateUtc>2024-12-04T07:46:57.0847696+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <ExcludeExpiryDate>true</ExcludeExpiryDate>
  <FunderID>2</FunderID>
  <FunderRuleID>1</FunderRuleID>
  <GLCode>sample string 7</GLCode>
  <GroupID>1</GroupID>
  <GroupName>sample string 5</GroupName>
  <InAdvance>true</InAdvance>
  <InAdvanceResidentFrequency>true</InAdvanceResidentFrequency>
  <InvoiceDateType>InvoiceStartDate</InvoiceDateType>
  <InvoiceItemGroupDateType>None</InvoiceItemGroupDateType>
  <InvoiceValidationType>Manual</InvoiceValidationType>
  <LastUpdated>
    <DateUtc>2024-12-04T07:46:57.0847696+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <MaximumPermissibleInterestRate>1</MaximumPermissibleInterestRate>
  <MonthDay>1</MonthDay>
  <RecordState>Active</RecordState>
  <Settings>
    <FunderRuleSettingsDTO>
      <Created>
        <DateUtc>2024-12-04T07:46:57.0847696+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <FunderRuleID>1</FunderRuleID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:46:57.0847696+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <Name>sample string 2</Name>
      <NameValuePairs>
        <FunderRuleSettingNameValuePairDTO>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FunderRuleSettingNameValuePairDTO>
        <FunderRuleSettingNameValuePairDTO>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FunderRuleSettingNameValuePairDTO>
      </NameValuePairs>
      <RecordState>Active</RecordState>
      <SettingID>1</SettingID>
    </FunderRuleSettingsDTO>
    <FunderRuleSettingsDTO>
      <Created>
        <DateUtc>2024-12-04T07:46:57.0847696+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <FunderRuleID>1</FunderRuleID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:46:57.0847696+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <Name>sample string 2</Name>
      <NameValuePairs>
        <FunderRuleSettingNameValuePairDTO>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FunderRuleSettingNameValuePairDTO>
        <FunderRuleSettingNameValuePairDTO>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FunderRuleSettingNameValuePairDTO>
      </NameValuePairs>
      <RecordState>Active</RecordState>
      <SettingID>1</SettingID>
    </FunderRuleSettingsDTO>
  </Settings>
  <ShouldGenerateSeparationInterestOnRefundableDeposits>true</ShouldGenerateSeparationInterestOnRefundableDeposits>
  <StartDate>2024-12-04T07:46:57.0847696+00:00</StartDate>
  <StatementType>TaxInvoice</StatementType>
  <StopDate>2024-12-04T07:46:57.0847696+00:00</StopDate>
  <Type>Standard</Type>
</FunderRuleDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:
��S�N�@���c�6&��d@9��	�q踋К^L/Q�(_6>�_�no$�4ܪ�^-�U���������-��eq�>x'	��R��}o�c(C�A���b�(D�*�Μ+i˶JmoM9p)�`eF��h%�N��D�4f� ;�F��pp4�EY�xY~>g?%��<t�e�ٹ+6ų��a��8&,
�d��w����(�iM2�c����IGd����k�?]c?m�1�*Ŵ�Ia��0�K��U_����+�"ȥ0�n�ځe�,�_˒��Ѭa�S�AS���:D!�DoR��;����S�\�	�X�L�€m.D�v��#(���R�&����z&?6^Rn�%(N��~�!

���t~����"W��W�x�EX
j�5&����j3H��^��[m����Cİ6W%�*�h0Ɓ��7��y��p�Vgp'j�SՔڊ�v�q[����$�~���~+��{����o��{��

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/x-compressed-json

Sample:

Sample not available.