Jun 26, 2023

Nesta atualização da API, foram removidas várias propriedades relacionadas a juros e multas em faturas nos endpoints de Empresas, Configurações e Produtos. Além disso, a propriedade 'x-stoplight' foi removida em diversos endpoints, incluindo Itens de Fatura, Empréstimos e Inquilinos. Novos recursos foram adicionados, como a capacidade de repetir passos em Esteira, pesquisar parcelas e obter credenciais de cliente em Sessões. Além disso, agora é possível adicionar a propriedade 'customerDocument' no requestBody do endpoint de Ofertas em Produtos.

Companies
  • GET /v1/companies/{id}:
    • 200 response: removed settings.invoices.payOff.interest.amount.default
    • 200 response: removed settings.invoices.payOff.fine.amount.default
    • 200 response: removed settings.invoices.companyRecurring.interest.amount.default
    • 200 response: removed settings.invoices.companyRecurring.fine.amount.default
  • POST /v1/companies/{id}:
    • 200 response: removed settings.invoices.payOff.interest.amount.default
    • 200 response: removed settings.invoices.payOff.fine.amount.default
    • 200 response: removed settings.invoices.companyRecurring.interest.amount.default
    • 200 response: removed settings.invoices.companyRecurring.fine.amount.default
    • requestBody: removed settings.invoices.payOff.interest.amount.default
    • requestBody: removed settings.invoices.payOff.fine.amount.default
    • requestBody: removed settings.invoices.companyRecurring.interest.amount.default
    • requestBody: removed settings.invoices.companyRecurring.fine.amount.default
  • GET /v1/companies:
    • 200 response: removed data.items.settings.invoices.payOff.interest.amount.default
    • 200 response: removed data.items.settings.invoices.payOff.fine.amount.default
    • 200 response: removed data.items.settings.invoices.companyRecurring.interest.amount.default
    • 200 response: removed data.items.settings.invoices.companyRecurring.fine.amount.default
  • POST /v1/companies:
    • 201 response: removed settings.invoices.payOff.interest.amount.default
    • 201 response: removed settings.invoices.payOff.fine.amount.default
    • 201 response: removed settings.invoices.companyRecurring.interest.amount.default
    • 201 response: removed settings.invoices.companyRecurring.fine.amount.default
    • requestBody: removed settings.invoices.payOff.interest.amount.default
    • requestBody: removed settings.invoices.payOff.fine.amount.default
    • requestBody: removed settings.invoices.companyRecurring.interest.amount.default
    • requestBody: removed settings.invoices.companyRecurring.fine.amount.default
Configurações
  • GET /v1/settings:
    • 200 response: removed invoices.payOff.interest.amount.default
    • 200 response: removed invoices.payOff.fine.amount.default
    • 200 response: removed invoices.customerRecurring.interest.amount.default
    • 200 response: removed invoices.customerRecurring.fine.amount.default
    • 200 response: removed invoices.companyRecurring.interest.amount.default
    • 200 response: removed invoices.companyRecurring.fine.amount.default
  • POST /v1/settings:
    • 200 response: removed invoices.payOff.interest.amount.default
    • 200 response: removed invoices.payOff.fine.amount.default
    • 200 response: removed invoices.customerRecurring.interest.amount.default
    • 200 response: removed invoices.customerRecurring.fine.amount.default
    • 200 response: removed invoices.companyRecurring.interest.amount.default
    • 200 response: removed invoices.companyRecurring.fine.amount.default
    • requestBody: removed invoices.payOff.interest.amount.default
    • requestBody: removed invoices.payOff.fine.amount.default
    • requestBody: removed invoices.customerRecurring.interest.amount.default
    • requestBody: removed invoices.customerRecurring.fine.amount.default
    • requestBody: removed invoices.companyRecurring.interest.amount.default
    • requestBody: removed invoices.companyRecurring.fine.amount.default
Esteira
  • POST /v1/steps/{step}/retry: added
Installments
  • GET /v1/installments/search: added

  • POST /v1/installments/{installment}/mark-uncollectible:

    • 200 response: removed transactions.data.items.x-stoplight
  • POST /v1/installments/{installment}/void:

    • 200 response: removed transactions.data.items.x-stoplight
  • GET /v1/installments/{installment}:

    • 200 response: removed transactions.data.items.x-stoplight
  • GET /v1/installments:

    • 200 response: removed data.items.transactions.data.items.x-stoplight
  • POST /v1/installments:

    • 200 response: removed transactions.data.items.x-stoplight
    • requestBody: removed transactions.data.items.x-stoplight
Invoice
  • POST /v1/invoices/{invoice}/finalize:
    • 200 response: removed invoiceItems.data.items.x-stoplight
  • GET /v1/invoices/{invoice}/invoice-items/{invoice_item}:
    • 200 response: removed x-stoplight
  • GET /v1/invoices/{invoice}/invoice-items:
    • 200 response: removed data.items.x-stoplight
  • POST /v1/invoices/{invoice}/invoice-items:
    • 201 response: removed x-stoplight
  • POST /v1/invoices/{invoice}/mark-uncollectible:
    • 200 response: removed invoiceItems.data.items.x-stoplight
  • POST /v1/invoices/{invoice}/void:
    • 200 response: removed invoiceItems.data.items.x-stoplight
  • GET /v1/invoices/{invoice}:
    • 200 response: removed invoiceItems.data.items.x-stoplight
  • POST /v1/invoices/{invoice}:
    • 200 response: removed invoiceItems.data.items.x-stoplight
  • GET /v1/invoices:
    • 200 response: removed invoiceItems.data.items.x-stoplight
  • POST /v1/invoices:
    • 201 response: removed invoiceItems.data.items.x-stoplight
    • requestBody: removed items.items.x-stoplight
Invoice Items
  • GET /v1/invoice-items/{invoice_item}:
    • 200 response: removed x-stoplight
  • GET /v1/invoice-items:
    • 200 response: removed data.items.x-stoplight
  • POST /v1/invoice-items:
    • 201 response: removed x-stoplight
Loans
  • POST /v1/loans/search:
    • 200 response: removed data.items.x-stoplight
  • POST /v1/loans/{loan}/attach:
    • 200 response: removed x-stoplight
  • POST /v1/loans/{loan}/cancel:
    • 200 response: removed x-stoplight
  • POST /v1/loans/{loan}/disburse:
    • 200 response: removed x-stoplight
  • GET /v1/loans/{loan}/installments:
    • 200 response: removed data.items.transactions.data.items.x-stoplight
  • POST /v1/loans/{loan}/installments:
    • 200 response: removed transactions.data.items.x-stoplight
    • requestBody: removed transactions.data.items.x-stoplight
  • POST /v1/loans/{loan}/mark-expired:
    • 200 response: removed x-stoplight
  • POST /v1/loans/{loan}/mark-pending:
    • 200 response: removed x-stoplight
  • POST /v1/loans/{loan}/open:
    • 200 response: removed x-stoplight
  • POST /v1/loans/{loan}/transactions:
    • 200 response: removed x-stoplight
  • POST /v1/loans/{loan}/void:
    • 200 response: removed x-stoplight
  • GET /v1/loans/{loan}:
    • 200 response: removed x-stoplight
  • POST /v1/loans/{loan}:
    • 200 response: removed x-stoplight
  • GET /v1/loans:
    • 200 response: removed data.items.x-stoplight
  • POST /v1/loans:
    • 201 response: removed x-stoplight
Products
  • POST /v1/products/{product}/offers:
    • requestBody: added support for customerDocument property
  • GET /v1/products/{product}:
    • 200 response: removed settings.invoices.payOff.interest.amount.default
    • 200 response: removed settings.invoices.payOff.fine.amount.default
  • POST /v1/products/{product}:
    • 200 response: removed settings.invoices.payOff.interest.amount.default
    • 200 response: removed settings.invoices.payOff.fine.amount.default
    • requestBody: removed settings.invoices.payOff.interest.amount.default
    • requestBody: removed settings.invoices.payOff.fine.amount.default
  • GET /v1/products:
    • 200 response: removed data.items.settings.invoices.payOff.interest.amount.default
    • 200 response: removed data.items.settings.invoices.payOff.fine.amount.default
  • POST /v1/products:
    • 200 response: removed settings.invoices.payOff.interest.amount.default
    • 200 response: removed settings.invoices.payOff.fine.amount.default
    • requestBody: removed settings.invoices.payOff.interest.amount.default
    • requestBody: removed settings.invoices.payOff.fine.amount.default
Sessions
  • GET /v1/sessions/customer/credential: added
Tenants
  • GET /v1/tenants/branding/themes/{theme}:
    • 200 response: removed x-stoplight
  • POST /v1/tenants/branding/themes/{theme}:
    • 200 response: removed x-stoplight
    • requestBody: removed x-stoplight