Payment.md

Bfwd::Payment

Properties

Name	Type	Description	Notes
created	DateTime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	String	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
updated	DateTime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
id	String	{ "description" : "ID of the payment.", "verbs":["POST","PUT","GET"] }	[optional]
crm_id	String	{ "description" : "CRM ID of the invoice.", "verbs":["POST","PUT","GET"] }
payment_method_id	String	{ "description" : "ID of the payment method associated with the payment.", "verbs":["POST","PUT","GET"] }
invoice_id	String	{ "description" : "ID of the invoice associated with the payment. This may be null when a payment is not explicitly associated with an invoice. Payments may be used across multiple invoices.", "verbs":["POST","PUT","GET"] }
organization_id	String	{ "description" : "ID of the organization associated with the payment.", "verbs":["POST","PUT","GET"] }
gateway	String	{ "description" : "Payment gateway associated with the payment", "verbs":["POST","PUT","GET"] }
currency	String	{ "description" : "The currency of the payment specified by a three character ISO 4217 currency code.", "verbs":["POST","PUT","GET"] }
nominal_value	Float	{ "description" : "Nominal value of the payment. This is the theoretical value of the payment, thus the value this payment can pay off an invoice. For example a coupon has a nominal value of the discount, and the actual value is zero.", "verbs":["POST","PUT","GET"] }
actual_value	Float	{ "description" : "Actual monetary value of the payment. This is real value of the payment amount, thus the amount of currency received for this payment. A coupon has a real value of zero, even though the nominal amount it pays may be greater than zero.", "verbs":["POST","PUT","GET"] }
remaining_nominal_value	Float	{ "description" : "Remaining nominal value of the payment not used. In the case when a payment is used across a range of invoices a payment may be used multiple times, each use reducing the available blance of the payment.", "verbs":["POST","PUT","GET"] }
payment_received	DateTime	{ "description" : "UTC DateTime specifying when payment was received for the invoice.", "verbs":["POST","PUT","GET"] }	[optional]
refunded_value	Float	{ "description" : "Refunded nominal value of the payment.", "verbs":["POST","PUT","GET"] }
refund_id	String	{ "description" : "ID of the refund associated with the payment.", "verbs":["POST","PUT","GET"] }
type	String	{ "description" : "Type of payment.", "verbs":["POST","PUT","GET"] }