POST api/receipt/paymentitem

Saves a payment item to be processed

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:48:59.1612281Z",
  "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "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:48:59.1612281Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    }
  ]
}

Response Information

Resource Description

Dezrez.Core.DataContracts.Accounts.Invoices.Query.PaymentItemCollectionDataContract

Name	Type	Additional information
Collection	Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.PaymentItemDataContract	None.
TotalCount	integer	None.
Total	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "Collection": [
    {
      "SourceAccountId": 1,
      "AccountType": 0,
      "Amount": 2.0,
      "PaymentType": 0,
      "ClientBankAccountId": 3,
      "Date": "2024-11-21T09:48:59.1612281Z",
      "Description": "sample string 4",
      "AccountName": "sample string 5",
      "PropertyAccountName": "sample string 6",
      "IsCleared": true,
      "NegotiatorId": 8,
      "PaymentStatementReziDocumentIds": [
        1,
        2
      ],
      "PaymentStatementPreviewReziDocumentRef": "sample string 9",
      "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "Description": "sample string 5",
          "Type": "sample string 6",
          "AllocationIdentifier": 1
        }
      ],
      "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "Description": "sample string 5",
          "Type": "sample string 6",
          "AllocationIdentifier": 1
        }
      ],
      "Reference": "sample string 10",
      "Id": 11
    },
    {
      "SourceAccountId": 1,
      "AccountType": 0,
      "Amount": 2.0,
      "PaymentType": 0,
      "ClientBankAccountId": 3,
      "Date": "2024-11-21T09:48:59.1612281Z",
      "Description": "sample string 4",
      "AccountName": "sample string 5",
      "PropertyAccountName": "sample string 6",
      "IsCleared": true,
      "NegotiatorId": 8,
      "PaymentStatementReziDocumentIds": [
        1,
        2
      ],
      "PaymentStatementPreviewReziDocumentRef": "sample string 9",
      "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "Description": "sample string 5",
          "Type": "sample string 6",
          "AllocationIdentifier": 1
        }
      ],
      "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "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:48:59.1612281Z",
          "Description": "sample string 5",
          "Type": "sample string 6",
          "AllocationIdentifier": 1
        }
      ],
      "Reference": "sample string 10",
      "Id": 11
    }
  ],
  "TotalCount": 1,
  "Total": 2.0
}