Page values for "References/Payment Reconciliation"

"Docs" values

1 row is stored for this page

20 rows are stored for this page

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Relationships
Field	`String`	facility
FieldType	`String`	FK → Facility (PROTECT)
Notes	`Text`	Facility where the payment is recorded

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Relationships
Field	`String`	target_invoice
FieldType	`String`	FK → Invoice (PROTECT)
Notes	`Text`	The invoice this payment is allocated to. Nullable (<code>default=None</code>); one allocation per record. On write, pass the invoice <code>external_id</code> (UUID)

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Relationships
Field	`String`	account
FieldType	`String`	FK → Account (PROTECT)
Notes	`Text`	The account being paid. Required even when <code>target_invoice</code> is set. On write, pass the account <code>external_id</code> (UUID)

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Relationships
Field	`String`	location
FieldType	`String`	FK → FacilityLocation (PROTECT)
Notes	`Text`	Physical location (e.g. the counter) where payment was taken. Nullable. On write, pass the location <code>external_id</code> (UUID)

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Classification
Field	`String`	reconciliation_type
FieldType	`String`	CharField(100)
Notes	`Text`	<code>PaymentReconciliationTypeOptions</code>

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Classification
Field	`String`	status
FieldType	`String`	CharField(100)
Notes	`Text`	<code>PaymentReconciliationStatusOptions</code>

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Classification
Field	`String`	kind
FieldType	`String`	CharField(100)
Notes	`Text`	<code>PaymentReconciliationKindOptions</code>

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Classification
Field	`String`	issuer_type
FieldType	`String`	CharField(100)
Notes	`Text`	<code>PaymentReconciliationIssuerTypeOptions</code>

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Classification
Field	`String`	outcome
FieldType	`String`	CharField(100)
Notes	`Text`	<code>PaymentReconciliationOutcomeOptions</code>

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Classification
Field	`String`	method
FieldType	`String`	CharField(100)
Notes	`Text`	<code>PaymentReconciliationPaymentMethodOptions</code>

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Payment details
Field	`String`	payment_datetime
FieldType	`String`	DateTimeField → datetime
Notes	`Text`	When the payment was issued. Optional (default <code>None</code>)

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Payment details
Field	`String`	reference_number
FieldType	`String`	CharField(1024) → str
Notes	`Text`	Cheque number or payment reference. Optional

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Payment details
Field	`String`	authorization
FieldType	`String`	CharField(1024) → str
Notes	`Text`	Authorization number. Optional

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Payment details
Field	`String`	disposition
FieldType	`String`	TextField → str
Notes	`Text`	Message describing the outcome. Optional

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Amounts
Field	`String`	tendered_amount
FieldType	`String`	Decimal(20, 6)
Notes	`Text`	Required on write. Amount offered by the issuer

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Amounts
Field	`String`	returned_amount
FieldType	`String`	Decimal(20, 6)
Notes	`Text`	Required on write. Amount returned to the issuer (e.g. change). Must be strictly less than <code>tendered_amount</code>, or the write is rejected

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Amounts
Field	`String`	amount
FieldType	`String`	Decimal(20, 6)
Notes	`Text`	Net payment, computed server-side as <code>tendered_amount - returned_amount</code>. A client-supplied value is always overwritten

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Flags & extensions
Field	`String`	is_credit_note
FieldType	`String`	BooleanField → bool
Notes	`Text`	Default <code>False</code>. Marks the record as a credit note rather than an inbound payment

Field	Field type	Value
Model	`String`	PaymentReconciliation
Section	`String`	Flags & extensions
Field	`String`	extensions
FieldType	`String`	JSONField → dict
Notes	`Text`	Default <code>{}</code>. Open extension bag. On write, each key is validated against the registered handler for resource type <code>payment_reconciliation</code> — unknown keys are currently dropped. On retrieve, rendered through those handlers