Histórico da Página
...
Tem como objetivo viabilizar integração\estorno\cancelamento de títulos através de api Rest.
Passo a Passo
Importante: Os endpoints abaixo permitem informar vários registros no Payload, porém é indicado que não sejam enviados um alto volume de registros em uma única requisição, pois a API é síncrona. Por isto, caso ocorra demora na efetivação das informações no Contas a Pagar, devido a uma grande quantidade de registros, a requisição pode apresentar problema de time-out do servidor. Não é possível indicar um número ideal de registros, pois depende das parametrizações de cada ambiente, como por exemplo se a informação está parametrizada para integrar com outros módulos: Fluxo de Caixa, Caixa e Bancos, etc. Caso haja necessidade de inclusão de um alto volume de registros o indicado é executar várias requisições com poucos registros.
| Função | Criar lote de implantação de título |
|---|---|
| Verbo | POST |
| URL | https://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableBatch |
| Path Param | Incluir os parâmetros separados por ponto e vírgula (;) após a URL. Exemplo: https://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableBatch/ems2;yes 1 - Matriz de Tradução: utilizada para traduzir os atributos terminados em _ext, caso estes atributos não sejam informados não é necessário informar. 2 - Indicador atualização do lote: indica se atualiza o lote de implantação ou deixa pendente, valores possíveis: yes ou no. Caso não for informado o indicador de atualização do lote, o lote será atualizado. |
| Payload | Enviar JSON conforme exemplos abaixo: |
...