Contracts

PATCH /contracts/{uuid}/receivables/bulk-edit

Request

  • Base URL
    https://api.kolek.com.br (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

uuidstring required

The unique identifier of the contract.

Request body

filter_type'all_pending' | 'to_be_due' required

Filter type to select which receivables to edit

receivable_idsstring[]

Specific receivable UUIDs to edit. If provided, filter_type is ignored.

issued_daynumber

Day of the month for issued date (1-31)

due_daynumber

Day of the month for due date (1-31)

discountnumber

Discount value (percentage or absolute based on discount_code)

discount_codenumber

Discount type: 0 = percentage, 1 = absolute value

late_feenumber

Late fee value (percentage or absolute based on late_fee_code)

late_fee_codenumber

Late fee type: 0 = percentage, 1 = absolute value

interestnumber

Interest value (percentage per month or absolute per day based on interest_code)

interest_codenumber

Interest type: 0 = percentage per month, 1 = absolute value per day

replace_line_itemsboolean

If true, replaces all line items. If false, appends to existing.

edited_bystring required

User ID who is making the edit

Response

Successfully updated receivables in bulk.

Changes

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