Skip to content

Commit

Permalink
HubSoft updated postman_doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hubsoftbrasil committed Nov 24, 2022
1 parent c4ff480 commit e7dd63d
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions Postman Collections/postman_doc.json
Original file line number Diff line number Diff line change
Expand Up @@ -1447,6 +1447,15 @@
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id_cliente_servico\":13579,\n \"id_tipo_servico\":2,\n \"descricao\":\"ADICIONAL\",\n \"parcelado\":false,\n \"proximo_faturamento\":true,\n \"tipo\":\"acrescimo\",\n \"valor\":10.3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": "{{url}}/api/v1/integracao/financeiro/evento_faturamento",
"description": "**POST**\n\nAtravés deste `endpoint`, será possível fazer o cadastro de evento de faturamento. Pode ser cadastrado um evento de Acréscimo ou Desconto, permitindo também parcelamento.\n\n**Aviso**\n\n`IMPORTANTE`: É necessário informar o `id_cliente_servico` e o `id_tipo_servico,` ambos retornados nas rotas Clientes > Consulta e Tipo de Serviço > All respectivamente\n\n`IMPORTANTE 2:` Ao enviar a o parâmetro parcelado como true, os parâmetros `numero_total_parcelas`, `mes_primeira_parcela` e `ano_primeira_parcela` tornam-se obrigatórios\n\n`IMPORTANTE 3`: Ao enviar a o parâmetro parcelado como false, o parâmetro `proximo_faturamento` torna-se obrigatório. Caso ele seja enviado como false, os parâmetros `mes_processar` e `ano_processar` também deverão ser enviados\n\n**Atributos da Requisição**\n\n| Atributo | Descrição | Obrigatório |\n| --- | --- | --- |\n| id_cliente_servico | Identificador único do serviço do cliente | Sim |\n| id_tipo_servico | Identificador único do tipo de serviço | Sim |\n| tipo | Textual (aceita os valores acrescimo e desconto). | Sim |\n| descricao | Descrição textual para o evento. | Sim |\n| valor | Campo númerico (aceita valor decimal separado por ponto. Ex.: 10.2). | Sim |\n| parcelado | Boolean para identificar se o evento é parcelado ou não | Sim |\n| numero_total_parcelas | Valor maior que 0 para identificar o total de parcelas | Sim (Se parcelado = true) |\n| mes_primeira_parcela | Valor inteiro que representa o mês do ano (Dezembro = 12). Utilizado para verificar o mês da primeira parcela | Sim (Se parcelado = true) |\n| ano_primeira_parcela | Valor inteiro que representa o ano. Utilizado para verificar o ano da primeira parcela | Sim (Se parcelado = true) |\n| proximo_faturamento | Boolean para identificar se o evento será lançado no próximo faturamento | Sim (Se parcelado = false) |\n| mes_processar | Valor inteiro que representa o mês do ano (Dezembro = 12). Utilizado para verificar o mês de processamento do faturamento | Sim (Se proximo_faturamento = false) |\n| ano_processar | Valor inteiro que representa o ano. Utilizado para verificar o ano de processamento do faturamento | Sim (Se proximo_faturamento = false) |\n\nOs atributos podem conter os seguintes valores:\n\n| Atributo | Descrição | Valor Default |\n| --- | --- | --- |\n| id_cliente_servico | Deve conter um número inteiro maior que 0 | Nenhum |\n| id_tipo_servico | Deve conter um número inteiro maior que 0 | Nenhum |\n| tipo | Textual | Nenhum |\n| descricao | Textual | Nenhum |\n| valor | Número Inteiro/Decimal | Nenhum |\n| parcelado | Boolean | Nenhum |\n| numero_total_parcelas | Número Inteiro | Nenhum |\n| mes_primeira_parcela | Número Inteiro (maior que 0 e menor que 13) | Nenhum |\n| ano_primeira_parcela | Número Inteiro | Nenhum |\n| proximo_faturamento | Boolean | Nenhum |\n| mes_processar | Número Inteiro (maior que 0 e menor que 13) | Nenhum |\n| ano_processar | Número Inteiro | Nenhum |"
},
Expand Down Expand Up @@ -3251,37 +3260,37 @@
],
"variable": [
{
"id": "6c78505a-0c33-4730-a0f4-dd5a2dfd8dab",
"id": "4ceae231-1cd0-48f0-8c74-adfcd156f6dd",
"key": "url",
"value": ""
},
{
"id": "bc5fb710-334f-4ed5-87f7-f68db6be32e7",
"id": "a8d93918-3087-4aae-92f5-cb37a0b874ab",
"key": "client_id",
"value": ""
},
{
"id": "e73ad261-0c3f-41b8-bcef-7fd42d37fe91",
"id": "8a9e0b78-b8b7-44ad-bf3b-5be67f05a0d6",
"key": "client_secret",
"value": ""
},
{
"id": "3c812ec1-f99a-4828-96fd-714fd64a9edd",
"id": "f40d9e61-2007-4334-95af-3757de2c8d67",
"key": "username",
"value": ""
},
{
"id": "e3495e03-7f7b-4f9b-8f33-e9124ae7fab6",
"id": "baee0ba4-4ca0-4687-adea-8b4d11401fac",
"key": "password",
"value": ""
},
{
"id": "138a0390-be2d-4360-b29c-7b753769e84d",
"id": "cbdfe508-cc5e-4280-aa66-1778ae1805d5",
"key": "grant_type",
"value": ""
},
{
"id": "ee25b314-782f-45f2-9b8d-a66300ba2843",
"id": "b823fb3c-fcab-43b7-8e13-3899f663fee0",
"key": "access_token",
"value": ""
}
Expand Down

0 comments on commit e7dd63d

Please sign in to comment.