POST {folder}/GrupoEmpresaSAP/{token}/{colecao}/{campo}/{orderBy}/{pageSize}/{pageNumber}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| token | string |
Default value is auth |
|
| colecao | integer |
None. |
|
| campo | integer |
None. |
|
| orderBy | integer |
None. |
|
| pageSize | integer |
None. |
|
| pageNumber | integer |
None. |
|
| folder | string |
None. |
Body Parameters
GrupoEmpresaSAPInsertModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CdGrupo | integer |
None. |
|
| DsSAPHost | string |
Required String length: inclusive between 0 and 100 |
|
| DsSAPUsername | string |
Required String length: inclusive between 0 and 30 |
|
| DsSAPPassword | string |
Required Data type: Password String length: inclusive between 0 and 30 |
|
| DsSAPDatabase | string |
Required String length: inclusive between 0 and 30 |
|
| DsSAPDatabaseUsername | string |
Required String length: inclusive between 0 and 30 |
|
| DsSAPDatabasePassword | string |
Required Data type: Password String length: inclusive between 0 and 30 |
|
| CdSAPConsumidor | string |
Required String length: inclusive between 0 and 20 |
|
| CdSAPCondicaoPagamento | integer |
None. |
|
| NrSAPLicenseServerPort | integer |
None. |
|
| NrSAPDatabaseVersion | byte |
None. |
|
| FlAtivo | boolean |
None. |
|
| CdSAPContaCaixa | string |
Required String length: inclusive between 0 and 20 |
|
| CdSAPContaCheque | string |
String length: inclusive between 0 and 20 |
|
| NrSAPVersaoDIAPI | string |
Required String length: inclusive between 0 and 10 |
|
| CdSAPFormaPagamentoDebito | integer |
None. |
|
| CdSAPFormaPagamentoCredito | integer |
None. |
|
| CdSAPFormaPagamentoVoucher | integer |
None. |
|
| DsUrlJoeSAP | string |
Required String length: inclusive between 0 and 40 |
|
| NrModeloNota | integer |
None. |
|
| CdVendedorSAP | integer |
None. |
|
| FlFecharNotaComDiferenca | boolean |
None. |
|
| CdSAPContaCreditosAIdentificar | string |
Required String length: inclusive between 0 and 20 |
|
| CdSAPContaDeposito | string |
String length: inclusive between 0 and 20 |
|
| FlParceiroNegocioCliente | boolean |
None. |
|
| FlNotaUnica | boolean |
None. |
|
| VlToleranciaDiferencaPagamentos | decimal number |
None. |
|
| FlNotaUnicaPagamentoMaior | boolean |
None. |
|
| FlCriaPedido | boolean |
None. |
|
| DtInicioIntegralizacao | date |
Data type: Date |
|
| FlFiscalContabil2 | boolean |
None. |
|
| CdSAPContaSobraFaltaTransitoria | string |
String length: inclusive between 0 and 20 |
|
| CdSAPContaDescontosTransitoria | string |
String length: inclusive between 0 and 20 |
Request Formats
application/json, text/json
Sample:
{
"CdGrupo": 1,
"DsSAPHost": "sample string 2",
"DsSAPUsername": "sample string 3",
"DsSAPPassword": "sample string 4",
"DsSAPDatabase": "sample string 5",
"DsSAPDatabaseUsername": "sample string 6",
"DsSAPDatabasePassword": "sample string 7",
"CdSAPConsumidor": "sample string 8",
"CdSAPCondicaoPagamento": 9,
"NrSAPLicenseServerPort": 10,
"NrSAPDatabaseVersion": 64,
"FlAtivo": true,
"CdSAPContaCaixa": "sample string 13",
"CdSAPContaCheque": "sample string 14",
"NrSAPVersaoDIAPI": "sample string 15",
"CdSAPFormaPagamentoDebito": 1,
"CdSAPFormaPagamentoCredito": 1,
"CdSAPFormaPagamentoVoucher": 1,
"DsUrlJoeSAP": "sample string 16",
"NrModeloNota": 17,
"CdVendedorSAP": 18,
"FlFecharNotaComDiferenca": true,
"CdSAPContaCreditosAIdentificar": "sample string 20",
"CdSAPContaDeposito": "sample string 21",
"FlParceiroNegocioCliente": true,
"FlNotaUnica": true,
"VlToleranciaDiferencaPagamentos": 24.0,
"FlNotaUnicaPagamentoMaior": true,
"FlCriaPedido": true,
"DtInicioIntegralizacao": "2025-12-16T01:45:16.8876947-03:00",
"FlFiscalContabil2": true,
"CdSAPContaSobraFaltaTransitoria": "sample string 28",
"CdSAPContaDescontosTransitoria": "sample string 29"
}
application/xml, text/xml
Sample:
<GrupoEmpresaSAPInsertModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api_Integracao.Models"> <CdGrupo>1</CdGrupo> <CdSAPCondicaoPagamento>9</CdSAPCondicaoPagamento> <CdSAPConsumidor>sample string 8</CdSAPConsumidor> <CdSAPContaCaixa>sample string 13</CdSAPContaCaixa> <CdSAPContaCheque>sample string 14</CdSAPContaCheque> <CdSAPContaCreditosAIdentificar>sample string 20</CdSAPContaCreditosAIdentificar> <CdSAPContaDeposito>sample string 21</CdSAPContaDeposito> <CdSAPContaDescontosTransitoria>sample string 29</CdSAPContaDescontosTransitoria> <CdSAPContaSobraFaltaTransitoria>sample string 28</CdSAPContaSobraFaltaTransitoria> <CdSAPFormaPagamentoCredito>1</CdSAPFormaPagamentoCredito> <CdSAPFormaPagamentoDebito>1</CdSAPFormaPagamentoDebito> <CdSAPFormaPagamentoVoucher>1</CdSAPFormaPagamentoVoucher> <CdVendedorSAP>18</CdVendedorSAP> <DsSAPDatabase>sample string 5</DsSAPDatabase> <DsSAPDatabasePassword>sample string 7</DsSAPDatabasePassword> <DsSAPDatabaseUsername>sample string 6</DsSAPDatabaseUsername> <DsSAPHost>sample string 2</DsSAPHost> <DsSAPPassword>sample string 4</DsSAPPassword> <DsSAPUsername>sample string 3</DsSAPUsername> <DsUrlJoeSAP>sample string 16</DsUrlJoeSAP> <DtInicioIntegralizacao>2025-12-16T01:45:16.8876947-03:00</DtInicioIntegralizacao> <FlAtivo>true</FlAtivo> <FlCriaPedido>true</FlCriaPedido> <FlFecharNotaComDiferenca>true</FlFecharNotaComDiferenca> <FlFiscalContabil2>true</FlFiscalContabil2> <FlNotaUnica>true</FlNotaUnica> <FlNotaUnicaPagamentoMaior>true</FlNotaUnicaPagamentoMaior> <FlParceiroNegocioCliente>true</FlParceiroNegocioCliente> <NrModeloNota>17</NrModeloNota> <NrSAPDatabaseVersion>64</NrSAPDatabaseVersion> <NrSAPLicenseServerPort>10</NrSAPLicenseServerPort> <NrSAPVersaoDIAPI>sample string 15</NrSAPVersaoDIAPI> <VlToleranciaDiferencaPagamentos>24</VlToleranciaDiferencaPagamentos> </GrupoEmpresaSAPInsertModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GrupoEmpresaSAP| Name | Description | Type | Additional information |
|---|---|---|---|
| CdGrupo | integer |
None. |
|
| DsNome | string |
String length: inclusive between 0 and 255 |
|
| DsSAPHost | string |
Required String length: inclusive between 0 and 100 |
|
| DsSAPUsername | string |
Required String length: inclusive between 0 and 30 |
|
| DsSAPPassword | string |
Required Data type: Password String length: inclusive between 0 and 30 |
|
| DsSAPDatabase | string |
Required String length: inclusive between 0 and 30 |
|
| DsSAPDatabaseUsername | string |
Required String length: inclusive between 0 and 30 |
|
| DsSAPDatabasePassword | string |
Required Data type: Password String length: inclusive between 0 and 30 |
|
| CdSAPConsumidor | string |
Required String length: inclusive between 0 and 20 |
|
| CdSAPCondicaoPagamento | integer |
None. |
|
| NrSAPLicenseServerPort | integer |
None. |
|
| NrSAPDatabaseVersion | byte |
None. |
|
| FlAtivo | boolean |
None. |
|
| CdSAPContaCaixa | string |
Required String length: inclusive between 0 and 20 |
|
| CdSAPContaCheque | string |
String length: inclusive between 0 and 20 |
|
| NrSAPVersaoDIAPI | string |
Required String length: inclusive between 0 and 10 |
|
| CdSAPFormaPagamentoDebito | integer |
None. |
|
| CdSAPFormaPagamentoCredito | integer |
None. |
|
| CdSAPFormaPagamentoVoucher | integer |
None. |
|
| DsUrlJoeSAP | string |
Required String length: inclusive between 0 and 40 |
|
| NrModeloNota | integer |
None. |
|
| CdVendedorSAP | integer |
None. |
|
| FlFecharNotaComDiferenca | boolean |
None. |
|
| CdSAPContaCreditosAIdentificar | string |
Required String length: inclusive between 0 and 20 |
|
| CdSAPContaDeposito | string |
String length: inclusive between 0 and 20 |
|
| FlParceiroNegocioCliente | boolean |
None. |
|
| FlNotaUnica | boolean |
None. |
|
| VlToleranciaDiferencaPagamentos | decimal number |
None. |
|
| FlNotaUnicaPagamentoMaior | boolean |
None. |
|
| FlCriaPedido | boolean |
None. |
|
| DtInicioIntegralizacao | date |
Data type: Date |
|
| FlFiscalContabil2 | boolean |
None. |
|
| CdSAPContaSobraFaltaTransitoria | string |
String length: inclusive between 0 and 20 |
|
| CdSAPContaDescontosTransitoria | string |
String length: inclusive between 0 and 20 |
Response Formats
application/json, text/json
Sample:
{
"CdGrupo": 1,
"DsNome": "sample string 2",
"DsSAPHost": "sample string 3",
"DsSAPUsername": "sample string 4",
"DsSAPPassword": "sample string 5",
"DsSAPDatabase": "sample string 6",
"DsSAPDatabaseUsername": "sample string 7",
"DsSAPDatabasePassword": "sample string 8",
"CdSAPConsumidor": "sample string 9",
"CdSAPCondicaoPagamento": 10,
"NrSAPLicenseServerPort": 11,
"NrSAPDatabaseVersion": 64,
"FlAtivo": true,
"CdSAPContaCaixa": "sample string 14",
"CdSAPContaCheque": "sample string 15",
"NrSAPVersaoDIAPI": "sample string 16",
"CdSAPFormaPagamentoDebito": 1,
"CdSAPFormaPagamentoCredito": 1,
"CdSAPFormaPagamentoVoucher": 1,
"DsUrlJoeSAP": "sample string 17",
"NrModeloNota": 18,
"CdVendedorSAP": 19,
"FlFecharNotaComDiferenca": true,
"CdSAPContaCreditosAIdentificar": "sample string 21",
"CdSAPContaDeposito": "sample string 22",
"FlParceiroNegocioCliente": true,
"FlNotaUnica": true,
"VlToleranciaDiferencaPagamentos": 25.0,
"FlNotaUnicaPagamentoMaior": true,
"FlCriaPedido": true,
"DtInicioIntegralizacao": "2025-12-16T01:45:16.9147006-03:00",
"FlFiscalContabil2": true,
"CdSAPContaSobraFaltaTransitoria": "sample string 29",
"CdSAPContaDescontosTransitoria": "sample string 30"
}
application/xml, text/xml
Sample:
<GrupoEmpresaSAP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api_Integracao.Models"> <CdGrupo>1</CdGrupo> <CdSAPCondicaoPagamento>10</CdSAPCondicaoPagamento> <CdSAPConsumidor>sample string 9</CdSAPConsumidor> <CdSAPContaCaixa>sample string 14</CdSAPContaCaixa> <CdSAPContaCheque>sample string 15</CdSAPContaCheque> <CdSAPContaCreditosAIdentificar>sample string 21</CdSAPContaCreditosAIdentificar> <CdSAPContaDeposito>sample string 22</CdSAPContaDeposito> <CdSAPContaDescontosTransitoria>sample string 30</CdSAPContaDescontosTransitoria> <CdSAPContaSobraFaltaTransitoria>sample string 29</CdSAPContaSobraFaltaTransitoria> <CdSAPFormaPagamentoCredito>1</CdSAPFormaPagamentoCredito> <CdSAPFormaPagamentoDebito>1</CdSAPFormaPagamentoDebito> <CdSAPFormaPagamentoVoucher>1</CdSAPFormaPagamentoVoucher> <CdVendedorSAP>19</CdVendedorSAP> <DsNome>sample string 2</DsNome> <DsSAPDatabase>sample string 6</DsSAPDatabase> <DsSAPDatabasePassword>sample string 8</DsSAPDatabasePassword> <DsSAPDatabaseUsername>sample string 7</DsSAPDatabaseUsername> <DsSAPHost>sample string 3</DsSAPHost> <DsSAPPassword>sample string 5</DsSAPPassword> <DsSAPUsername>sample string 4</DsSAPUsername> <DsUrlJoeSAP>sample string 17</DsUrlJoeSAP> <DtInicioIntegralizacao>2025-12-16T01:45:16.9147006-03:00</DtInicioIntegralizacao> <FlAtivo>true</FlAtivo> <FlCriaPedido>true</FlCriaPedido> <FlFecharNotaComDiferenca>true</FlFecharNotaComDiferenca> <FlFiscalContabil2>true</FlFiscalContabil2> <FlNotaUnica>true</FlNotaUnica> <FlNotaUnicaPagamentoMaior>true</FlNotaUnicaPagamentoMaior> <FlParceiroNegocioCliente>true</FlParceiroNegocioCliente> <NrModeloNota>18</NrModeloNota> <NrSAPDatabaseVersion>64</NrSAPDatabaseVersion> <NrSAPLicenseServerPort>11</NrSAPLicenseServerPort> <NrSAPVersaoDIAPI>sample string 16</NrSAPVersaoDIAPI> <VlToleranciaDiferencaPagamentos>25</VlToleranciaDiferencaPagamentos> </GrupoEmpresaSAP>