POST api/receipt/paymentitem

Saves a payment item to be processed Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The record payment data contract supplied with the request.

RecordPaymentDataContract

Name	Description	Type	Additional information
PaymentItemId	The unique identifier of the related payment item resource.	integer	None.
InvoiceId	The unique identifier of the related invoice resource.	integer	None.
AllocationCollectionId	The unique identifier of the related allocation collection resource.	integer	None.
SourceAccountId	The unique identifier of the related source account resource.	integer	None.
DestinationBankAccountId	The unique identifier of the related destination bank account resource.	integer	None.
AccountType	The account type classification.	AccountType	None.
Amount	The amount value.	decimal number	None.
PaymentType	The payment type classification.	PaymentType	None.
ClientBankAccountId	The unique identifier of the related client bank account resource.	integer	None.
Date	The date, expressed as a date and time.	date	None.
Description	The description value.	string	None.
IsCleared	Indicates whether this item is cleared.	boolean	None.
NegotiatorId	The unique identifier of the related negotiator resource.	integer	None.
PropertyAccountId	The unique identifier of the related property account resource.	integer	None.
PropertyRetentionAmount	The property retention amount value.	decimal number	None.
TransactionReference	The transaction reference value.	string	None.
InvoicePaymentCollection	The collection of invoice payment collection.	Collection of PaymentInvoiceCollectionDataContract	None.
InvoiceDeductionCollection	The collection of invoice deduction collection.	Collection of PaymentInvoiceCollectionDataContract	None.
ReceiptsCollection	The collection of receipts collection.	Collection of PaymentInvoiceCollectionDataContract	None.
RefundsCollection	The collection of refunds collection.	Collection of PaymentInvoiceCollectionDataContract	None.
RefundDeductionsCollection	The collection of refund deductions collection.	Collection of PaymentInvoiceCollectionDataContract	None.
PropertyRetentionItemCollection	The collection of property retention item collection.	Collection of RetentionCollectionDataContract	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": "2026-07-23T08:15:57.5885325Z",
  "Description": "sample string 7",
  "IsCleared": true,
  "NegotiatorId": 9,
  "PropertyAccountId": 1,
  "PropertyRetentionAmount": 1.0,
  "TransactionReference": "sample string 10",
  "InvoicePaymentCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "AllocationIdentifier": 1
    }
  ],
  "PropertyRetentionItemCollection": [
    {
      "PropertyId": 1,
      "PropertyAccountId": 2,
      "Amount": 3.0
    },
    {
      "PropertyId": 1,
      "PropertyAccountId": 2,
      "Amount": 3.0
    }
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

PaymentItemCollectionDataContract

Name	Description	Type	Additional information
Collection	The collection of collection.	Collection of PaymentItemDataContract	None.
TotalCount	The total count value.	integer	None.
Total	The total value.	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "Collection": [
    {
      "SourceAccountId": 1,
      "AccountType": 0,
      "Amount": 2.0,
      "PaymentType": 0,
      "ClientBankAccountId": 3,
      "Date": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
      "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "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": "2026-07-23T08:15:57.5885325Z",
          "Description": "sample string 5",
          "Type": "sample string 6",
          "AllocationIdentifier": 1
        }
      ],
      "Reference": "sample string 10",
      "Id": 11
    }
  ],
  "TotalCount": 1,
  "Total": 2.0
}