Payments

Files

File	Type	Description
payments/payments.csv	main	The payments that will be imported
payments/order_allocations.csv	linked	The allocations made to orders.
payments/refund_allocations.csv	linked	The allocations made to refunds.

Fields

payments/payment.csv

Field	Required	Type	Description
receipt_number	required	string	The unique receipt number for the payment that is also used as it's id.
type	required	payment-type	Indicates wether it is a payment, credit, or a refund.
client.id	required	relation:"clients.id"	The ID of the client who made the payment.
amount	required	money	The full amount of the payment.
original_amount	required	money	Usually the same as amount, but if the payment was voided the amount should be 0 and this field should contain the original amount.
disbursement_method	required	disbursement-method	The payment method (or reason for a credit) of the disbursement.
remarks	optional	string	Any notes that should be attached to the payment.
paid_at	required	date	The date the payment was made.
voided_at	optional	date	The date the payment was voided.

payments/order_allocations.csv

Field	Required	Type	Description
payment_receipt_number	required	linked-id	The receipt number of the main payment this allocation is linked to.
order_number	required	relation:"orders.order_number"	The order number this allocation is linked to.
amount	required	money	The amount of the payment allocated towards the order.

payments/refund_allocations.csv

Field	Required	Type	Description
payment_receipt_number	required	linked-id	The receipt number of the main payment this allocation is linked to.
disbursement_receipt_number	required	relation:"disbursements.receipt_number"	The receipt number that this refund is allocated to.
amount	required	money	The allocated amount of the refund towards the payment.

Required Rows

none