POST api/receipt/paymentitem

Request Information

URI Parameters

None.

Body Parameters

RecordPaymentDataContract
NameDescriptionTypeAdditional information
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.

IncludeInExport

boolean

None.

IsCleared

boolean

None.

NegotiatorId

integer

None.

InvoicePaymentCollection

Collection of PaymentInvoiceCollectionDataContract

None.

InvoiceDeductionCollection

Collection of PaymentInvoiceCollectionDataContract

None.

ReceiptsCollection

Collection of PaymentInvoiceCollectionDataContract

None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceId": 1,
  "AllocationId": 2,
  "SourceAccountId": 3,
  "AccountType": 0,
  "Amount": 4.0,
  "PaymentType": 0,
  "ClientBankAccountId": 5,
  "Date": "2018-11-14T15:31:29.6951298Z",
  "Description": "sample string 6",
  "IncludeInExport": true,
  "IsCleared": true,
  "NegotiatorId": 9,
  "InvoicePaymentCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "CreatedDate": "2018-11-14T15:31:29.6951298Z",
      "Description": "sample string 6"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "CreatedDate": "2018-11-14T15:31:29.6951298Z",
      "Description": "sample string 6"
    }
  ],
  "InvoiceDeductionCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "CreatedDate": "2018-11-14T15:31:29.6951298Z",
      "Description": "sample string 6"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "CreatedDate": "2018-11-14T15:31:29.6951298Z",
      "Description": "sample string 6"
    }
  ],
  "ReceiptsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "CreatedDate": "2018-11-14T15:31:29.6951298Z",
      "Description": "sample string 6"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "CreatedDate": "2018-11-14T15:31:29.6951298Z",
      "Description": "sample string 6"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RecordPaymentDataContract'.

Response Information

Resource Description

PaymentItemCollectionDataContract
NameDescriptionTypeAdditional 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": "2018-11-14T15:31:29.7263426Z",
      "Description": "sample string 4",
      "IncludeInExport": true,
      "IsCleared": true,
      "NegotiatorId": 7,
      "InvoicePaymentCollection": [
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        },
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        }
      ],
      "InvoiceDeductionCollection": [
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        },
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        }
      ],
      "ReceiptsCollection": [
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        },
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        }
      ],
      "Id": 8
    },
    {
      "SourceAccountId": 1,
      "AccountType": 0,
      "Amount": 2.0,
      "PaymentType": 0,
      "ClientBankAccountId": 3,
      "Date": "2018-11-14T15:31:29.7263426Z",
      "Description": "sample string 4",
      "IncludeInExport": true,
      "IsCleared": true,
      "NegotiatorId": 7,
      "InvoicePaymentCollection": [
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        },
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        }
      ],
      "InvoiceDeductionCollection": [
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        },
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        }
      ],
      "ReceiptsCollection": [
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        },
        {
          "InvoiceId": 1,
          "Amount": 2.0,
          "AllocationId": 3,
          "ReceiptId": 4,
          "CreatedDate": "2018-11-14T15:31:29.7263426Z",
          "Description": "sample string 6"
        }
      ],
      "Id": 8
    }
  ],
  "TotalCount": 1,
  "Total": 2.0
}