Páginas filhas
  • Contrato de Cana (PUT)

Informações da Mensagem

  • Tipo de Envio: Assíncrona / Síncrona
  • Tipo de Evento: Update

Campo Obrigatórios

  • Código da Instância;
  • Código da Empresa;
  • Número do Contrato
  • Número da Ficha de originação
  • Data de Alteração 
  • Tipo de movimentação

Exemplos de Mensagens

Mensagem XML

Family_Envio
POST /TOTVS/CONTRATOS_WS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "CONTRATOS_WS/apiHTTP_PUT_CONTRATO_CANA"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <apiHTTP_PUT_CONTRATO_CANA xmlns="CONTRATOS_WS">
      <oCONTRATO_CANA>
        <instancia>string</instancia>
        <cdEmpresa>string</cdEmpresa>
        <noContrCana>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </noContrCana>
        <dtAlteracao>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtAlteracao>
        <fgTpMovto>string</fgTpMovto>
        <nmUsuario>string</nmUsuario>
        <fazenda>string</fazenda>
        <fgSituacao>string</fgSituacao>
        <cdTpContr>string</cdTpContr>
        <dtAssinatura>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtAssinatura>
        <dtInicPrepSolo>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtInicPrepSolo>
        <dtInicVigencia>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtInicVigencia>
        <dtFinVigencia>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtFinVigencia>
        <qtAreaTot>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtAreaTot>
        <qtAreaContr>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtAreaContr>
        <qtTch>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtTch>
        <cdTpCalcMM>string</cdTpCalcMM>
        <vlRefPgMM>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </vlRefPgMM>
        <qtAtrPgMM>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtAtrPgMM>
        <cdTpCalcAA>string</cdTpCalcAA>
        <vlRefPgAA>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </vlRefPgAA>
        <qtAtrPgAA>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtAtrPgAA>
        <dtInicPagto>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtInicPagto>
        <fgPerPg>string</fgPerPg>
        <ddPagto>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </ddPagto>
        <noContrato>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </noContrato>
        <cdCartorio>string</cdCartorio>
        <fgAcertoFinal>string</fgAcertoFinal>
        <fgEmisNf>string</fgEmisNf>
        <fgRenovacao>string</fgRenovacao>
        <qtParcela>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtParcela>
        <cdIndEco>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </cdIndEco>
        <cdIndEcoAnual>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </cdIndEcoAnual>
        <fgFormaPg>string</fgFormaPg>
        <vlMinimoMM>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </vlMinimoMM>
        <dtPrev1Corte>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtPrev1Corte>
        <qtTchPg>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtTchPg>
        <fgComplInic>string</fgComplInic>
        <qtRenovacao>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtRenovacao>
        <cdIntERP>string</cdIntERP>
        <fgDDPagto>string</fgDDPagto>
        <dtAreaContr>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtAreaContr>
        <qtAreaPrelim>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtAreaPrelim>
        <dtAreaPrelim>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtAreaPrelim>
        <dtAreaTotal>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtAreaTotal>
        <dtLimUtilOp>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtLimUtilOp>
        <dtIniOpUtil>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtIniOpUtil>
        <dtFinOpUtil>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtFinOpUtil>
        <dtIniAditivo>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtIniAditivo>
        <dtFinAditivo>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtFinAditivo>
        <noMatricula>string</noMatricula>
        <noCcIr>string</noCcIr>
        <noITR>string</noITR>
        <noInscrEst>string</noInscrEst>
        <noContratoJur>string</noContratoJur>
        <fgDescCCT>string</fgDescCCT>
        <mmEncerraSafra>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </mmEncerraSafra>
        <qtParcAno>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtParcAno>
        <dtInicioPg>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtInicioPg>
        <noAditivo>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </noAditivo>
        <cdIndEconReaj>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </cdIndEconReaj>
        <mmReajuste>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </mmReajuste>
        <deObs>string</deObs>
        <deBasePg>string</deBasePg>
        <qtAtrEstimado>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtAtrEstimado>
        <cdTpCalcEntrSaf>string</cdTpCalcEntrSaf>
        <vlRefPgEntrSaf>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </vlRefPgEntrSaf>
        <qtATRPgEntrSaf>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtATRPgEntrSaf>
        <cdIndEcoEntrSaf>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </cdIndEcoEntrSaf>
        <fgBonus>string</fgBonus>
        <vlReaisCCTTon>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </vlReaisCCTTon>
        <qtATRCCTTon>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtATRCCTTon>
        <cdMunicForo>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </cdMunicForo>
        <cdUFForo>string</cdUFForo>
        <qtDistTerra>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtDistTerra>
        <qtDistAsfalto>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtDistAsfalto>
        <qtDist>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtDist>
        <pcVlCanaCCTTon>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </pcVlCanaCCTTon>
        <qtDescMudas>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtDescMudas>
        <cdUpnv1Orig>string</cdUpnv1Orig>
        <dtLimRenovAutom>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtLimRenovAutom>
        <fgAcertoAnual>string</fgAcertoAnual>
        <fgProvMensal>string</fgProvMensal>
        <fgPlanejPrg>string</fgPlanejPrg>
        <fgPlanCorte>string</fgPlanCorte>
        <qtSafPlanCorte>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtSafPlanCorte>
        <cdChaveWF>string</cdChaveWF>
        <cdSafIniDivParc>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </cdSafIniDivParc>
        <fgLiminarINSS>string</fgLiminarINSS>
        <qtTchTotal>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtTchTotal>
        <qtTchPrev>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </qtTchPrev>
        <noProcJud>string</noProcJud>
        <noCodSusp>string</noCodSusp>
        <fgFormaTrib>string</fgFormaTrib>
        <deObsSituacao>string</deObsSituacao>
        <dtIniContabilizacao>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtIniContabilizacao>
        <fgPeriodoReajuste>string</fgPeriodoReajuste>
        <cdIndReajuste>string</cdIndReajuste>
        <dtReajuste>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtReajuste>
        <cdIndexador>
          <Value>decimal</Value>
          <IsNull>boolean</IsNull>
        </cdIndexador>
        <fgAmortizaPlantio>string</fgAmortizaPlantio>
        <dtCriacao>
          <Value>dateTime</Value>
          <IsNull>boolean</IsNull>
        </dtCriacao>
        <cdTransfSFAmtz>string</cdTransfSFAmtz>
      </oCONTRATO_CANA>
    </apiHTTP_PUT_CONTRATO_CANA>
  </soap:Body>
</soap:Envelope>
Family_Retorno
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <apiHTTP_PUT_CONTRATO_CANAResponse xmlns="CONTRATOS_WS">
      <apiHTTP_PUT_CONTRATO_CANAResult>string</apiHTTP_PUT_CONTRATO_CANAResult>
    </apiHTTP_PUT_CONTRATO_CANAResponse>
  </soap:Body>
</soap:Envelope>

Mensagem JSON

Family_Envio
 {
   "oCONTRATO_CANA":{
      "instancia":"string",
      "cdEmpresa":"string",
      "noContrCana":{
         "Value":"decimal"
      },
      "dtAlteracao":{
         "Value":"dateTime"
      },
      "fgTpMovto":"string",
      "nmUsuario":"string",
      "fazenda":"string",
      "fgSituacao":"string",
      "cdTpContr":"string",
      "dtAssinatura":{
         "Value":"dateTime"
      },
      "dtInicPrepSolo":{
         "Value":"dateTime"
      },
      "dtInicVigencia":{
         "Value":"dateTime"
      },
      "dtFinVigencia":{
         "Value":"dateTime"
      },
      "qtAreaTot":{
         "Value":"decimal"
      },
      "qtAreaContr":{
         "Value":"decimal"
      },
      "qtTch":{
         "Value":"decimal"
      },
      "cdTpCalcMM":"string",
      "vlRefPgMM":{
         "Value":"decimal"
      },
      "qtAtrPgMM":{
         "Value":"decimal"
      },
      "cdTpCalcAA":"string",
      "vlRefPgAA":{
         "Value":"decimal"
      },
      "qtAtrPgAA":{
         "Value":"decimal"
      },
      "dtInicPagto":{
         "Value":"dateTime"
      },
      "fgPerPg":"string",
      "ddPagto":{
         "Value":"decimal"
      },
      "noContrato":{
         "Value":"decimal"
      },
      "cdCartorio":"string",
      "fgAcertoFinal":"string",
      "fgEmisNf":"string",
      "fgRenovacao":"string",
      "qtParcela":{
         "Value":"decimal"
      },
      "cdIndEco":{
         "Value":"decimal"
      },
      "cdIndEcoAnual":{
         "Value":"decimal"
      },
      "fgFormaPg":"string",
      "vlMinimoMM":{
         "Value":"decimal"
      },
      "dtPrev1Corte":{
         "Value":"dateTime"
      },
      "qtTchPg":{
         "Value":"decimal"
      },
      "fgComplInic":"string",
      "qtRenovacao":{
         "Value":"decimal"
      },
      "cdIntERP":"string",
      "fgDDPagto":"string",
      "dtAreaContr":{
         "Value":"dateTime"
      },
      "qtAreaPrelim":{
         "Value":"decimal"
      },
      "dtAreaPrelim":{
         "Value":"dateTime"
      },
      "dtAreaTotal":{
         "Value":"dateTime"
      },
      "dtLimUtilOp":{
         "Value":"dateTime"
      },
      "dtIniOpUtil":{
         "Value":"dateTime"
      },
      "dtFinOpUtil":{
         "Value":"dateTime"
      },
      "dtIniAditivo":{
         "Value":"dateTime"
      },
      "dtFinAditivo":{
         "Value":"dateTime"
      },
      "noMatricula":"string",
      "noCcIr":"string",
      "noITR":"string",
      "noInscrEst":"string",
      "noContratoJur":"string",
      "fgDescCCT":"string",
      "mmEncerraSafra":{
         "Value":"decimal"
      },
      "qtParcAno":{
         "Value":"decimal"
      },
      "dtInicioPg":{
         "Value":"dateTime"
      },
      "noAditivo":{
         "Value":"decimal"
      },
      "cdIndEconReaj":{
         "Value":"decimal"
      },
      "mmReajuste":{
         "Value":"decimal"
      },
      "deObs":"string",
      "deBasePg":"string",
      "qtAtrEstimado":{
         "Value":"decimal"
      },
      "cdTpCalcEntrSaf":"string",
      "vlRefPgEntrSaf":{
         "Value":"decimal"
      },
      "qtATRPgEntrSaf":{
         "Value":"decimal"
      },
      "cdIndEcoEntrSaf":{
         "Value":"decimal"
      },
      "fgBonus":"string",
      "vlReaisCCTTon":{
         "Value":"decimal"
      },
      "qtATRCCTTon":{
         "Value":"decimal"
      },
      "cdMunicForo":{
         "Value":"decimal"
      },
      "cdUFForo":"string",
      "qtDistTerra":{
         "Value":"decimal"
      },
      "qtDistAsfalto":{
         "Value":"decimal"
      },
      "qtDist":{
         "Value":"decimal"
      },
      "pcVlCanaCCTTon":{
         "Value":"decimal"
      },
      "qtDescMudas":{
         "Value":"decimal"
      },
      "cdUpnv1Orig":"string",
      "dtLimRenovAutom":{
         "Value":"dateTime"
      },
      "fgAcertoAnual":"string",
      "fgProvMensal":"string",
      "fgPlanejPrg":"string",
      "fgPlanCorte":"string",
      "qtSafPlanCorte":{
         "Value":"decimal"
      },
      "cdChaveWF":"string",
      "cdSafIniDivParc":{
         "Value":"decimal"
      },
      "fgLiminarINSS":"string",
      "qtTchTotal":{
         "Value":"decimal"
      },
      "qtTchPrev":{
         "Value":"decimal"
      },
      "noProcJud":"string",
      "noCodSusp":"string",
      "fgFormaTrib":"string",
      "deObsSituacao":"string",
      "dtIniContabilizacao":{
         "Value":"dateTime"
      },
      "fgPeriodoReajuste":"string",
      "cdIndReajuste":"string",
      "dtReajuste":{
         "Value":"dateTime"
      },
      "cdIndexador":{
         "Value":"decimal"
      },
      "fgAmortizaPlantio":"string",
      "dtCriacao":{
         "Value":"dateTime"
      },
      "cdTransfSFAmtz":"string"
   }
}
Family_Retorno
{
    "d": "Sucess 200 OK"
}

Descrição Detalhada das Tags

SEGMENTOTAGSTIPOTAMANHODESCRITIVO DA TAG


Event


































































instanciaString5Instancia
cdEmpresaString5codigo da empresa
noContrCanaNumber15numero do contrato de cana
dtAlteracaoDate/Time10data alteracao
fgTpMovtoString1tipo de movimento [TAB01]
nmUsuarioString15responsavel pela alteracao
fazendaString6codigo UPNIVEL1
fgSituacao

String

1situacao contrato [TAB02]
cdTpContrString1Tipo de contrato
dtAssinaturaDate/Time10data de assinatura
dtInicPrepSoloDate/Time10data inicio preparo de solo
dtInicVigenciaDate/Time10data de iniico de vigencia
dtFinVigenciaDate/Time10data final de vigencia
qtAreaTotNumber11area total
qtAreaContrNumber11area contrato
qtTchNumber9TCH estimado
cdTpCalcMMString1tipo de calculo normal
vlRefPgMMNumber11valor referencia pagto normal
qtAtrPgMMNumber9qtde ATR pagto normal
cdTpCalcAAString1tipo de calculo final de ano
vlRefPgAANumber11valor referencia pagto final ano
qtAtrPgAANumber9qtde ATR pagto final ano
dtInicPagtoDate/Time10data inicio pagamento 
fgPerPgString1periodicidade pagamento
ddPagtoNumber2dia do pagamento
noContratoNumber7numero contrato rateio
cdCartorioString30cartorio registro
fgAcertoFinalString1acerto final de safra
fgEmisNfString1emissão notas fiscais
fgRenovacaoString1possibilidade de renovacao
qtParcelaNumber5quantidade de parcelas
cdIndEcoNumber5codigo indice economico
cdIndEcoAnualNumber5indice economico anual
fgFormaPgString1forma pagamento
vlMinimoMMNumber13valor minimo pagamento mensal
dtPrev1CorteDate/Time10data prevista primeiro corte
qtTchPgNumber13tonelada cana pagamento
fgComplInicString1indica complemento inicio de ano
qtRenovacaoNumber3quantidade de renovacao
cdIntERPString15codigo interno ERP
fgDDPagtoString1indica tipo do dia pagamento U = util C = corrido W = último dia útil.
dtAreaContrDate/Time10data area contrato
qtAreaPrelimNumber11area preliminar
dtAreaPrelimDate/Time10data area preliminar
dtAreaTotalDate/Time10data area total
dtLimUtilOpDate/Time10data limite opção renovacao
dtIniOpUtilDate/Time10data inicio utilização opção
dtFinOpUtilDate/Time10data final utilizacao opção
dtIniAditivoDate/Time10data inicio aditivo
dtFinAditivoDate/Time10data final aditivo
noMatriculaString100numero da matricula
noCcIrString15numero CC / IR
noITRString15numero ITR
noInscrEstString18inscricao estadual
noContratoJurString20numero contrato juridico
fgDescCCTString1Desconta CCT
mmEncerraSafraNumber2Mês encerramento safra
qtParcAnoNumber2Qtde parcelas ano
dtInicioPgDate/Time10Mês/Ano início pagto
noAditivoNumber3numero do aditivo
cdIndEconReajNumber5Índice de correção
mmReajusteNumber2Mês de reajuste
deObsString200Observação
deBasePgString50Base de pagamento
qtAtrEstimadoNumber9Atr por tonelada estimado
cdTpCalcEntrSafString1Tipo de calculo Entre Safra
vlRefPgEntrSafNumber11Valor referencia Entre Safra
qtATRPgEntrSafNumber9Qtde Atr Entre Safra
cdIndEcoEntrSafNumber5Índice economico Entre Safra
fgBonusString1Bônus
vlReaisCCTTonNumber7Fixação do Preço de CCT por Tonelada
qtATRCCTTonNumber7Fixação do Preço de CCT em ATR
cdMunicForoNumber4Cidade Foro
cdUFForoString2Estado Foro
qtDistTerraNumber4Distancia de unidade moedora - Terra
qtDistAsfaltoNumber4Distancia de unidade moedora - Asfalto
qtDistNumber4Distancia de unidade moedora
pcVlCanaCCTTonNumber5CCT em percentual sobre valor da cana
qtDescMudasNumber15Quantidade desconto mudas
cdUpnv1OrigString6Upnivel1 Origem
dtLimRenovAutomDate/Time10Data Limite de Renovação Automática
fgAcertoAnualString1Acerto anual -> S - Tem acerto, N - Não tem acerto 
fgProvMensalString1Flag Identificador de Provisão
fgPlanejPrgString1Flag planejamento de prorrogação
fgPlanCorteString1Flag de Planejamento Parc com Ano Corte
qtSafPlanCorteNumber2Qtde de Safras de Ano Corte
cdChaveWFString25Código chave workflow
cdSafIniDivParcNumber5Safra inicial para divisão das parcelas
fgLiminarINSSString1Flag de liminar para suspensçao da cobrança de ICMS (S=Sim - N=Não)
qtTchTotalNumber13Toneladas de cana TOTAL a pagar por safra
qtTchPrevNumber13Toneladas por Hectares Previsto de Pagto
noProcJudString50Numero do processo judicial quando liminar de INSS aplicado ao contrato
noCodSuspString14Numero do codigo de suspensão INSS - Liminar
fgFormaTribString1Flag controlador da forma de tributação INSS - Liminar
deObsSituacaoString500Observação da situação
dtIniContabilizacaoDate/Time10Data Início de Contabilização
fgPeriodoReajusteString1Flag para periodo de reajuste
cdIndReajusteString2Códio do Indice de reajuste
dtReajusteDate/Time10Data de Reajuste
cdIndexadorNumber3Código do Indexador
fgAmortizaPlantioString1Amortização por plantio
dtCriacaoDate/Time10Data de criação do Contrato
cdTransfSFAmtzString30Codigo de transferência de saldo para amortização





  • Sem rótulos