POST api/receipt/recordpayment

Makes payment to supplied account.

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.Accounts.Financial.Command.Receipt.RecordPaymentDataContract

Name	Type	Additional information
PaymentItemId	integer	None.
InvoiceId	integer	None.
AllocationCollectionId	integer	None.
SourceAccountId	integer	None.
DestinationBankAccountId	integer	None.
AccountType	Dezrez.Rezi.Domain.Accounts.Enums.AccountType	None.
Amount	decimal number	None.
PaymentType	Dezrez.Rezi.Domain.Accounts.Enums.PaymentType	None.
ClientBankAccountId	integer	None.
Date	date	None.
Description	string	None.
IsCleared	boolean	None.
NegotiatorId	integer	None.
PropertyAccountId	integer	None.
PropertyRetentionAmount	decimal number	None.
InvoicePaymentCollection	Collection of Dezrez.Core.DataContracts.Accounts.Financial.Command.Receipt.PaymentInvoiceCollectionDataContract	None.
InvoiceDeductionCollection	Collection of Dezrez.Core.DataContracts.Accounts.Financial.Command.Receipt.PaymentInvoiceCollectionDataContract	None.
ReceiptsCollection	Collection of Dezrez.Core.DataContracts.Accounts.Financial.Command.Receipt.PaymentInvoiceCollectionDataContract	None.
RefundsCollection	Collection of Dezrez.Core.DataContracts.Accounts.Financial.Command.Receipt.PaymentInvoiceCollectionDataContract	None.
RefundDeductionsCollection	Collection of Dezrez.Core.DataContracts.Accounts.Financial.Command.Receipt.PaymentInvoiceCollectionDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PaymentItemId": 1,
  "InvoiceId": 1,
  "AllocationCollectionId": 2,
  "SourceAccountId": 3,
  "DestinationBankAccountId": 4,
  "AccountType": 0,
  "Amount": 5.0,
  "PaymentType": 0,
  "ClientBankAccountId": 6,
  "Date": "2024-11-21T09:45:51.2957916Z",
  "Description": "sample string 7",
  "IsCleared": true,
  "NegotiatorId": 9,
  "PropertyAccountId": 1,
  "PropertyRetentionAmount": 1.0,
  "InvoicePaymentCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    }
  ],
  "InvoiceDeductionCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    }
  ],
  "ReceiptsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    }
  ],
  "RefundsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    }
  ],
  "RefundDeductionsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2024-11-21T09:45:51.2957916Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    }
  ]
}

Response Information

Resource Description

Dezrez.Core.DataContracts.Accounts.Ledger.Query.LedgerTransactionDataContract

Name	Type	Additional information
Date	date	None.
Amount	decimal number	None.
TransactionType	string	None.
ClearedStatus	Dezrez.Rezi.Domain.Accounts.Enums.ClearedStatus	None.
ReconciliationStatus	string	None.
Description	string	None.
GeneralLedgerLines	Collection of Dezrez.Core.DataContracts.Accounts.Ledger.Query.LedgerLineTransactionDataContract	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Date": "2024-11-21T09:45:51.3114211Z",
  "Amount": 2.0,
  "TransactionType": "sample string 3",
  "ClearedStatus": 0,
  "ReconciliationStatus": "sample string 4",
  "Description": "sample string 5",
  "GeneralLedgerLines": [
    {
      "DrCr": "sample string 1",
      "Amount": 2.0,
      "AccountId": 3,
      "AccountType": "sample string 4",
      "Id": 5
    },
    {
      "DrCr": "sample string 1",
      "Amount": 2.0,
      "AccountId": 3,
      "AccountType": "sample string 4",
      "Id": 5
    }
  ],
  "Id": 6
}