QWqwist
Contracts

Create contract

Changed on

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

post/rest/contracts

Request

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)
payment_partner0 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_atModifiedAt required(unresolved $ref)
created_atCreatedAt required(unresolved $ref)

Changes

  • 398592d93b1fRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • breaking

      the / request property type changed from no type to string

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to string, and format from no format to ISO 4217:2015 for status

    • warning

      added the new half-yearly enum value to the response property for the response status

    • warning

      added the new monthly enum value to the response property for the response status

    • warning

      added the new quarterly enum value to the response property for the response status

    • warning

      added the new yearly enum value to the response property for the response status

    • info

      added the new half-yearly enum value to the request property

    • info

      added the new monthly enum value to the request property

    • info

      added the new quarterly enum value to the request property

    • info

      added the new yearly enum value to the request property

    • info

      the response's property default value EUR was added for the status