Produto: | Datasul |
Ocorrência: | Documentação de API REST |
| Nome Físico | accountPayableDocument |
Tem como objetivo viabilizar integração\estorno\cancelamento de títulos através de api Rest.
Inclusão de Documentos:
POST - Criar lote de títulos. Deve ser enviada requisição POST na ROTA https://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableBatch passando o JSON com as informações do lote de títulos.
Se o registro for criado com sucesso, irá retornar status 200, caso ocorrer erros, será retornado status 400 ou 500 e o JSON com as mensagens de erro.
Path Params: podem ser passados dois parâmetros separados por ponto e vírgula (;) na url: Matriz de Tradução (utilizada para traduzir os campos _ext) e indicador atualização do lote (indica se atualiza o lote de implantação ou deixa pendente, valores possíveis: yes ou no). Exemplo:
https://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableBatch/ems2;yes
A Matriz de Tradução é obrigatória apenas se foi informado algum dos atributos do JSON que terminam com _ext.
Caso não for informado o indicador de atualização do lote, o lote será atualizado.
| 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 |