Sign in
Contracts

Create contract

Create a new contract based on a given set of transactions.

post/rest/contracts

Parameters

#/paths/~1auth~1user/post/parameters/0 — unresolved $ref

Request body

payment_frequencyPaymentFrequency required— unresolved $ref
transaction_idsSchema[] required— unresolved $ref

The transactions which should be part of the new contract.

Limitations:

  • Currently only one transaction can be provided.
  • The transactions must not already be associated with another contract.

Response

Contract details.

idSchema required— unresolved $ref
account_idSchema required— unresolved $ref
is_activeboolean required

Status of the contract. A contract is considered active if at least one corresponding payment has been observed in the last two payment periods.

payment_frequencyPaymentFrequency required— unresolved $ref
categoriesItems[] required— unresolved $ref

Categories attached to the contract.

is_recognizedboolean required

Indicates if the contract has been automatically derived from the transaction history. All user provided contracts initially have a value of false.

last_paid_atEndedAt required— unresolved $ref
modified_atstring date-time required

Entity modification timestamp.

created_atCreatedAt required— unresolved $ref