POST api/GetIncome

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
User	string	None.
UserId	integer	None.
ValidationKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "user": "sample string 2",
  "userId": 3,
  "validationKey": "sample string 4"
}

application/xml, text/xml

Sample:

<RequestEnhance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SGAMovil.Request">
  <User>sample string 2</User>
  <UserId>3</UserId>
  <ValidationKey>sample string 4</ValidationKey>
  <Id>1</Id>
</RequestEnhance>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestEnhance'.

Response Information

Resource Description

IncomeResponse

Name	Type	Additional information
IdIncomeType	integer	None.
IncomeType	string	None.
IdIncomeState	integer	None.
IncomeState	string	None.
IdIncomeOrigin	integer	None.
IncomeOrigin	string	None.
IdIncomeProvider	integer	None.
IncomeProvider	string	None.
Number	string	None.
DocumentNumber	string	None.
Description	string	None.
IncomeDate	date	None.
CreationDate	date	None.
IsDistributed	boolean	None.
IdClient	integer	None.
Id	integer	None.
IsInUse	boolean	None.
ResultCode	integer	None.
ResultMessage	string	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "idIncomeType": 1,
  "incomeType": "sample string 2",
  "idIncomeState": 3,
  "incomeState": "sample string 4",
  "idIncomeOrigin": 5,
  "incomeOrigin": "sample string 6",
  "idIncomeProvider": 7,
  "incomeProvider": "sample string 8",
  "number": "sample string 9",
  "documentNumber": "sample string 10",
  "description": "sample string 11",
  "incomeDate": "2024-11-30T23:56:16.3191941-05:00",
  "creationDate": "2024-11-30T23:56:16.3191941-05:00",
  "isDistributed": true,
  "idClient": 15,
  "id": 16,
  "isInUse": true,
  "resultCode": 18,
  "resultMessage": "sample string 19",
  "errorMessage": "sample string 20"
}

application/xml, text/xml

Sample:

<IncomeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SGAMovil.Response.Income">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/SGAMovil.Response">sample string 20</ErrorMessage>
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/SGAMovil.Response">18</ResultCode>
  <ResultMessage xmlns="http://schemas.datacontract.org/2004/07/SGAMovil.Response">sample string 19</ResultMessage>
  <Id xmlns="http://schemas.datacontract.org/2004/07/SGAMovil.Response">16</Id>
  <IsInUse xmlns="http://schemas.datacontract.org/2004/07/SGAMovil.Response">true</IsInUse>
  <CreationDate>2024-11-30T23:56:16.3191941-05:00</CreationDate>
  <Description>sample string 11</Description>
  <DocumentNumber>sample string 10</DocumentNumber>
  <IdClient>15</IdClient>
  <IdIncomeOrigin>5</IdIncomeOrigin>
  <IdIncomeProvider>7</IdIncomeProvider>
  <IdIncomeState>3</IdIncomeState>
  <IdIncomeType>1</IdIncomeType>
  <IncomeDate>2024-11-30T23:56:16.3191941-05:00</IncomeDate>
  <IncomeOrigin>sample string 6</IncomeOrigin>
  <IncomeProvider>sample string 8</IncomeProvider>
  <IncomeState>sample string 4</IncomeState>
  <IncomeType>sample string 2</IncomeType>
  <IsDistributed>true</IsDistributed>
  <Number>sample string 9</Number>
</IncomeResponse>