Add

[POST] .../v1/docpayment/add

Creates a new payment document. Use this method to create an income or expense payment before it is posted with DocPayment/Perform. The operation returns new_id, validates required references, amount, description length, category direction, payment type, optional custom fields, tariff availability and account overdraft rules for outgoing payments. attached_user_id is optional; when it is omitted or 0, the current request user is assigned. exchange_rate is optional: base-currency payments use 1, non-base payments use the provided positive rate or the current currency rate. The required permission is selected by the category direction: incoming categories require income-add permission, outgoing categories require outcome-add permission. Business errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
amount Decimal Required Required payment amount. Must be greater than 0 and supports up to 3 decimal places.
attached_user_id Int64 Optional Responsible user ID. If omitted or 0, the current request user is used.
category_id Int64 Required Required income or expense category ID. The category direction selects income or outcome permissions.
contract_id Int64 Optional Optional contract document ID.
date Int64 Required Required document date as Unix time in seconds.
description String Optional Optional additional description. Maximum length is 300 characters.
document Int64 Optional Optional ID of the document used as the payment basis.
document_type_id Int64 Optional Optional ID of the document type used as the payment basis.
exchange_rate Decimal Optional Optional exchange rate for non-base currency payments. If omitted or 0, the current currency exchange rate is used; base-currency payments use 1.
fields Array of FieldValueAdd Optional Optional custom field values. Required custom fields for payment documents must be supplied when configured.
firm_id Int64 Required Required ID of the company participating in the payment.
partner_id Int64 Required Required partner ID.
type_id Int64 Required Required payment type ID. The payment type determines the account and currency used by the payment.

Request Example

{
  "date": 1714550400,
  "type_id": 3,
  "document": 101,
  "document_type_id": 7,
  "firm_id": 2,
  "partner_id": 15,
  "category_id": 3,
  "contract_id": 12,
  "amount": 2500000.000,
  "description": "Prepayment from partner"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 42
  }
}