create_outgoing_payment
Creates a new outgoing payment for a bill in Bexio, supporting IBAN, QR, manual, and cash discount payment types, with validation for amount, currency, and execution date.
Instructions
Create new Outgoing Payment
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Not allowed for IBAN, QR. | |
| amount | Yes | Must be less or equal to Bill's 'pending_amount'. Maximum of 17 digits and maximum of 2 decimal digits. | |
| bill_id | Yes | Payment can be created only for Bill that is not in status DRAFT. | |
| message | No | Not allowed for QR, MANUAL, CASH_DISCOUNT. | |
| fee_type | No | Required for IBAN. Not allowed for QR, MANUAL, CASH_DISCOUNT. Must be set to NO_FEE when 'receiver_iban' is a domestic IBAN (same country as 'sender_bank_account_id' Bank Account IBAN country). Cannot be set to NO_FEE when 'receiver_iban' is not a domestic IBAN. | |
| sender_city | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. | |
| sender_iban | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. | |
| sender_name | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. | |
| booking_text | No | Not allowed for MANUAL, CASH_DISCOUNT. | |
| payment_type | Yes | Bill's amount cannot be covered only by CASH_DISCOUNT payments. | |
| reference_no | No | Not allowed for IBAN, MANUAL, CASH_DISCOUNT. For QR, when 'receiver_iban' is QR Iban then 'reference_no' must be valid Isr Account number. For QR, when 'receiver_iban' is not QR Iban then 'reference_no' must be valid Creaditor Reference. | |
| sender_bc_no | No | Not allowed for CASH_DISCOUNT. | |
| currency_code | Yes | Must be equal to Bill's 'currency_code'. Only 'CHF' and 'EUR' is allowed for QR. | |
| exchange_rate | Yes | Maximum of 5 digits and maximum of 10 decimal digits. | |
| receiver_city | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. | |
| receiver_iban | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. Must be valid Iban for IBAN Payment or must be valid QR Iban for QR Payment. | |
| receiver_name | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. | |
| sender_street | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. | |
| execution_date | Yes | Must be after or equal to Bill's 'bill_date'. Cannot be in CLOSED or LOCKED Business Year. Must be in existing Business Year. For IBAN and QR must be in present or future and cannot be on the weekend. | |
| receiver_bc_no | No | Not allowed for MANUAL, CASH_DISCOUNT. | |
| sender_bank_no | No | Not allowed for CASH_DISCOUNT. | |
| receiver_street | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. | |
| sender_house_no | No | Not allowed for CASH_DISCOUNT. | |
| sender_postcode | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. | |
| receiver_bank_no | No | Not allowed for MANUAL, CASH_DISCOUNT. | |
| sender_bank_name | No | Not allowed for CASH_DISCOUNT. | |
| is_salary_payment | Yes | Allowed to be set to true only for IBAN. | |
| receiver_house_no | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. | |
| receiver_postcode | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. | |
| receiver_bank_name | No | Not allowed for MANUAL, CASH_DISCOUNT. | |
| receiver_account_no | No | Not allowed for IBAN, QR, MANUAL, CASH_DISCOUNT. | |
| sender_country_code | No | Not allowed for CASH_DISCOUNT. | |
| receiver_country_code | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. | |
| sender_bank_account_id | Yes | Required for IBAN, MANUAL, QR. Not allowed for CASH_DISCOUNT. For [IBAN, QR] it must be Bank Account with type 'bank'. For MANUAL it could be Bank Account with type 'bank' or 'cash'. |