PUT api/v1/docgenerator/contracts

Salva a Alteração e Buscar todos os contratos salvos

Request Information

URI Parameters

None.

Requires Authorization!

Roles:

Body Parameters

ContractsDto
NameDescriptionTypeAdditional information
Id

integer

None.

NumeroContrato

integer

None.

NomeUnidade

string

None.

CodigoUnidade

integer

None.

Titulo

string

None.

Contrato

string

None.

DataEmissao

date

None.

DataModificacao

date

None.

Descricao

string

None.

IdVersionContractsSource

string

None.

MatriculaAssociado

integer

None.

Analizado

boolean

None.

Header

string

None.

Status

integer

None.

ValorPepcm

decimal number

None.

ValorCedula

decimal number

None.

Produto

integer

None.

Quantidade

decimal number

None.

QuantidadeSacas

integer

None.

ValorSaca

decimal number

None.

Safra

string

None.

Signed

boolean

None.

SignedDescription

string

None.

SignedCerc

boolean

None.

DataVencimento

date

None.

NomeTitular

string

None.

RegistroCerc

integer

None.

DataRegistroCerc

date

None.

ChangedOutPeriod

boolean

None.

Reasons

string

None.

IsCartorio

boolean

None.

CartorioDescricao

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "NumeroContrato": 2,
  "NomeUnidade": "sample string 3",
  "CodigoUnidade": 4,
  "Titulo": "sample string 5",
  "Contrato": "sample string 6",
  "DataEmissao": "2025-04-29T11:43:33.2885975-03:00",
  "DataModificacao": "2025-04-29T11:43:33.2885975-03:00",
  "Descricao": "sample string 9",
  "IdVersionContractsSource": "sample string 10",
  "MatriculaAssociado": 11,
  "Analizado": true,
  "Header": "sample string 13",
  "Status": 14,
  "ValorPepcm": 15.0,
  "ValorCedula": 16.0,
  "Produto": 17,
  "Quantidade": 18.0,
  "QuantidadeSacas": 19,
  "ValorSaca": 20.0,
  "Safra": "sample string 21",
  "Signed": true,
  "SignedDescription": "sample string 23",
  "SignedCerc": true,
  "DataVencimento": "2025-04-29T11:43:33.2885975-03:00",
  "NomeTitular": "sample string 26",
  "RegistroCerc": 1,
  "DataRegistroCerc": "2025-04-29T11:43:33.2885975-03:00",
  "ChangedOutPeriod": true,
  "Reasons": "sample string 28",
  "IsCartorio": true,
  "CartorioDescricao": "sample string 30"
}

application/xml, text/xml

Sample:
<ContractsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.SicopPlus.Entities.DTOs.DocGenerator">
  <Analizado>true</Analizado>
  <CartorioDescricao>sample string 30</CartorioDescricao>
  <ChangedOutPeriod>true</ChangedOutPeriod>
  <CodigoUnidade>4</CodigoUnidade>
  <Contrato>sample string 6</Contrato>
  <DataEmissao>2025-04-29T11:43:33.2885975-03:00</DataEmissao>
  <DataModificacao>2025-04-29T11:43:33.2885975-03:00</DataModificacao>
  <DataRegistroCerc>2025-04-29T11:43:33.2885975-03:00</DataRegistroCerc>
  <DataVencimento>2025-04-29T11:43:33.2885975-03:00</DataVencimento>
  <Descricao>sample string 9</Descricao>
  <Header>sample string 13</Header>
  <Id>1</Id>
  <IdVersionContractsSource>sample string 10</IdVersionContractsSource>
  <IsCartorio>true</IsCartorio>
  <MatriculaAssociado>11</MatriculaAssociado>
  <NomeTitular>sample string 26</NomeTitular>
  <NomeUnidade>sample string 3</NomeUnidade>
  <NumeroContrato>2</NumeroContrato>
  <Produto>17</Produto>
  <Quantidade>18</Quantidade>
  <QuantidadeSacas>19</QuantidadeSacas>
  <Reasons>sample string 28</Reasons>
  <RegistroCerc>1</RegistroCerc>
  <Safra>sample string 21</Safra>
  <Signed>true</Signed>
  <SignedCerc>true</SignedCerc>
  <SignedDescription>sample string 23</SignedDescription>
  <Status>14</Status>
  <Titulo>sample string 5</Titulo>
  <ValorCedula>16</ValorCedula>
  <ValorPepcm>15</ValorPepcm>
  <ValorSaca>20</ValorSaca>
</ContractsDto>

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 'ContractsDto'.

Response Information

Resource Description

ResultOfContractsDto
NameDescriptionTypeAdditional information
Data

ContractsDto

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Id": 1,
    "NumeroContrato": 2,
    "NomeUnidade": "sample string 3",
    "CodigoUnidade": 4,
    "Titulo": "sample string 5",
    "Contrato": "sample string 6",
    "DataEmissao": "2025-04-29T11:43:33.3042214-03:00",
    "DataModificacao": "2025-04-29T11:43:33.3042214-03:00",
    "Descricao": "sample string 9",
    "IdVersionContractsSource": "sample string 10",
    "MatriculaAssociado": 11,
    "Analizado": true,
    "Header": "sample string 13",
    "Status": 14,
    "ValorPepcm": 15.0,
    "ValorCedula": 16.0,
    "Produto": 17,
    "Quantidade": 18.0,
    "QuantidadeSacas": 19,
    "ValorSaca": 20.0,
    "Safra": "sample string 21",
    "Signed": true,
    "SignedDescription": "sample string 23",
    "SignedCerc": true,
    "DataVencimento": "2025-04-29T11:43:33.3042214-03:00",
    "NomeTitular": "sample string 26",
    "RegistroCerc": 1,
    "DataRegistroCerc": "2025-04-29T11:43:33.3042214-03:00",
    "ChangedOutPeriod": true,
    "Reasons": "sample string 28",
    "IsCartorio": true,
    "CartorioDescricao": "sample string 30"
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResultOfContractsDtoLDG1iB_Pd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.Entities.Ep">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Lar.SicopPlus.Entities.DTOs.DocGenerator">
    <d2p1:Analizado>true</d2p1:Analizado>
    <d2p1:CartorioDescricao>sample string 30</d2p1:CartorioDescricao>
    <d2p1:ChangedOutPeriod>true</d2p1:ChangedOutPeriod>
    <d2p1:CodigoUnidade>4</d2p1:CodigoUnidade>
    <d2p1:Contrato>sample string 6</d2p1:Contrato>
    <d2p1:DataEmissao>2025-04-29T11:43:33.3042214-03:00</d2p1:DataEmissao>
    <d2p1:DataModificacao>2025-04-29T11:43:33.3042214-03:00</d2p1:DataModificacao>
    <d2p1:DataRegistroCerc>2025-04-29T11:43:33.3042214-03:00</d2p1:DataRegistroCerc>
    <d2p1:DataVencimento>2025-04-29T11:43:33.3042214-03:00</d2p1:DataVencimento>
    <d2p1:Descricao>sample string 9</d2p1:Descricao>
    <d2p1:Header>sample string 13</d2p1:Header>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IdVersionContractsSource>sample string 10</d2p1:IdVersionContractsSource>
    <d2p1:IsCartorio>true</d2p1:IsCartorio>
    <d2p1:MatriculaAssociado>11</d2p1:MatriculaAssociado>
    <d2p1:NomeTitular>sample string 26</d2p1:NomeTitular>
    <d2p1:NomeUnidade>sample string 3</d2p1:NomeUnidade>
    <d2p1:NumeroContrato>2</d2p1:NumeroContrato>
    <d2p1:Produto>17</d2p1:Produto>
    <d2p1:Quantidade>18</d2p1:Quantidade>
    <d2p1:QuantidadeSacas>19</d2p1:QuantidadeSacas>
    <d2p1:Reasons>sample string 28</d2p1:Reasons>
    <d2p1:RegistroCerc>1</d2p1:RegistroCerc>
    <d2p1:Safra>sample string 21</d2p1:Safra>
    <d2p1:Signed>true</d2p1:Signed>
    <d2p1:SignedCerc>true</d2p1:SignedCerc>
    <d2p1:SignedDescription>sample string 23</d2p1:SignedDescription>
    <d2p1:Status>14</d2p1:Status>
    <d2p1:Titulo>sample string 5</d2p1:Titulo>
    <d2p1:ValorCedula>16</d2p1:ValorCedula>
    <d2p1:ValorPepcm>15</d2p1:ValorPepcm>
    <d2p1:ValorSaca>20</d2p1:ValorSaca>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ResultOfContractsDtoLDG1iB_Pd>