POST api/receipt/paymentitem

Saves a payment item to be processed

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PaymentItemId	integer	None.
InvoiceId	integer	None.
AllocationId	integer	None.
SourceAccountId	integer	None.
AccountType	AccountType	None.
Amount	decimal number	None.
PaymentType	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 PaymentInvoiceCollectionDataContract	None.
InvoiceDeductionCollection	Collection of PaymentInvoiceCollectionDataContract	None.
ReceiptsCollection	Collection of PaymentInvoiceCollectionDataContract	None.
RefundsCollection	Collection of PaymentInvoiceCollectionDataContract	None.
RefundDeductionsCollection	Collection of PaymentInvoiceCollectionDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PaymentItemId": 1,
  "InvoiceId": 1,
  "AllocationId": 2,
  "SourceAccountId": 3,
  "AccountType": 0,
  "Amount": 4.0,
  "PaymentType": 0,
  "ClientBankAccountId": 5,
  "Date": "2023-01-27T01:46:12.1600864Z",
  "Description": "sample string 6",
  "IsCleared": true,
  "NegotiatorId": 8,
  "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": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    }
  ],
  "InvoiceDeductionCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    }
  ],
  "ReceiptsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    }
  ],
  "RefundsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    }
  ],
  "RefundDeductionsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    },
    {
      "InvoiceId": 1,
      "Amount": 1.0,
      "SubTotalAmount": 2.0,
      "TaxTotalAmount": 3.0,
      "AllocationId": 1,
      "ReceiptId": 1,
      "RefundId": 1,
      "RefundDeductionId": 1,
      "PropertyAccountId": 1,
      "CreatedDate": "2023-01-27T01:46:12.1600864Z",
      "Description": "sample string 5"
    }
  ]
}

Response Information

Resource Description

PaymentItemCollectionDataContract

Name	Type	Additional information
Collection	Collection of 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": "2023-01-27T01:46:12.1756905Z",
      "Description": "sample string 4",
      "AccountName": "sample string 5",
      "PropertyAccountName": "sample string 6",
      "IsCleared": true,
      "NegotiatorId": 8,
      "PaymentStatementReziDocumentId": 1,
      "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": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "InvoicePaymentCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "RefundsCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "InvoiceDeductionCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "RefundDeductionsCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "Id": 10
    },
    {
      "SourceAccountId": 1,
      "AccountType": 0,
      "Amount": 2.0,
      "PaymentType": 0,
      "ClientBankAccountId": 3,
      "Date": "2023-01-27T01:46:12.1756905Z",
      "Description": "sample string 4",
      "AccountName": "sample string 5",
      "PropertyAccountName": "sample string 6",
      "IsCleared": true,
      "NegotiatorId": 8,
      "PaymentStatementReziDocumentId": 1,
      "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": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "InvoicePaymentCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "RefundsCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "InvoiceDeductionCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "RefundDeductionsCollection": [
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        },
        {
          "InvoiceId": 1,
          "Amount": 1.0,
          "SubTotalAmount": 2.0,
          "TaxTotalAmount": 3.0,
          "AllocationId": 1,
          "ReceiptId": 1,
          "RefundId": 1,
          "RefundDeductionId": 1,
          "PropertyAccountId": 1,
          "CreatedDate": "2023-01-27T01:46:12.1756905Z",
          "Description": "sample string 5"
        }
      ],
      "Id": 10
    }
  ],
  "TotalCount": 1,
  "Total": 2.0
}