POST api/receipt/recordpayment

Makes payment to supplied account.

Request Information

URI Parameters

None.

Body Parameters

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

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/json, text/json

Sample:
{
  "PaymentItemId": 1,
  "InvoiceId": 1,
  "AllocationId": 2,
  "SourceAccountId": 3,
  "AccountType": 0,
  "Amount": 4.0,
  "PaymentType": 0,
  "ClientBankAccountId": 5,
  "Date": "2021-08-04T13:39:43.595379Z",
  "Description": "sample string 6",
  "IsCleared": true,
  "NegotiatorId": 8,
  "InvoicePaymentCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    }
  ],
  "InvoiceDeductionCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    }
  ],
  "ReceiptsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    }
  ],
  "RefundsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    }
  ],
  "RefundDeductionsCollection": [
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    },
    {
      "InvoiceId": 1,
      "Amount": 2.0,
      "SubTotalAmount": 1.0,
      "TaxTotalAmount": 1.0,
      "AllocationId": 3,
      "ReceiptId": 4,
      "RefundId": 5,
      "RefundDeductionId": 6,
      "CreatedDate": "2021-08-04T13:39:43.595379Z",
      "Description": "sample string 8"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LedgerTransactionDataContract
NameDescriptionTypeAdditional information
Date

date

None.

Amount

decimal number

None.

TransactionType

string

None.

ClearedStatus

ClearedStatus

None.

ReconciliationStatus

string

None.

Description

string

None.

GeneralLedgerLines

Collection of LedgerLineTransactionDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Date": "2021-08-04T13:39:43.6110062Z",
  "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
}