GET api/Batch?batchNo={batchNo}&overrideClient={overrideClient}

Request Information

URI Parameters

Name	Description	Type	Additional information
batchNo		integer	Required
overrideClient		string	None.

Body Parameters

None.

Response Information

Resource Description

Batch

Name	Type	Additional information
valueDate	date	None.
description	string	None.
voucherSeriesNo	integer	None.
vouchers	Collection of Voucher	None.
batchNo	integer	None.
batchNum	integer	None.
sumCreditDomestic	decimal number	None.
sumDebitDomestic	decimal number	None.
suspended	integer	None.
createdDateTime	date	None.
createdByUser	string	None.
changedDateTime	date	None.
changedByUser	string	None.
origin	integer	None.
voucherReversalDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "valueDate": "2025-11-29T00:36:59.3487763+01:00",
  "description": "sample string 2",
  "voucherSeriesNo": 1,
  "vouchers": [
    {
      "lineNo": 1,
      "voucherNo": 1,
      "voucherType": 1,
      "debitAccountNo": 1,
      "debitAccountType": 1,
      "creditAccountNo": 1,
      "creditAccountType": 1,
      "amountDomestic": 2.0,
      "invoiceNo": "sample string 3",
      "debitTaxCode": 1,
      "creditTaxCode": 1,
      "text": "sample string 4",
      "voucherDate": "2025-11-29T00:36:59.3487763+01:00",
      "dueDate": "2025-11-29T00:36:59.3487763+01:00",
      "valueDate": "2025-11-29T00:36:59.3487763+01:00",
      "paymentTerms": 1,
      "CID": "sample string 8",
      "paymentMethod": 1,
      "reference": "sample string 9",
      "crossReference": "sample string 10",
      "currencyNo": 1,
      "amountInCurrency": 11.0,
      "orgUnit1": 1,
      "orgUnit2": 1,
      "orgUnit3": 1,
      "orgUnit4": 1,
      "orgUnit5": 1,
      "orgUnit6": 1,
      "orgUnit7": "sample string 12",
      "orgUnit8": "sample string 13",
      "exchangeRate": 14.0,
      "free3": 1.0,
      "free4": 1.0,
      "batchNo": 1,
      "amountExclusiveVATDomestic": 1.0,
      "vismaId": 1,
      "pictureFileName": "sample string 15",
      "webPage": "sample string 16",
      "employeeNo": 1,
      "customerNo": 1,
      "supplierNo": 1,
      "additionalText": "sample string 17",
      "voucherJournalNo": 1,
      "voucherGroup1": 1,
      "orgUnit9": "sample string 18",
      "orgUnit10": "sample string 19",
      "orgUnit11": "sample string 20",
      "orgUnit12": "sample string 21",
      "bankAccount": "sample string 22",
      "priority": 1,
      "free1": 1.0,
      "free2": 1.0,
      "orderNo": 1
    },
    {
      "lineNo": 1,
      "voucherNo": 1,
      "voucherType": 1,
      "debitAccountNo": 1,
      "debitAccountType": 1,
      "creditAccountNo": 1,
      "creditAccountType": 1,
      "amountDomestic": 2.0,
      "invoiceNo": "sample string 3",
      "debitTaxCode": 1,
      "creditTaxCode": 1,
      "text": "sample string 4",
      "voucherDate": "2025-11-29T00:36:59.3487763+01:00",
      "dueDate": "2025-11-29T00:36:59.3487763+01:00",
      "valueDate": "2025-11-29T00:36:59.3487763+01:00",
      "paymentTerms": 1,
      "CID": "sample string 8",
      "paymentMethod": 1,
      "reference": "sample string 9",
      "crossReference": "sample string 10",
      "currencyNo": 1,
      "amountInCurrency": 11.0,
      "orgUnit1": 1,
      "orgUnit2": 1,
      "orgUnit3": 1,
      "orgUnit4": 1,
      "orgUnit5": 1,
      "orgUnit6": 1,
      "orgUnit7": "sample string 12",
      "orgUnit8": "sample string 13",
      "exchangeRate": 14.0,
      "free3": 1.0,
      "free4": 1.0,
      "batchNo": 1,
      "amountExclusiveVATDomestic": 1.0,
      "vismaId": 1,
      "pictureFileName": "sample string 15",
      "webPage": "sample string 16",
      "employeeNo": 1,
      "customerNo": 1,
      "supplierNo": 1,
      "additionalText": "sample string 17",
      "voucherJournalNo": 1,
      "voucherGroup1": 1,
      "orgUnit9": "sample string 18",
      "orgUnit10": "sample string 19",
      "orgUnit11": "sample string 20",
      "orgUnit12": "sample string 21",
      "bankAccount": "sample string 22",
      "priority": 1,
      "free1": 1.0,
      "free2": 1.0,
      "orderNo": 1
    }
  ],
  "batchNo": 1,
  "batchNum": 1,
  "sumCreditDomestic": 1.0,
  "sumDebitDomestic": 1.0,
  "suspended": 1,
  "createdDateTime": "2025-11-29T00:36:59.3487763+01:00",
  "createdByUser": "sample string 4",
  "changedDateTime": "2025-11-29T00:36:59.3487763+01:00",
  "changedByUser": "sample string 6",
  "origin": 7,
  "voucherReversalDate": "2025-11-29T00:36:59.3487763+01:00"
}

application/xml, text/xml

Sample:

<Batch xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <valueDate>2025-11-29T00:36:59.3487763+01:00</valueDate>
  <description>sample string 2</description>
  <voucherSeriesNo>1</voucherSeriesNo>
  <vouchers>
    <Voucher>
      <lineNo>1</lineNo>
      <voucherNo>1</voucherNo>
      <voucherType>1</voucherType>
      <debitAccountNo>1</debitAccountNo>
      <debitAccountType>1</debitAccountType>
      <creditAccountNo>1</creditAccountNo>
      <creditAccountType>1</creditAccountType>
      <amountDomestic>2</amountDomestic>
      <invoiceNo>sample string 3</invoiceNo>
      <debitTaxCode>1</debitTaxCode>
      <creditTaxCode>1</creditTaxCode>
      <text>sample string 4</text>
      <voucherDate>2025-11-29T00:36:59.3487763+01:00</voucherDate>
      <dueDate>2025-11-29T00:36:59.3487763+01:00</dueDate>
      <valueDate>2025-11-29T00:36:59.3487763+01:00</valueDate>
      <paymentTerms>1</paymentTerms>
      <CID>sample string 8</CID>
      <paymentMethod>1</paymentMethod>
      <reference>sample string 9</reference>
      <crossReference>sample string 10</crossReference>
      <currencyNo>1</currencyNo>
      <amountInCurrency>11</amountInCurrency>
      <orgUnit1>1</orgUnit1>
      <orgUnit2>1</orgUnit2>
      <orgUnit3>1</orgUnit3>
      <orgUnit4>1</orgUnit4>
      <orgUnit5>1</orgUnit5>
      <orgUnit6>1</orgUnit6>
      <orgUnit7>sample string 12</orgUnit7>
      <orgUnit8>sample string 13</orgUnit8>
      <exchangeRate>14</exchangeRate>
      <free3>1</free3>
      <free4>1</free4>
      <batchNo>1</batchNo>
      <amountExclusiveVATDomestic>1</amountExclusiveVATDomestic>
      <vismaId>1</vismaId>
      <pictureFileName>sample string 15</pictureFileName>
      <webPage>sample string 16</webPage>
      <employeeNo>1</employeeNo>
      <customerNo>1</customerNo>
      <supplierNo>1</supplierNo>
      <additionalText>sample string 17</additionalText>
      <voucherJournalNo>1</voucherJournalNo>
      <voucherGroup1>1</voucherGroup1>
      <orgUnit9>sample string 18</orgUnit9>
      <orgUnit10>sample string 19</orgUnit10>
      <orgUnit11>sample string 20</orgUnit11>
      <orgUnit12>sample string 21</orgUnit12>
      <bankAccount>sample string 22</bankAccount>
      <priority>1</priority>
      <free1>1</free1>
      <free2>1</free2>
      <orderNo>1</orderNo>
    </Voucher>
    <Voucher>
      <lineNo>1</lineNo>
      <voucherNo>1</voucherNo>
      <voucherType>1</voucherType>
      <debitAccountNo>1</debitAccountNo>
      <debitAccountType>1</debitAccountType>
      <creditAccountNo>1</creditAccountNo>
      <creditAccountType>1</creditAccountType>
      <amountDomestic>2</amountDomestic>
      <invoiceNo>sample string 3</invoiceNo>
      <debitTaxCode>1</debitTaxCode>
      <creditTaxCode>1</creditTaxCode>
      <text>sample string 4</text>
      <voucherDate>2025-11-29T00:36:59.3487763+01:00</voucherDate>
      <dueDate>2025-11-29T00:36:59.3487763+01:00</dueDate>
      <valueDate>2025-11-29T00:36:59.3487763+01:00</valueDate>
      <paymentTerms>1</paymentTerms>
      <CID>sample string 8</CID>
      <paymentMethod>1</paymentMethod>
      <reference>sample string 9</reference>
      <crossReference>sample string 10</crossReference>
      <currencyNo>1</currencyNo>
      <amountInCurrency>11</amountInCurrency>
      <orgUnit1>1</orgUnit1>
      <orgUnit2>1</orgUnit2>
      <orgUnit3>1</orgUnit3>
      <orgUnit4>1</orgUnit4>
      <orgUnit5>1</orgUnit5>
      <orgUnit6>1</orgUnit6>
      <orgUnit7>sample string 12</orgUnit7>
      <orgUnit8>sample string 13</orgUnit8>
      <exchangeRate>14</exchangeRate>
      <free3>1</free3>
      <free4>1</free4>
      <batchNo>1</batchNo>
      <amountExclusiveVATDomestic>1</amountExclusiveVATDomestic>
      <vismaId>1</vismaId>
      <pictureFileName>sample string 15</pictureFileName>
      <webPage>sample string 16</webPage>
      <employeeNo>1</employeeNo>
      <customerNo>1</customerNo>
      <supplierNo>1</supplierNo>
      <additionalText>sample string 17</additionalText>
      <voucherJournalNo>1</voucherJournalNo>
      <voucherGroup1>1</voucherGroup1>
      <orgUnit9>sample string 18</orgUnit9>
      <orgUnit10>sample string 19</orgUnit10>
      <orgUnit11>sample string 20</orgUnit11>
      <orgUnit12>sample string 21</orgUnit12>
      <bankAccount>sample string 22</bankAccount>
      <priority>1</priority>
      <free1>1</free1>
      <free2>1</free2>
      <orderNo>1</orderNo>
    </Voucher>
  </vouchers>
  <batchNo>1</batchNo>
  <batchNum>1</batchNum>
  <sumCreditDomestic>1</sumCreditDomestic>
  <sumDebitDomestic>1</sumDebitDomestic>
  <suspended>1</suspended>
  <createdDateTime>2025-11-29T00:36:59.3487763+01:00</createdDateTime>
  <createdByUser>sample string 4</createdByUser>
  <changedDateTime>2025-11-29T00:36:59.3487763+01:00</changedDateTime>
  <changedByUser>sample string 6</changedByUser>
  <origin>7</origin>
  <voucherReversalDate>2025-11-29T00:36:59.3487763+01:00</voucherReversalDate>
</Batch>