BexioApiClient. Banking. Payment
(bexio_api_client v2.0.0)
Copy Markdown
Payment in banking (bexio API v4).
The docs model IBAN and QR payments as separate payload variants (type:
iban or qr) of the same /4.0/banking/payments resource — this struct
covers both variants.
Summary
Types
@type t() :: %BexioApiClient.Banking.Payment{ account_id: String.t() | nil, additional_information: String.t() | nil, allowance: :fee_paid_by_payer | :fee_paid_by_payee | :fee_split | :no_fee | nil, amount: Decimal.t() | nil, created_at: DateTime.t() | NaiveDateTime.t() | nil, currency: String.t() | nil, document_no: String.t() | nil, due_date: Date.t() | nil, editing_restricted?: boolean() | nil, execution_date: Date.t() | nil, id: integer() | String.t(), instruction_id: String.t() | nil, message: String.t() | nil, purchase_reference: BexioApiClient.Banking.PaymentPurchaseReference.t() | nil, qr_reference_number: String.t() | nil, recipient: BexioApiClient.Banking.PaymentRecipient.t() | nil, salary?: boolean() | nil, sender: BexioApiClient.Banking.PaymentSender.t() | nil, status: String.t() | nil, type: :iban | :qr | nil, uuid: String.t() | nil }
Bexio Payment
Fields:
:id- automatic id given by bexio:uuid- uuid of the payment (used aspayment_idin the path of the single payment endpoints):account_id- uuid of the bank account the payment is sent from (only needed when creating a payment):sender- the sending bank account:recipient- the recipient of the payment:amount- the amount to send in the chosen currency:currency- currency in which the payment is sent, according to ISO 4217:execution_date- date when the payment should be carried out by the bank:allowance- who pays the fee for payments to other countries or with different currencies (:fee_paid_by_payer,:fee_paid_by_payee,:fee_splitor:no_fee):salary?- if it is a salary payment (bexio'sis_salary):instruction_id- instruction id of the payment:purchase_reference- reference of the bill the payment belongs to:document_no- document number of the linked bill:qr_reference_number- a QR reference number or creditor reference number:additional_information- additional information on the payment slip:status- status of the payment as returned by bexio (e.g.open):type- type of the payment (:ibanor:qr), each type requires different fields:due_date- due date of the linked bill:created_at- when the payment was created:editing_restricted?- if set to true, editing will be restricted to (bexio'sis_editing_restricted) the api client id which created the payment:message- multiline description of the payment (only sent when creating/updating, not part of the response)