POST api/accounting/exports/batchexport

Get details for batch payment export

Request Information

URI Parameters

None.

Body Parameters

SetBatchPaymentDataContract
NameDescriptionTypeAdditional information
ClientBankAccountId

integer

None.

BatchPaymentId

integer

None.

PaymentIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientBankAccountId": 1,
  "BatchPaymentId": 1,
  "PaymentIds": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BatchExportDataContract
NameDescriptionTypeAdditional information
DateTime

date

None.

Amount

decimal number

None.

NumberOfPayments

integer

None.

Processed

boolean

None.

Payments

Collection of BatchPaymentLineDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "DateTime": "2020-11-25T02:41:02.1301338Z",
  "Amount": 2.0,
  "NumberOfPayments": 3,
  "Processed": true,
  "Payments": [
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "CreatedBy": 1,
      "CreatedDate": "2020-11-25T02:41:02.1301338Z",
      "BankAccount": {
        "BankAccountType": "sample string 1",
        "AccountNumber": "sample string 2",
        "SortCode": "sample string 3",
        "IBAN": "sample string 4",
        "BIC": "sample string 5",
        "Bank": {
          "Name": "sample string 1",
          "BankType": 0,
          "BankTypeSystemName": "sample string 2"
        },
        "IsPrimary": true,
        "AccountStatus": 0,
        "Name": "sample string 7",
        "AccountType": "sample string 8",
        "TotalBalance": 9.0,
        "TotalUnclearedBalance": 10.0,
        "TotalAvailableBalance": 11.0,
        "AccountPosition": 12.0,
        "DepositHeldBalance": 13.0,
        "Status": "sample string 14",
        "ChildAccounts": [
          1,
          2
        ],
        "Id": 15
      },
      "Id": 3
    },
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "CreatedBy": 1,
      "CreatedDate": "2020-11-25T02:41:02.1301338Z",
      "BankAccount": {
        "BankAccountType": "sample string 1",
        "AccountNumber": "sample string 2",
        "SortCode": "sample string 3",
        "IBAN": "sample string 4",
        "BIC": "sample string 5",
        "Bank": {
          "Name": "sample string 1",
          "BankType": 0,
          "BankTypeSystemName": "sample string 2"
        },
        "IsPrimary": true,
        "AccountStatus": 0,
        "Name": "sample string 7",
        "AccountType": "sample string 8",
        "TotalBalance": 9.0,
        "TotalUnclearedBalance": 10.0,
        "TotalAvailableBalance": 11.0,
        "AccountPosition": 12.0,
        "DepositHeldBalance": 13.0,
        "Status": "sample string 14",
        "ChildAccounts": [
          1,
          2
        ],
        "Id": 15
      },
      "Id": 3
    }
  ],
  "Id": 5
}