Payment Object
Payment are payments made by your customers on account or applied to specific sales transactions. When a payment is applied to sales transaction you would provide an array of CustomerLedgerApplied.
End Point
/payment
GET, POST, DELETE
GET and DELETE require parameter id, being the payment's ID.
Properties - Payment
| Property | Caption | Data Type | Required |
| CustomerRef | Customer | EntityRef | True |
| PaymentMethodRef | Payment Method | EntityRef | True |
| Date | Date | DateTime | True |
| Amount | Amount | Decimal | True |
| AccountRef | Account | EntityRef | False |
| RefNumber | Ref Number | String (50) | False |
| CurrencyRef | Currency | EntityRef | False |
| ExchangeRate | Exchange Rate | Decimal | False |
| ApprovalCode | Approval Code | String (50) | False |
| Memo | Memo | String (4000) | False |
| AppliedTo | Applied To | Array of CustomerLedgerApplied | True |
Properties - CustomerLedgerApplied
| Property | Caption | Data Type | Required |
| AppliedAmount | Applied | Decimal | True |
| ToDocNo | Doc No | Int32 | True |
| ToTranType | Tran Type | RecordTypeEnum | True |
Json Sample
{
{
"Date": "2019-08-22",
"PaymentMethodRef": {
"Id": 2,
"Name": "Cash"
},
"Amount": 44.00,
"AccountRef": null,
"RefNumber": "SO 1008",
"CustomerRef": {
"Id": 2
},
"ExchangeRate": 1.0,
"CurrencyRef": null,
"Memo": "",
"ApprovalCode": "",
"AppliedTo": [
{
"AppliedAmount": 44.0000,
"ToDocNo": 1008,
"ToTranType": 7
}
]
}