Apr 4, 2023

Esta atualização da API inclui diversas alterações nos endpoints relacionados a clientes, empregos, fundos, faturas, empréstimos, intenções de pagamento e inquilinos. As mudanças mais comuns são alterações na descrição do parâmetro de consulta 'expand'. No entanto, há também várias alterações nas respostas e corpos de solicitação, como a adição do suporte para novas propriedades, a remoção do suporte para propriedades antigas e a alteração nos tipos de dados de algumas propriedades. Além disso, alguns valores foram adicionados ou removidos de determinados enums. Por fim, o endpoint 'settings' dos inquilinos agora suporta a propriedade 'documents'.

Customers
  • GET /v1/customers/search:
    • expand query parameter: changed description
  • DELETE /v1/customers/{id}:
    • expand query parameter: changed description
  • GET /v1/customers/{id}:
    • expand query parameter: changed description
  • POST /v1/customers/{id}:
    • expand query parameter: changed description
  • GET /v1/customers:
    • expand query parameter: changed description
  • POST /v1/customers:
    • expand query parameter: changed description
Employments
  • GET /v1/employments/search:
    • expand query parameter: changed description
  • DELETE /v1/employments/{id}:
    • expand query parameter: changed description
  • GET /v1/employments/{id}:
    • expand query parameter: changed description
  • GET /v1/employments:
    • expand query parameter: changed description
  • POST /v1/employments:
    • expand query parameter: changed description
Fundos
  • DELETE /v1/funds/{fund}:
    • expand query parameter: changed description
  • GET /v1/funds/{fund}:
    • expand query parameter: changed description
  • POST /v1/funds/{fund}:
    • expand query parameter: changed description
  • GET /v1/funds:
    • expand query parameter: changed description
  • POST /v1/funds:
    • expand query parameter: changed description
Invoice
  • POST /v1/invoices/{invoice}/finalize:
    • expand query parameter: changed description
  • DELETE /v1/invoices/{invoice}/invoice-items/{invoice_item}:
    • expand query parameter: changed description
  • GET /v1/invoices/{invoice}/invoice-items/{invoice_item}:
    • expand query parameter: changed description
  • GET /v1/invoices/{invoice}/invoice-items:
    • expand query parameter: changed description
  • POST /v1/invoices/{invoice}/invoice-items:
    • expand query parameter: changed description
  • POST /v1/invoices/{invoice}/mark-uncollectible:
    • expand query parameter: changed description
  • GET /v1/invoices/{invoice}/payment-intents/{payment_intent}:
    • 200 response: changed methodData.title
    • 200 response: methodData.guarantor is no longer required
    • 200 response: methodData.provider is now required
    • 200 response: removed support for methodData.guarantor property
    • 200 response: removed support for methodData.id property
    • 200 response: removed support for methodData.status property
    • 200 response: added support for methodData.externalId property
    • 200 response: added support for methodData.provider property
    • 200 response: changed methodData.type.default
    • 200 response: removed methodData.customer
    • 200 response: removed methodData.customer.required
    • 200 response: changed methodData.customer.type to string
    • 200 response: removed support for value kobana from enum method
    • 200 response: added support for new value boleto on enum method
    • expand query parameter: changed description
  • GET /v1/invoices/{invoice}/payment-intents:
    • 200 response: changed data.items.methodData.title
    • 200 response: data.items.methodData.guarantor is no longer required
    • 200 response: data.items.methodData.provider is now required
    • 200 response: removed support for data.items.methodData.guarantor property
    • 200 response: removed support for data.items.methodData.id property
    • 200 response: removed support for data.items.methodData.status property
    • 200 response: added support for data.items.methodData.externalId property
    • 200 response: added support for data.items.methodData.provider property
    • 200 response: changed data.items.methodData.type.default
    • 200 response: removed data.items.methodData.customer
    • 200 response: removed data.items.methodData.customer.required
    • 200 response: changed data.items.methodData.customer.type to string
    • 200 response: removed support for value kobana from enum data.items.method
    • 200 response: added support for new value boleto on enum data.items.method
    • expand query parameter: changed description
  • POST /v1/invoices/{invoice}/payment-intents:
    • 201 response: changed methodData.title
    • 201 response: methodData.guarantor is no longer required
    • 201 response: methodData.provider is now required
    • 201 response: removed support for methodData.guarantor property
    • 201 response: removed support for methodData.id property
    • 201 response: removed support for methodData.status property
    • 201 response: added support for methodData.externalId property
    • 201 response: added support for methodData.provider property
    • 201 response: changed methodData.type.default
    • 201 response: removed methodData.customer
    • 201 response: removed methodData.customer.required
    • 201 response: changed methodData.customer.type to string
    • 201 response: removed support for value kobana from enum method
    • 201 response: added support for new value boleto on enum method
    • requestBody: changed methodData.title
    • requestBody: methodData.guarantor is no longer required
    • requestBody: methodData.provider is now required
    • requestBody: removed support for methodData.guarantor property
    • requestBody: added support for methodData.provider property
    • requestBody: changed methodData.type.default
    • requestBody: removed methodData.customer
    • requestBody: removed methodData.customer.required
    • requestBody: changed methodData.customer.type to string
    • requestBody: removed support for value kobana from enum method
    • requestBody: added support for new value boleto on enum method
    • expand query parameter: changed description
  • POST /v1/invoices/{invoice}/void:
    • expand query parameter: changed description
  • DELETE /v1/invoices/{invoice}:
    • expand query parameter: changed description
  • GET /v1/invoices/{invoice}:
    • expand query parameter: changed description
  • POST /v1/invoices/{invoice}:
    • expand query parameter: changed description
  • GET /v1/invoices:
    • expand query parameter: changed description
  • POST /v1/invoices:
    • expand query parameter: changed description
Loans
  • GET /v1/loans/{loan}/installments:
    • 200 response: added support for data.items.amountForPayment property
    • added payment_for query parameter
  • POST /v1/loans/{loan}/installments:
    • 200 response: added support for amountForPayment property
    • requestBody: added support for amountForPayment property
    • added payment_for query parameter
Payment Intents
  • POST /v1/payment-intents/{payment_intent}/pay:
    • expand query parameter: changed description
  • POST /v1/payment-intents/{payment_intent}/void:
    • expand query parameter: changed description
  • GET /v1/payment-intents/{payment_intent}:
    • expand query parameter: changed description
  • GET /v1/payment-intents:
    • expand query parameter: changed description
  • POST /v1/payment-intents:
    • expand query parameter: changed description
Tenants
  • GET /v1/tenants/settings/{section}:
    • 200 response: added support for documents property
  • POST /v1/tenants/settings:
    • 200 response: added support for documents property
    • requestBody: added support for documents property