Contracts
ERP

Create A New Contract

Create contract

post/v1/contracts

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/contracts
  • Auth: API key in header X-Imobzi-Secret

Request body

categorystring nullable

Category of the contract. Required for create

subcategorystring nullable

Subcategory of the contract. Required for create

codestring nullable

Contract code

field_valuesobject[] nullable

Fields and their values associated with the contract

contract_typestring

Contract type. Required for create

created_atstring nullable

Created at contract

current_installmentinteger nullable

Current installment number of the contract

daily_valuenumber nullable

Daily value for the contract

due_daystring nullable

Due day for the contract payments. Required for create

billing_mode'normal' | 'early'

Billing mode for the contract

descriptionstring nullable

Description for the contract

durationinteger

Time duration for the contract

duration_typestring

Duration type for the contract

end_atstring nullable

End date of the contract. Required for create

fine_chargeboolean nullable

Define if contract has fine charge

fine_percent_late_paymentnumber nullable

Percentage of fine applied in case of late payment

has_invoiceboolean nullable

Check if the contract has an invoice

include_in_dimobboolean nullable

Define if the contract is included in DIMOB (Declaração de Imposto de Renda de Pessoa Física)

indeterminateboolean nullable

Define if the contract is indeterminate time

initial_valuenumber nullable

Contract initial value

invoice_descriptionstring nullable

Description for the invoice

in_progressboolean

Define if the contract is in progress

interest_chargeboolean nullable

Define if contract has interest charge

interest_percent_late_paymentnumber nullable

Percentage of interest applied in case of late payment

invoice_items_valuenumber nullable

Total value of invoice items related to the contract

irrfboolean nullable

Define if the contract has IRRF (Imposto de Renda Retido na Fonte)

last_annual_readjustment_atstring date nullable

Last date of annual readjustment for the contract

monthly_valuenumber

Monthly value for the contract, if not contract sale

next_invoicestring nullable

Next invoice

next_invoice_due_datestring nullable

Next due date for the invoice. Required for create

next_invoice_end_atstring date nullable

Next invoice end at date. Required for create

next_invoice_generate_instring nullable

Next invoice generate date, usually due date -10 days. Required for create

next_invoice_start_atstring date nullable

Next invoice start at date. Required for create

next_invoice_valuenumber nullable

Next invoice value. Required for create

nota_fiscalboolean nullable

Indicate if the contract generates a nota fiscal (invoice)

propertyobject nullable

Property related to the contract, if for sale

proportional_in_next_invoiceboolean nullable

Define if the next invoice has proportional value

send_nota_fiscal_in_invoice_createboolean nullable

Indicate if the nota fiscal should be sent when the invoice is created

sourcestring nullable

Source of the contract

start_atstring nullable

Start at date of the contract. Required for create

status'active' | 'ended' | 'suspended' | 'in_review' | 'in_progress' | 'traveling'

Current contract status

updated_atstring nullable

Last date the contract was updated

valuenumber

Value for the contract

credit_card_percentagenumber nullable

Percentage charged for credit card transactions

credit_card_installment_percentagenumber nullable

Percentage charged for installment payments via credit card

credit_card_pass_on_fixed_rateboolean nullable

Indicates whether the fixed card fee will be passed on to the customer

credit_card_pass_on_installments_feeboolean nullable

Defines whether the interest on card installments will be passed on

credit_card_auto_chargeboolean nullable

Defines whether invoices are charged automatically on the due date using the card the payer marked for automatic debit

payment_maximum_installmentsinteger nullable

Maximum number of installments allowed for the contract

Example request

{
  "contacts": [
    {
      "type": "person if has CPF"
    }
  ],
  "contract_type": "sale",
  "billing_mode": "normal",
  "items": [
    {
      "action": "create",
      "behavior": "charge_tenant",
      "item_type": "lease_value",
      "contact": {
        "type": "person if has CPF"
      }
    }
  ],
  "source": "imobzi",
  "status": "active"
}

Response

Successful Response

db_idstring required

ID intern of the contract in database

codestring required

Contract code

db_keystring required

Contract key

Changes

No recorded changes to this operation across all 1 revision of this API.