AR Payments
Proceeds or payments received from the customers who purchased the goods or services on credit.
| Field | Type | Description |
| externalId | string | Friendly reference of the payment/reference of payment from an external system |
| id | string | Identifier for the payment, unique to the company in the accounting platform. |
| amount | number | Amount of the payment in the payment currency. |
| customer | object | An object of customer associated with the payment |
| paymentDate | date | The date of the payment made |
| glPostDate | date | The date of posting of this transaction in the accounting system (General Ledger) |
| exchangeRate | number | Rate to convert the total amount of the payment into the base currency |
| lines | array | An array of payment lines |
| currency | string | Currency of the payment |
| description | string | Any additional information about the payment |
| totalOutstandingAmount | number | Total amount outstanding from the customer. |
| bankAccount | string | The bank account in which the payment was made |
| createdDate | date | Date the record was created in the accounting system. |
| paymentReceiptDate | date | The date payment is received |
| account | string | The AR account in the accounting system linked to this transaction |
| modifiedDate | date | Date the record was last updated in the accounting system. |
| reference | string | A friendly payment reference |
| checkNumber | string | The cheque number in case payment was made by cheque |
| cardNumber | string | The card number in case payment was made by card |
| cardName | string | The card name in case payment was made by card |
| cardExpiry | string | The card expiry date in case payment was made by card |
| paymentMethod | string | The mode of payment |
customer:
| customer.id | string | Identifier of the customer |
| customer.name | string | Name of the customer |
lines:
| lines[*].invoiceNumber | string | The invoice number associated with the payment |
| lines[*].type | string | The type of payment made |
| lines[*].amountDueAgainstInvoice | number | The total amount due against invoice |
| lines[*].amount | number | The amount paid against invoice in the payment |
| lines[*].id | string | The unique identifier of this line in the sales order |
| lines[*].discountAvailable | number | The total applicable discount amount on this payment |
| lines[*].discountDate | date | The date of the discount applied on the payment |
