Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Os serviços estão disponíveis apenas em XML.

Os Headers aceitos As propriedades aceitas no Header são:

HeaderDescriçãoConteúdo válido
LEGALDESKIdentifica se a chamada foi feita pelo LegalDesk.
Conteúdo padrão: FALSE
'TRUE' ou 'FALSE'
TENANTIDIdentifica a empresa e filial do título.Empresa, Filial (Ex: T1,M SP 01 )
FIELDEMPTYIdentifica se o XML de resposta vai retornar os campos vazios. Conteúdo padrão: FALSE'TRUE' ou 'FALSE'

Obs.: Nessa essa API não são aceitas propriedades diferentes das listadas acima, como por exemplo as propriedades existentes no FWRestModel. 

02. DEFINIÇÕES DE SERVIÇOS

...

Exibe os dados do título a pagar e seus desdobramentos.

Parâmetro:

{key} - Chave do Registro de Título a Pagar (E2_FILIAL+E2_PREFIXO+E2_NUM+E2_PARCELA+E2_TIPO+E2_FORNECE+E2_LOJA) em base 64

...

Exemplo URL de Requsição: http://localhost:9000/JurRESTCP/TSBTUCAwMSBKQk1KQk1BQkMgICA0IEJPTEpCTTAwMTAx

Bloco de código
languagejava
themeMidnight
titleRequest Header XML
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/xml

...

Bloco de código
languagexml
themeMidnight
titleResponse XML
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
<result>
    <resources>
        <JUR-CP pk='TSBTUCAwMSBQRlNQRlNUSVQgICAxIEJPTEZPUk5FQzAx'>
            <SE2MODEL>
                <E2_FILIAL>M SP 01</E2_FILIAL>
                <E2_PREFIXO>PFS</E2_PREFIXO>
                <E2_NUM>PFSTIT</E2_NUM>
                <E2_PARCELA>1</E2_PARCELA>
                <E2_TIPO>BOL</E2_TIPO>
                <E2_NATUREZ>03.020.001</E2_NATUREZ>
                <E2_PORTADO></E2_PORTADO>
                <E2_FORNECE>FORNEC</E2_FORNECE>
                <E2_LOJA>01</E2_LOJA>
                <E2_NOMFOR>Fornecedor</E2_NOMFOR>
                <E2_EMISSAO>20240209</E2_EMISSAO>
                <E2_VENCTO>20240209</E2_VENCTO>
                <E2_VENCREA>20240209</E2_VENCREA>
                <E2_VALOR>360</E2_VALOR>
                <E2_EMIS1>20240223</E2_EMIS1>
                <E2_HIST>Histórico</E2_HIST>
                <E2_SALDO>360</E2_SALDO>
                <E2_VENCORI>20240209</E2_VENCORI>
                <E2_MOEDA>1</E2_MOEDA>
                <E2_RATEIO>N</E2_RATEIO>
                <E2_VLCRUZ>360</E2_VLCRUZ>
                <E2_OCORREN>01</E2_OCORREN>
                <E2_ORIGEM>JURCTORC</E2_ORIGEM>
                <E2_FLUXO>S</E2_FLUXO>
                <E2_DESDOBR>N</E2_DESDOBR>
                <E2_MULTNAT>2</E2_MULTNAT>
                <E2_PROJPMS>2</E2_PROJPMS>
                <E2_DIRF>2</E2_DIRF>
                <E2_MODSPB>1</E2_MODSPB>
                <E2_FILORIG>M SP 01</E2_FILORIG>
                <E2_BASEPIS>360</E2_BASEPIS>
                <E2_BASECSL>360</E2_BASECSL>
                <E2_MDRTISS>1</E2_MDRTISS>
                <E2_FRETISS>1</E2_FRETISS>
                <E2_APLVLMN>1</E2_APLVLMN>
                <E2_TRETISS>2</E2_TRETISS>
                <E2_BASEISS>360</E2_BASEISS>
                <E2_FORBCO>033</E2_FORBCO>
                <E2_FORAGE>4268</E2_FORAGE>
                <E2_FORCTA>01061119</E2_FORCTA>
                <E2_BASEIRF>360</E2_BASEIRF>
                <E2_BASECOF>360</E2_BASECOF>
                <E2_TEMDOCS>2</E2_TEMDOCS>
                <E2_STATLIB>01</E2_STATLIB>
                <E2_DATAAGE>20240209</E2_DATAAGE>
                <E2_BASEINS>360</E2_BASEINS>
                <E2_MSIDENT>0000001844</E2_MSIDENT>
                <E2_TPDESC>C</E2_TPDESC>
            </SE2MODEL>
            <OHFDETAIL>
                <itens>
                    <item internalId='886' deleted='0'>
                        <OHF_FILIAL>M SP 01</OHF_FILIAL>
                        <OHF_IDDOC>69EFD6C15AD24E118E43AC5AFC593E3F</OHF_IDDOC>
                        <OHF_CITEM>0001</OHF_CITEM>
                        <OHF_CNATUR>03.020.001</OHF_CNATUR>
                        <OHF_VALOR>360</OHF_VALOR>
                        <OHF_CPART>000015</OHF_CPART>
                        <OHF_CCLIEN>CLIENT</OHF_CCLIEN>
                        <OHF_CLOJA>01</OHF_CLOJA>
                        <OHF_CCASO>002200</OHF_CCASO>
                        <OHF_CTPDSP>0001</OHF_CTPDSP>
                        <OHF_QTDDSP>1</OHF_QTDDSP>
                        <OHF_DTDESP>20240223</OHF_DTDESP>
                        <OHF_COBRA>1</OHF_COBRA>
                        <OHF_HISTOR>Histórico</OHF_HISTOR>
                        <OHF_CDESP>00001511</OHF_CDESP>
                        <OHF_DTINCL>20240223</OHF_DTINCL>
                        <OHF_CODLD>0000000000000</OHF_CODLD>
                    </item>
                </itens>
            </OHFDETAIL>
        </JUR-CP>
    </resources>
</result>


c. PUT- JurRESTCP/{key}

Realiza a alteração de dados do título a pagar e de seus desdobramentos e exibe esses dados.

Também é possível incluir ou excluir novos desdobramentos ou desdobramentos pós-pagamento (conforme as regras e validações do sistema).

Parâmetro:

{key} - Chave do Registro de Título a Pagar (E2_FILIAL+E2_PREFIXO+E2_NUM+E2_PARCELA+E2_TIPO+E2_FORNECE+E2_LOJA) em base 64

...

.


Bloco de código
languagejava
themeMidnight
titleRequest Header XML
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/xml

...

Bloco de código
languagexml
themeMidnight
titleResponse XML
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
<result>
    <resources>
        <JUR-CP pk='TSBTUCAwMSBQRlNQRlNUSVQgICAxIEJPTEZPUk5FQzAx'>
            <SE2MODEL>
                <E2_FILIAL>M SP 01</E2_FILIAL>
                <E2_PREFIXO>PFS</E2_PREFIXO>
                <E2_NUM>PFSTIT</E2_NUM>
                <E2_PARCELA>2</E2_PARCELA>
                <E2_TIPO>BOL</E2_TIPO>
                <E2_NATUREZ>06.020.001</E2_NATUREZ>
                <E2_PORTADO></E2_PORTADO>
                <E2_FORNECE>FORNEC</E2_FORNECE>
                <E2_LOJA>01</E2_LOJA>
                <E2_NOMFOR>Fornecedor</E2_NOMFOR>
                <E2_EMISSAO>20240209</E2_EMISSAO>
                <E2_VENCTO>20240209</E2_VENCTO>
                <E2_VENCREA>20240209</E2_VENCREA>
                <E2_VALOR>360</E2_VALOR>
                <E2_EMIS1>20240223</E2_EMIS1>
                <E2_HIST>Histórico</E2_HIST>
                <E2_SALDO>360</E2_SALDO>
                <E2_VENCORI>20240209</E2_VENCORI>
                <E2_MOEDA>1</E2_MOEDA>
                <E2_RATEIO>N</E2_RATEIO>
                <E2_VLCRUZ>360</E2_VLCRUZ>
                <E2_OCORREN>01</E2_OCORREN>
                <E2_ORIGEM>JURCTORC</E2_ORIGEM>
                <E2_FLUXO>S</E2_FLUXO>
                <E2_DESDOBR>N</E2_DESDOBR>
                <E2_MULTNAT>2</E2_MULTNAT>
                <E2_PROJPMS>2</E2_PROJPMS>
                <E2_DIRF>2</E2_DIRF>
                <E2_MODSPB>1</E2_MODSPB>
                <E2_FILORIG>M SP 01</E2_FILORIG>
                <E2_BASEPIS>360</E2_BASEPIS>
                <E2_BASECSL>360</E2_BASECSL>
                <E2_MDRTISS>1</E2_MDRTISS>
                <E2_FRETISS>1</E2_FRETISS>
                <E2_APLVLMN>1</E2_APLVLMN>
                <E2_TRETISS>2</E2_TRETISS>
                <E2_BASEISS>360</E2_BASEISS>
                <E2_FORBCO>033</E2_FORBCO>
                <E2_FORAGE>4268</E2_FORAGE>
                <E2_FORCTA>01061119</E2_FORCTA>
                <E2_BASEIRF>360</E2_BASEIRF>
                <E2_BASECOF>360</E2_BASECOF>
                <E2_TEMDOCS>2</E2_TEMDOCS>
                <E2_STATLIB>01</E2_STATLIB>
                <E2_DATAAGE>20240209</E2_DATAAGE>
                <E2_BASEINS>360</E2_BASEINS>
                <E2_MSIDENT>0000001844</E2_MSIDENT>
                <E2_TPDESC>C</E2_TPDESC>
            </SE2MODEL>
            <OHFDETAIL>
                <itens>
                    <item internalId='886' deleted='0'>
                        <OHF_FILIAL>M SP 01</OHF_FILIAL>
                        <OHF_IDDOC>69EFD6C15AD24E118E43AC5AFC593E3F</OHF_IDDOC>
                        <OHF_CITEM>0001</OHF_CITEM>
                        <OHF_CNATUR>03.020.001</OHF_CNATUR>
                        <OHF_VALOR>360</OHF_VALOR>
                        <OHF_CPART>000015</OHF_CPART>
                        <OHF_CCLIEN>CLIENT</OHF_CCLIEN>
                        <OHF_CLOJA>01</OHF_CLOJA>
                        <OHF_CCASO>002200</OHF_CCASO>
                        <OHF_CTPDSP>0001</OHF_CTPDSP>
                        <OHF_QTDDSP>1</OHF_QTDDSP>
                        <OHF_DTDESP>20240223</OHF_DTDESP>
                        <OHF_COBRA>1</OHF_COBRA>
                        <OHF_HISTOR>Histórico</OHF_HISTOR>
                        <OHF_CDESP>00001511</OHF_CDESP>
                        <OHF_DTINCL>20240223</OHF_DTINCL>
                        <OHF_CODLD>0000000000000</OHF_CODLD>
                    </item>
                </itens>
            </OHFDETAIL>
			<OHGDETAIL>
                <itens>
                    <item internalId='1' deleted='0'>
                        <OHG_FILIAL>M SP 01</OHG_FILIAL>
                        <OHG_IDDOC>E4F797012F834E11BE38AC5AFC593E3F</OHG_IDDOC>
                        <OHG_CITEM>0001</OHG_CITEM>
                        <OHG_CNATUR>03.010.003</OHG_CNATUR>
                        <OHG_VALOR>45</OHG_VALOR>
                        <OHG_CPART2>000015</OHG_CPART2>
                        <OHG_HISTOR>.</OHG_HISTOR>
                        <OHG_DTINCL>20240223</OHG_DTINCL>
                        <OHG_DTCONT>20240223</OHG_DTCONT>
                    </item>
                    <item internalId='3' deleted='0'>
                        <OHG_FILIAL>M SP 01</OHG_FILIAL>
                        <OHG_IDDOC>E4F797012F834E11BE38AC5AFC593E3F</OHG_IDDOC>
                        <OHG_CITEM>0002</OHG_CITEM>
                        <OHG_CNATUR>03.010.001</OHG_CNATUR>
                		<OHG_VALOR>55</OHG_VALOR>
                		<OHG_CPART>000008</OHG_CPART>
                		<OHG_CESCR>00001</OHG_CESCR>
                		<OHG_CCUSTO>102010</OHG_CCUSTO>
                		<OHG_CHISTP>0001</OHG_CHISTP>
                    </item>
                </itens>
            </OHGDETAIL>
        </JUR-CP>
    </resources>
</result>

d. DELETE- JurRESTCP/{key}

Realiza a exclusão de dados do título a pagar e de seus desdobramentos.

Parâmetro:

{key} - Chave do Registro de Título a Pagar (E2_FILIAL+E2_PREFIXO+E2_NUM+E2_PARCELA+E2_TIPO+E2_FORNECE+E2_LOJAem base 64

...

.


Bloco de código
languagejava
themeMidnight
titleRequest Header XML
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/xml

...