Histórico da Página
01. DADOS GERAIS
| Produto: |
| ||||
|---|---|---|---|---|---|
| Linha de Produto: |
| ||||
| Segmento: |
| ||||
| Módulo: |
| ||||
| Função: | InsertAd - API inclusão de AD/AP | ||||
| País: | Brasil | ||||
| Ticket: | 13963990 | ||||
| Requisito/Story/Issue (informe o requisito relacionado) : | DMANFINLGX-22015 |
02. SITUAÇÃO/REQUISITO
Criação da API de inclusão de AD/AP de forma automática, permitindo integração com outros sistemas.
03. SOLUÇÃO
- Verbo: POST ({{host}}/api/supply/v1/ad)
- Campos de entrada que deverão ser enviados no JSON de envio: se o campo não for obrigatório, enviar a TAG nula ou conforme descrito abaixo:
Tags utilizadas no arquivo Json para inserir os dados.
Tags
| Descrição | Definição | Obr? | Observação |
CodCompany | cod_empresa – Código da empresa | Char(02) | S | Conforme cadastro no Logix |
ExpenseAppropriation | num_ad – Número da AD | Number(06) | N | Numeração gerada no Logix |
CodExpenseType | cod_tip_despesa – Código do tipo de despesa | Number(04) | S | Conforme cadastro no Logix |
InvoiceSeries | ser_nf – Série da Nota Fiscal | Char(03) | N | Se não informado, será assumido o valor 0 |
InvoiceSubSeries | ssr_nf – Sub-série da Nota Fiscal | Number(2) | N | Se não informado, será assumido o valor 0 |
InvoiceNumber | num_nf – Número da Nota Fiscal | Char(20) | N | |
InvoiceIssueDate | dat_emis_nf – Data de emissão da Nota Fiscal | Date | S | |
InvoiceReceiptDate | dat_rec_nf – Data de recebimento da Nota Fiscal | Date | S | |
CodCompanyEstablishment | cod_empresa_estab – Código da Empresa Estabelecimento | Char(02) | N | |
MonthYearCompetence | mes_ano_compet – Mês e ano da competência | Number (4) | N | MMAA |
SupplierOrderNumber | num_ord_forn – Número da ordem Fornecedor | Number (6) | N | |
PaymentCondition | cnd_pgto – Condição de pagamento | Number (3) | S | Conforme cadastro no Logix. Se informada a data de vencimento. a condição de pagamento não é obrigatória. |
DueDate | dat_venc – Data de vencimento | Date | S | Se informada a condição de pagamento, a data de vencimento não é obrigatória. |
SupplierCode | cod_fornecedor – Código do fornecedor | Char (15) | S | Conforme cadastro no Logix |
CarrierCode | Cod_portador – Código do portador | Number (3) | N | Conforme cadastro no Logix |
TotalAmountInvoice | val_tot_nf – Valor total da Nota Fiscal | Decimal (15,2) | S | |
BalanceValueAd | val_saldo_ad – Valor saldo da AD | Decimal (15,2) | S | |
CurrencyCode | cod_moeda – Código da Moeda | Number (2) | S | Conforme cadastro no Logix |
ApplicationSector | set_aplicacao | Number (4) | N | |
PaymentBatchCode | cod_lote_pgto – Código lote de pagamento | Number (4) | S | |
Observation | Observ – Observação | Char (40) | N | |
TypeCodeAd | cod_tip_ad – Código do tipo da AD | Number (2) | S | Conforme cadastro do Logix |
AutomaticStatusAp | ies_ap_autom – Situação AP automática | Char (01) | S | S / N |
IntegrateSituationSC | ies_sup_cap – Situação integrada SUP CAP | Char (01) | S | S / N |
InvoiceStatus | ies_fatura – Situação da fatura | Char (01) | S | |
AdIndicatorsCounts | ies_ad_cont - | Char (01) | S | |
TransferBatchNumber | num_lote_transf – Número do lote de transferência | Number (3) | S | |
AccountDepositIndicator | ies_dep_cred | Char (01) | S | |
LotNumber | num_lote_pat – Número do lote | Number (3) | ||
OriginCompanyCode | cod_empresa_orig – Código da empresa de origem | Char (02) | S | |
TypeInvoice | esp_nota_fiscal – Espécie da Nota Fiscal | Char (03) | S | |
ReceiptNotice | aviso_recebto – Número do aviso de recebimento | Number (6) | N | |
Branch | filial – Filial | Number (10) | N | |
BuyerName | nom_comprador – Nome do Comprador | Char (30) | N | |
CurrencyQuoteRule | Regra_cotacao_moeda – Regra da cotação da moeda | Char(01) | N | P - ‘Padrão’, F – ‘Fixada’, 1 - ‘D-1’, 2 – ‘D-2’, 3 – ‘D-3’, 4 – ‘D-4’, 5 – ‘D-5’ |
CurrencyQuote | Cotacao_moeda – Cotação da moeda | Number(18,9) | N | |
ListOfRequestCnt | Lista de Contas | Lista | ||
ListOfCntCtb | Lista de Contas Contábeis | Lista | ||
LedgerAccountNumber | Num_conta_ctb – Número da conta contábil | Char(23) | N | Conforme cadastro do Logix |
ListOfAen | Lista de Área e Linha de Negócio | Lista | ||
BusinessAreaCode | Cod_area_negocio – Código da área de negócio | Char(03) | S | Conforme cadastro do Logix |
BusinessLineCode | Cod_lin_negocio – Código da linha de negócio | Char(04) | S | Conforme cadastro do Logix |
AenValueItem | ||||
AenValue | ||||
ProductLineCode | Cod_lin_prod – Código da linha de produto | Number(2) | S | Conforme cadastro do Logix |
RevenueLineCode | Cod_lin_recei – Código da linha de receita | Number(2) | S | Conforme cadastro do Logix |
IndustrySegmentCode | Cod_seg_merc – Código do segmento de mercado | Number(2) | N | Conforme cadastro do Logix |
UsageClassCode | Cod_clas_uso – Código da classe de uso | Number(2) | N | Conforme cadastro do Logix |
ListOfRequestItem | ||||
ListItem | Lista de itens | |||
ItemCode | cod_item – Código do Item | Char (15) | S | Conforme cadastro do Logix |
ItemDenomination | den_item – Denominação do Item | Char (50) | S | Conforme cadastro do Logix |
ItemQuantity | qtd_item – Quantidade do item | Number (12,3) | S | |
ItemValue | val_item – Valor do Item | Number (17,2) | S | |
ListOfRequestVal | ||||
ListOfTypeVal | Lista de tipo de valores | |||
SequenceNumber | Number(2) | N | Número sequencial dos tipos de valores informados no arquivo | |
CodeTypeValue | cod_tip_val – Código do tipo de valor | Number(3) | N | Código do tipo de valor dos impostos não obrigatórios da AD |
Modelo do arquivo de post do Json que deve ser montado:
{
"CompanyId":"",
"ExpenseAppropriation":"",
"CodExpenseType":"",
"InvoiceSeries":"",
"InvoicesSubSeries":"",
"InvoiceNumber":"",
"InvoiceIssueDate":"//",
"InvoiceReceiptDate":"//",
"CodCompanyEstablishment":"",
"MonthYearCompetence":"",
"SupplierOrderNumber":"",
"PaymentCondition":" ",
"DueDate":"//",
"SupplierCode":"",
"CarrierCode":"",
"TotalAmountInvoice":"",
"BalanceValueAd":"",
"CurrencyCode":"",
"ApplicationSector":" ",
"PaymentBatchCode":"",
"Observation":"",
"TypeCodeAd":"",
"AutomaticStatusAp":"",
"IntegrateSituationSC":"",
"InvoiceStatus":"",
"AdIndicatorCounts":"",
"TransferBatchNumber":"",
"AccountDepositIndicator":"",
"LoteNumber":"",
"OriginCompanyCode":"",
"TypeInvoice":"",
"ReceiptNotice":"",
"Branch":"",
"BuyerName":"",
"CurrencyQuoteRule":"",
"CurrencyQuote":"",
"ListOfRequestCnt":{
"ListOfCntCtb": [
{
"LedgerAccountNumber":"",
"ListOfAen": [
{
"BusinessAreaCode":"",
"BusinessLineCode":"",
"AenValueItem":"",
"AenValue":"",
"ProductLineCode":"",
"RevenueLineCode":"",
"IndustrySegmentCode":"",
"UsageClassCode":""
} ,
{
"BusinessAreaCode":"",
"BusinessLineCode":"",
"AenValueItem":"",
"AenValue":"",
"ProductLineCode":"",
"RevenueLineCode":"",
"IndustrySegmentCode":"",
"UsageClassCode":""
}
]
} ,
{
"LedgerAccountNumber":"",
"ListOfAen": [
{
"BusinessAreaCode":"",
"BusinessLineCode":"",
"AenValueItem":"",
"AenValue":"",
"ProductLineCode":"",
"RevenueLineCode":"",
"IndustrySegmentCode":"",
"UsageClassCode":""
} ,
{
"BusinessAreaCode":"",
"BusinessLineCode":"",
"AenValueItem":"",
"AenValue":"",
"ProductLineCode":"",
"RevenueLineCode":"",
"IndustrySegmentCode":"",
"UsageClassCode":""
}
]
}
]
},
"ListOfRequestItem":{
"ListItem": [
{
"ItemCode":"",
"ItemDenomination":"",
"ItemQuantity":"",
"ItemValue":""
}
]
},
"ListOfRequestVal":{
"ListOfTypeVal": [
{
"SequenceNumber":"",
"CodeTypeValue":""
}
]
}
}
Exemplo Json de retorno (Ok)
{
"code": "200",
"Mensagem": "Inclusão da AD efetuada com sucesso.",
"CompanyId": " ", - Código da empresa
"Number": " " - Número da AD criada.
}
Exemplo Json de retorno (Erro)
{
"code": "400",
"message": "Problema na inclusão dos dados",
"detailMessage": " Mensagem do ERP descrevendo o erro."
}
| Informações | ||
|---|---|---|
| ||
A API na versão atual não contempla as seguintes funcionalidades:
|
- Detalhes de como habilitar o serviço de API’s podem ser consultadas em: https://tdn.totvs.com/pages/viewpage.action?pageId=185747842
| Templatedocumentos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas