Na entidade de Títulos são armazenadas as faturas de cada cliente. Essas informações são utilizadas para:
- Apresentar a 2ª via de boleto no e-commerce B2B, o título só será exibido no e-commerce se for enviado o
link_pdfouarquivo_pdfna integração; - Para clientes Mercos Pay, os dados de segunda via estarão disponíveis automaticamente no e-commerce;
- Ajudar o vendedor a entender os títulos pendentes de cada cliente.
Obs.: Títulos excluídos não serão exibidos em tela para o usuário.
Estrutura da Resposta (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”. |
| numero_parcela | Integer | Número da parcela do título. Ex: 4 |
| 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: 300 | 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. |
| origem | String | Tipos de origem dos títulos: 'MERCOS_PAY', 'INTEGRACAO' ou 'ONLINE' |
| ultima_alteracao | DateTime | Data e hora da última modificação deste título no Mercos. |
Parâmetros de Envio (POST / PUT)
| 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 |
| numero_parcela | Integer | Número da parcela do título. Ex: 4 |
| 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: 300 | 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 sejam enviados link_pdf e arquivo_pdf, apenas link_pdf será considerado). |
| arquivo_pdf | String | String base 64 do arquivo PDF codificado referente ao título. Ex.: "JVBERi0...". O arquivo será armazenado e o link de acesso será salvo no campo "link_pdf" do título. 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, ex:
PUT https://app.mercos.com/api/v1/titulos/<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.