Payment

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

/package

GET, POST,  DELETE

GET and DELETE  require parameter id, being the payment's ID. 


Properties - Payment

PropertyCaptionData TypeRequired
CustomerRef
CustomerEntityRefTrue
PaymentMethodRef
Payment MethodEntityRef
True
Date
Date
DateTime
True
AmountAmountDecimalTrue
AccountRefAccountEntityRef
False
RefNumberRef NumberString (50)
False
CurrencyRef
CurrencyEntityRefFalse
ExchangeRate
Exchange RateDecimalFalse
ApprovalCode
Approval CodeString (50)
False
MemoMemoString (4000)
False
AppliedToApplied ToArray of CustomerLedgerAppliedTrue

Properties - CustomerLedgerApplied

PropertyCaptionData TypeRequired
AppliedAmountAppliedDecimalTrue
ToDocNoDoc NoInt32True
ToTranTypeTran TypeRecordTypeEnumTrue

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
        }
    ]
}

Top