POST api/v3/Mps/company/{CompanyId}/monthlypayment?IncomeOriginID={IncomeOriginID}&ApplicationName={ApplicationName}&ApiKey={ApiKey}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | string |
Required |
|
| IncomeOriginID | string |
Required |
|
| ApplicationName | string |
Required |
|
| ApiKey | string |
Required |
Body Parameters
Collection of MonthlyPayments| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationId | string |
Required Max length: 6 Min length: 6 String length: inclusive between 6 and 6 |
|
| PayDate | date |
Required |
|
| AccountNumber | string |
Required String length: inclusive between 2 and 10 |
|
| Amount | decimal number |
Required |
|
| PayType | byte |
None. |
|
| CheckNumber | string |
String length: inclusive between 0 and 20 |
|
| CCdAccount | string |
None. |
|
| CCdExpDate | string |
String length: inclusive between 0 and 4 |
|
| CCdAuthNumber | string |
None. |
|
| CCdManualEntry | boolean |
None. |
|
| PayMonth | date |
Required |
|
| IncomeOriginSystem | byte |
Required |
|
| IncomeOriginID | string |
Required |
|
| IncomeGUID | string |
None. |
|
| WSId | string |
None. |
|
| AuthorizationCode | string |
String length: inclusive between 0 and 20 |
|
| UserName | string |
Required String length: inclusive between 0 and 30 |
|
| Deleted | date |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"LocationId": "sample string 1",
"PayDate": "2025-12-12T22:33:04.3400946-05:00",
"AccountNumber": "sample string 3",
"Amount": 4.0,
"PayType": 64,
"CheckNumber": "sample string 6",
"CCdAccount": "sample string 7",
"CCdExpDate": "sample string 8",
"CCdAuthNumber": "sample string 9",
"CCdManualEntry": true,
"PayMonth": "2025-12-12T22:33:04.3400946-05:00",
"IncomeOriginSystem": 64,
"IncomeOriginID": "sample string 12",
"IncomeGUID": "sample string 13",
"WSId": "sample string 14",
"AuthorizationCode": "sample string 15",
"UserName": "sample string 16",
"Deleted": "2025-12-12T22:33:04.3400946-05:00"
},
{
"LocationId": "sample string 1",
"PayDate": "2025-12-12T22:33:04.3400946-05:00",
"AccountNumber": "sample string 3",
"Amount": 4.0,
"PayType": 64,
"CheckNumber": "sample string 6",
"CCdAccount": "sample string 7",
"CCdExpDate": "sample string 8",
"CCdAuthNumber": "sample string 9",
"CCdManualEntry": true,
"PayMonth": "2025-12-12T22:33:04.3400946-05:00",
"IncomeOriginSystem": 64,
"IncomeOriginID": "sample string 12",
"IncomeGUID": "sample string 13",
"WSId": "sample string 14",
"AuthorizationCode": "sample string 15",
"UserName": "sample string 16",
"Deleted": "2025-12-12T22:33:04.3400946-05:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfMonthlyPayments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MPSWebApi.Models">
<MonthlyPayments>
<AccountNumber>sample string 3</AccountNumber>
<Amount>4</Amount>
<AuthorizationCode>sample string 15</AuthorizationCode>
<CCdAccount>sample string 7</CCdAccount>
<CCdAuthNumber>sample string 9</CCdAuthNumber>
<CCdExpDate>sample string 8</CCdExpDate>
<CCdManualEntry>true</CCdManualEntry>
<CheckNumber>sample string 6</CheckNumber>
<Deleted>2025-12-12T22:33:04.3400946-05:00</Deleted>
<IncomeGUID>sample string 13</IncomeGUID>
<IncomeOriginID>sample string 12</IncomeOriginID>
<IncomeOriginSystem>64</IncomeOriginSystem>
<LocationId>sample string 1</LocationId>
<PayDate>2025-12-12T22:33:04.3400946-05:00</PayDate>
<PayMonth>2025-12-12T22:33:04.3400946-05:00</PayMonth>
<PayType>64</PayType>
<UserName>sample string 16</UserName>
<WSId>sample string 14</WSId>
</MonthlyPayments>
<MonthlyPayments>
<AccountNumber>sample string 3</AccountNumber>
<Amount>4</Amount>
<AuthorizationCode>sample string 15</AuthorizationCode>
<CCdAccount>sample string 7</CCdAccount>
<CCdAuthNumber>sample string 9</CCdAuthNumber>
<CCdExpDate>sample string 8</CCdExpDate>
<CCdManualEntry>true</CCdManualEntry>
<CheckNumber>sample string 6</CheckNumber>
<Deleted>2025-12-12T22:33:04.3400946-05:00</Deleted>
<IncomeGUID>sample string 13</IncomeGUID>
<IncomeOriginID>sample string 12</IncomeOriginID>
<IncomeOriginSystem>64</IncomeOriginSystem>
<LocationId>sample string 1</LocationId>
<PayDate>2025-12-12T22:33:04.3400946-05:00</PayDate>
<PayMonth>2025-12-12T22:33:04.3400946-05:00</PayMonth>
<PayType>64</PayType>
<UserName>sample string 16</UserName>
<WSId>sample string 14</WSId>
</MonthlyPayments>
</ArrayOfMonthlyPayments>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |