POST api/RecurringPays
Request Information
URI Parameters
None.
Body Parameters
RecurringPay| Name | Description | Type | Additional information |
|---|---|---|---|
| RecurringId | integer |
None. |
|
| AuthorizationId | string |
Required String length: inclusive between 0 and 20 |
|
| Active | string |
String length: inclusive between 0 and 2 |
|
| RecType | string |
String length: inclusive between 0 and 30 |
|
| Service | string |
String length: inclusive between 0 and 50 |
|
| Category | string |
String length: inclusive between 0 and 50 |
|
| ExpId | integer |
None. |
|
| ExpenseCode | string |
String length: inclusive between 0 and 30 |
|
| LineDesc | string |
String length: inclusive between 0 and 50 |
|
| PaidTo | string |
String length: inclusive between 0 and 2 |
|
| PayAmt | decimal number |
None. |
|
| APRoute | string |
String length: inclusive between 0 and 10 |
|
| VendorId | integer |
None. |
|
| VendorCode | string |
String length: inclusive between 0 and 50 |
|
| AdvRed | integer |
None. |
|
| GlNbr | string |
String length: inclusive between 0 and 200 |
|
| User1 | string |
String length: inclusive between 0 and 50 |
|
| User2 | string |
String length: inclusive between 0 and 50 |
|
| User3 | string |
String length: inclusive between 0 and 50 |
|
| IntervalType | string |
String length: inclusive between 0 and 15 |
|
| IntervalID | integer |
None. |
|
| NextPaymentDue | date |
None. |
|
| StopDate | date |
None. |
|
| DateLastInvoiced | date |
None. |
|
| TotalInvoiced | decimal number |
None. |
|
| WhichFieldToStop | string |
String length: inclusive between 0 and 50 |
|
| BatchType | string |
String length: inclusive between 0 and 20 |
|
| Reference | string |
String length: inclusive between 0 and 75 |
|
| RouteTo | string |
String length: inclusive between 0 and 20 |
|
| PayAmt1 | decimal number |
None. |
|
| ExpID2 | integer |
None. |
|
| ExpenseCode2 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt2 | decimal number |
None. |
|
| ExpID3 | integer |
None. |
|
| ExpenseCode3 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt3 | decimal number |
None. |
|
| ExpID4 | integer |
None. |
|
| ExpenseCode4 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt4 | decimal number |
None. |
|
| ExpID5 | integer |
None. |
|
| ExpenseCode5 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt5 | decimal number |
None. |
|
| ReceiptCurrency | string |
String length: inclusive between 0 and 10 |
|
| PayInCurrency | string |
String length: inclusive between 0 and 10 |
|
| PayInMethod | string |
String length: inclusive between 0 and 20 |
|
| DueDate | date |
None. |
|
| PayAddress | string |
String length: inclusive between 0 and 200 |
|
| AddressOpt | byte |
None. |
|
| BankingID | integer |
None. |
|
| BankName | string |
String length: inclusive between 0 and 100 |
|
| EquivalentCurrency | string |
String length: inclusive between 0 and 10 |
|
| NotPayable | string |
String length: inclusive between 0 and 30 |
|
| CoreFlex | string |
String length: inclusive between 0 and 50 |
|
| JournalReason | string |
String length: inclusive between 0 and 50 |
|
| ID | integer |
None. |
Request Formats
application/json, text/json
{
"RecurringId": 1,
"AuthorizationId": "sample string 2",
"Active": "sample string 3",
"RecType": "sample string 4",
"Service": "sample string 5",
"Category": "sample string 6",
"ExpId": 1,
"ExpenseCode": "sample string 7",
"LineDesc": "sample string 8",
"PaidTo": "sample string 9",
"PayAmt": 1.0,
"APRoute": "sample string 10",
"VendorId": 1,
"VendorCode": "sample string 11",
"AdvRed": 1,
"GlNbr": "sample string 12",
"User1": "sample string 13",
"User2": "sample string 14",
"User3": "sample string 15",
"IntervalType": "sample string 16",
"IntervalID": 1,
"NextPaymentDue": "2025-05-09T17:27:15.3168275+00:00",
"StopDate": "2025-05-09T17:27:15.3168275+00:00",
"DateLastInvoiced": "2025-05-09T17:27:15.3168275+00:00",
"TotalInvoiced": 1.0,
"WhichFieldToStop": "sample string 17",
"BatchType": "sample string 18",
"Reference": "sample string 19",
"RouteTo": "sample string 20",
"PayAmt1": 1.0,
"ExpID2": 1,
"ExpenseCode2": "sample string 21",
"PayAmt2": 1.0,
"ExpID3": 1,
"ExpenseCode3": "sample string 22",
"PayAmt3": 1.0,
"ExpID4": 1,
"ExpenseCode4": "sample string 23",
"PayAmt4": 1.0,
"ExpID5": 1,
"ExpenseCode5": "sample string 24",
"PayAmt5": 1.0,
"ReceiptCurrency": "sample string 25",
"PayInCurrency": "sample string 26",
"PayInMethod": "sample string 27",
"DueDate": "2025-05-09T17:27:15.3168275+00:00",
"PayAddress": "sample string 28",
"AddressOpt": 64,
"BankingID": 1,
"BankName": "sample string 29",
"EquivalentCurrency": "sample string 30",
"NotPayable": "sample string 31",
"CoreFlex": "sample string 32",
"JournalReason": "sample string 33",
"ID": 34
}
application/xml, text/xml
<RecurringPay xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric"> <APRoute>sample string 10</APRoute> <Active>sample string 3</Active> <AddressOpt>64</AddressOpt> <AdvRed>1</AdvRed> <AuthorizationId>sample string 2</AuthorizationId> <BankName>sample string 29</BankName> <BankingID>1</BankingID> <BatchType>sample string 18</BatchType> <Category>sample string 6</Category> <CoreFlex>sample string 32</CoreFlex> <DateLastInvoiced>2025-05-09T17:27:15.3168275+00:00</DateLastInvoiced> <DueDate>2025-05-09T17:27:15.3168275+00:00</DueDate> <EquivalentCurrency>sample string 30</EquivalentCurrency> <ExpID2>1</ExpID2> <ExpID3>1</ExpID3> <ExpID4>1</ExpID4> <ExpID5>1</ExpID5> <ExpId>1</ExpId> <ExpenseCode>sample string 7</ExpenseCode> <ExpenseCode2>sample string 21</ExpenseCode2> <ExpenseCode3>sample string 22</ExpenseCode3> <ExpenseCode4>sample string 23</ExpenseCode4> <ExpenseCode5>sample string 24</ExpenseCode5> <GlNbr>sample string 12</GlNbr> <ID>34</ID> <IntervalID>1</IntervalID> <IntervalType>sample string 16</IntervalType> <JournalReason>sample string 33</JournalReason> <LineDesc>sample string 8</LineDesc> <NextPaymentDue>2025-05-09T17:27:15.3168275+00:00</NextPaymentDue> <NotPayable>sample string 31</NotPayable> <PaidTo>sample string 9</PaidTo> <PayAddress>sample string 28</PayAddress> <PayAmt>1</PayAmt> <PayAmt1>1</PayAmt1> <PayAmt2>1</PayAmt2> <PayAmt3>1</PayAmt3> <PayAmt4>1</PayAmt4> <PayAmt5>1</PayAmt5> <PayInCurrency>sample string 26</PayInCurrency> <PayInMethod>sample string 27</PayInMethod> <RecType>sample string 4</RecType> <ReceiptCurrency>sample string 25</ReceiptCurrency> <RecurringId>1</RecurringId> <Reference>sample string 19</Reference> <RouteTo>sample string 20</RouteTo> <Service>sample string 5</Service> <StopDate>2025-05-09T17:27:15.3168275+00:00</StopDate> <TotalInvoiced>1</TotalInvoiced> <User1>sample string 13</User1> <User2>sample string 14</User2> <User3>sample string 15</User3> <VendorCode>sample string 11</VendorCode> <VendorId>1</VendorId> <WhichFieldToStop>sample string 17</WhichFieldToStop> </RecurringPay>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
RecurringPay| Name | Description | Type | Additional information |
|---|---|---|---|
| RecurringId | integer |
None. |
|
| AuthorizationId | string |
Required String length: inclusive between 0 and 20 |
|
| Active | string |
String length: inclusive between 0 and 2 |
|
| RecType | string |
String length: inclusive between 0 and 30 |
|
| Service | string |
String length: inclusive between 0 and 50 |
|
| Category | string |
String length: inclusive between 0 and 50 |
|
| ExpId | integer |
None. |
|
| ExpenseCode | string |
String length: inclusive between 0 and 30 |
|
| LineDesc | string |
String length: inclusive between 0 and 50 |
|
| PaidTo | string |
String length: inclusive between 0 and 2 |
|
| PayAmt | decimal number |
None. |
|
| APRoute | string |
String length: inclusive between 0 and 10 |
|
| VendorId | integer |
None. |
|
| VendorCode | string |
String length: inclusive between 0 and 50 |
|
| AdvRed | integer |
None. |
|
| GlNbr | string |
String length: inclusive between 0 and 200 |
|
| User1 | string |
String length: inclusive between 0 and 50 |
|
| User2 | string |
String length: inclusive between 0 and 50 |
|
| User3 | string |
String length: inclusive between 0 and 50 |
|
| IntervalType | string |
String length: inclusive between 0 and 15 |
|
| IntervalID | integer |
None. |
|
| NextPaymentDue | date |
None. |
|
| StopDate | date |
None. |
|
| DateLastInvoiced | date |
None. |
|
| TotalInvoiced | decimal number |
None. |
|
| WhichFieldToStop | string |
String length: inclusive between 0 and 50 |
|
| BatchType | string |
String length: inclusive between 0 and 20 |
|
| Reference | string |
String length: inclusive between 0 and 75 |
|
| RouteTo | string |
String length: inclusive between 0 and 20 |
|
| PayAmt1 | decimal number |
None. |
|
| ExpID2 | integer |
None. |
|
| ExpenseCode2 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt2 | decimal number |
None. |
|
| ExpID3 | integer |
None. |
|
| ExpenseCode3 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt3 | decimal number |
None. |
|
| ExpID4 | integer |
None. |
|
| ExpenseCode4 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt4 | decimal number |
None. |
|
| ExpID5 | integer |
None. |
|
| ExpenseCode5 | string |
String length: inclusive between 0 and 30 |
|
| PayAmt5 | decimal number |
None. |
|
| ReceiptCurrency | string |
String length: inclusive between 0 and 10 |
|
| PayInCurrency | string |
String length: inclusive between 0 and 10 |
|
| PayInMethod | string |
String length: inclusive between 0 and 20 |
|
| DueDate | date |
None. |
|
| PayAddress | string |
String length: inclusive between 0 and 200 |
|
| AddressOpt | byte |
None. |
|
| BankingID | integer |
None. |
|
| BankName | string |
String length: inclusive between 0 and 100 |
|
| EquivalentCurrency | string |
String length: inclusive between 0 and 10 |
|
| NotPayable | string |
String length: inclusive between 0 and 30 |
|
| CoreFlex | string |
String length: inclusive between 0 and 50 |
|
| JournalReason | string |
String length: inclusive between 0 and 50 |
|
| ID | integer |
None. |
Response Formats
application/json, text/json
{
"RecurringId": 1,
"AuthorizationId": "sample string 2",
"Active": "sample string 3",
"RecType": "sample string 4",
"Service": "sample string 5",
"Category": "sample string 6",
"ExpId": 1,
"ExpenseCode": "sample string 7",
"LineDesc": "sample string 8",
"PaidTo": "sample string 9",
"PayAmt": 1.0,
"APRoute": "sample string 10",
"VendorId": 1,
"VendorCode": "sample string 11",
"AdvRed": 1,
"GlNbr": "sample string 12",
"User1": "sample string 13",
"User2": "sample string 14",
"User3": "sample string 15",
"IntervalType": "sample string 16",
"IntervalID": 1,
"NextPaymentDue": "2025-05-09T17:27:15.3268464+00:00",
"StopDate": "2025-05-09T17:27:15.3268464+00:00",
"DateLastInvoiced": "2025-05-09T17:27:15.3268464+00:00",
"TotalInvoiced": 1.0,
"WhichFieldToStop": "sample string 17",
"BatchType": "sample string 18",
"Reference": "sample string 19",
"RouteTo": "sample string 20",
"PayAmt1": 1.0,
"ExpID2": 1,
"ExpenseCode2": "sample string 21",
"PayAmt2": 1.0,
"ExpID3": 1,
"ExpenseCode3": "sample string 22",
"PayAmt3": 1.0,
"ExpID4": 1,
"ExpenseCode4": "sample string 23",
"PayAmt4": 1.0,
"ExpID5": 1,
"ExpenseCode5": "sample string 24",
"PayAmt5": 1.0,
"ReceiptCurrency": "sample string 25",
"PayInCurrency": "sample string 26",
"PayInMethod": "sample string 27",
"DueDate": "2025-05-09T17:27:15.3268464+00:00",
"PayAddress": "sample string 28",
"AddressOpt": 64,
"BankingID": 1,
"BankName": "sample string 29",
"EquivalentCurrency": "sample string 30",
"NotPayable": "sample string 31",
"CoreFlex": "sample string 32",
"JournalReason": "sample string 33",
"ID": 34
}
application/xml, text/xml
<RecurringPay xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric"> <APRoute>sample string 10</APRoute> <Active>sample string 3</Active> <AddressOpt>64</AddressOpt> <AdvRed>1</AdvRed> <AuthorizationId>sample string 2</AuthorizationId> <BankName>sample string 29</BankName> <BankingID>1</BankingID> <BatchType>sample string 18</BatchType> <Category>sample string 6</Category> <CoreFlex>sample string 32</CoreFlex> <DateLastInvoiced>2025-05-09T17:27:15.3268464+00:00</DateLastInvoiced> <DueDate>2025-05-09T17:27:15.3268464+00:00</DueDate> <EquivalentCurrency>sample string 30</EquivalentCurrency> <ExpID2>1</ExpID2> <ExpID3>1</ExpID3> <ExpID4>1</ExpID4> <ExpID5>1</ExpID5> <ExpId>1</ExpId> <ExpenseCode>sample string 7</ExpenseCode> <ExpenseCode2>sample string 21</ExpenseCode2> <ExpenseCode3>sample string 22</ExpenseCode3> <ExpenseCode4>sample string 23</ExpenseCode4> <ExpenseCode5>sample string 24</ExpenseCode5> <GlNbr>sample string 12</GlNbr> <ID>34</ID> <IntervalID>1</IntervalID> <IntervalType>sample string 16</IntervalType> <JournalReason>sample string 33</JournalReason> <LineDesc>sample string 8</LineDesc> <NextPaymentDue>2025-05-09T17:27:15.3268464+00:00</NextPaymentDue> <NotPayable>sample string 31</NotPayable> <PaidTo>sample string 9</PaidTo> <PayAddress>sample string 28</PayAddress> <PayAmt>1</PayAmt> <PayAmt1>1</PayAmt1> <PayAmt2>1</PayAmt2> <PayAmt3>1</PayAmt3> <PayAmt4>1</PayAmt4> <PayAmt5>1</PayAmt5> <PayInCurrency>sample string 26</PayInCurrency> <PayInMethod>sample string 27</PayInMethod> <RecType>sample string 4</RecType> <ReceiptCurrency>sample string 25</ReceiptCurrency> <RecurringId>1</RecurringId> <Reference>sample string 19</Reference> <RouteTo>sample string 20</RouteTo> <Service>sample string 5</Service> <StopDate>2025-05-09T17:27:15.3268464+00:00</StopDate> <TotalInvoiced>1</TotalInvoiced> <User1>sample string 13</User1> <User2>sample string 14</User2> <User3>sample string 15</User3> <VendorCode>sample string 11</VendorCode> <VendorId>1</VendorId> <WhichFieldToStop>sample string 17</WhichFieldToStop> </RecurringPay>