Atenção: O endpoint de títulos vencidos acessado pela url
/v1/titulos_vencidosestá depreciado. Novas homologações devem ser realizadas na versão 2(/v1/titulos). A versão 1 não receberá mais atualizações e com o tempo deixará de ser suportada
Obs.: Títulos vencidos excluídos não serão exibidos em tela para o usuário.
Estrutura de Retorno do GET
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único do título. |
| numero_documento | String: 18 | Número de documento do título. Ex: "123456789012/123" |
| valor | Double | Valor do título. Valor máximo suportado: 9999999.99 |
| data_vencimento | Date | Data de vencimento do título. Ex: 2015-11-22 |
| data_pagamento | Date | Data de pagamento do título. Ex: 2015-11-22 |
| observacao | String | Observação do título. |
| cliente_id | Integer | ID do cliente associado ao título. |
| pedido_id | Integer | ID do pedido associado ao título. |
| excluido | Boolean | Indica se o título está excluído. |
| link_pdf | String | URL do arquivo PDF referente ao título. |
| ultima_alteracao | DateTime | Data e hora da última modificação deste título no Mercos. |
Parâmetros do JSON de Envio de Títulos Vencidos
| Campo | Tipo | Descrição |
|---|---|---|
| numero_documento (obrigatório) | String: 18 | Número de documento do título. Ex: "123456789012/123" |
| valor (obrigatório) | Double | Valor do título. Valor máximo suportado: 9999999.99 |
| data_vencimento (obrigatório) | Date | Data de vencimento do título. Ex: 2015-11-22 |
| data_pagamento | Date | Data de pagamento do título. Ex: 2015-11-22 |
| observacao | String | Observação do título. |
| cliente_id (obrigatório) | Integer | ID do cliente associado ao título. |
| pedido_id | Integer | ID do pedido associado ao título. |
| link_pdf | String | URL do arquivo PDF referente ao título. Caso link_pdf e arquivo_pdf sejam enviados simultaneamente, apenas link_pdf será considerado. |
| arquivo_pdf | String | String base 64 do arquivo PDF codificado. Ex: "JVBERi0...". O arquivo será armazenado e o link de acesso salvo no campo link_pdf. Tamanho máximo codificado: 2.5MB. |
| excluido | Boolean | Indica se o título está excluído. |
Atualização de Títulos sem Informar o ID na URL
Na atualização de títulos (método PUT), não é necessário informar o ID do título na URL: PUT https://app.mercos.com/api/v1/titulos_vencidos/<ID>
Há a possibilidade de atualizar o título omitindo o ID na url e informando os campos cliente_id e numero_documento no corpo da requisição http.
Desta forma, a API buscará o título pelo cliente e número do documento, e efetuará a atualização dos dados enviados.