POST api/CheckPrint

Check Payment: Post check payment information to be printed and/or record the payment information for documents in the system.

Request Information

URI Parameters

None.

Body Parameters

List of check payments

Collection of CheckPayment

Name	Description	Type	Additional information
ClientId	NextProcess Client Id	integer	Required
AccountIdentifier	Bank account identifier	string	Required
BankAccountId	Bank account Id: System will provide this value	integer	None.
VendorCode	Vendor Code	string	None.
CheckNumber	Check Number. If NextProcess is generating the check number leave blank.	integer	None.
CheckDate	Check Date - the desired date the check is to be printed.	date	Required
CheckAmount	Check Amount	decimal number	Required
PayToName1	Pay to name 1 - required field	string	Required
PayToName2	Pay to name 2 - optional	string	None.
Address1	Address Line 1	string	Required
Address2	Address Line 2	string	None.
City	City	string	Required
State	State	string	Required
Zip	Zip/Postal Code	string	Required
Country	Country - optional, assumber US if not specified	string	None.
Memo	Check Memo. Maximum length is 150 characters	string	None.
NextProcessPrint	True = NextProcess to print check, False = Client printed, only need to update invoice in system	boolean	None.
Details	Invoice details - information about the documents being paid by this check	Collection of PaymentDetail	None.
SpecialHandlingType	Special handling types: <list type="bullet"><item>1: N/A No special handling required</item><item>2: Overnight Send via overnight courier</item><item>3: Other See handling instructions</item><item>4: Corporate Send to corporate office</item></list>	integer	None.
SpecialHandlingInstructions	Special handling additional instructions	string	None.
IsSuccessful	True = payment was successfully loaded to system, False = payment was not loaded to system, see Errors parameter value	boolean	None.
Errors	Processing errors	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ClientId": 1,
    "AccountIdentifier": "sample string 2",
    "BankAccountId": 1,
    "VendorCode": "sample string 3",
    "CheckNumber": 1,
    "CheckDate": "2026-09-21T02:44:01.2334887-05:00",
    "CheckAmount": 5.0,
    "PayToName1": "sample string 6",
    "PayToName2": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "City": "sample string 10",
    "State": "sample string 11",
    "Zip": "sample string 12",
    "Country": "sample string 13",
    "Memo": "sample string 14",
    "NextProcessPrint": true,
    "Details": [
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2334887-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      },
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2334887-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      }
    ],
    "SpecialHandlingType": 16,
    "SpecialHandlingInstructions": "sample string 17",
    "IsSuccessful": true,
    "Errors": "sample string 18"
  },
  {
    "ClientId": 1,
    "AccountIdentifier": "sample string 2",
    "BankAccountId": 1,
    "VendorCode": "sample string 3",
    "CheckNumber": 1,
    "CheckDate": "2026-09-21T02:44:01.2334887-05:00",
    "CheckAmount": 5.0,
    "PayToName1": "sample string 6",
    "PayToName2": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "City": "sample string 10",
    "State": "sample string 11",
    "Zip": "sample string 12",
    "Country": "sample string 13",
    "Memo": "sample string 14",
    "NextProcessPrint": true,
    "Details": [
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2334887-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      },
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2334887-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      }
    ],
    "SpecialHandlingType": 16,
    "SpecialHandlingInstructions": "sample string 17",
    "IsSuccessful": true,
    "Errors": "sample string 18"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCheckPrintController.CheckPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <CheckPrintController.CheckPayment>
    <AccountIdentifier>sample string 2</AccountIdentifier>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <BankAccountId>1</BankAccountId>
    <CheckAmount>5</CheckAmount>
    <CheckDate>2026-09-21T02:44:01.2334887-05:00</CheckDate>
    <CheckNumber>1</CheckNumber>
    <City>sample string 10</City>
    <ClientId>1</ClientId>
    <Country>sample string 13</Country>
    <Details>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2334887-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2334887-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
    </Details>
    <Errors>sample string 18</Errors>
    <IsSuccessful>true</IsSuccessful>
    <Memo>sample string 14</Memo>
    <NextProcessPrint>true</NextProcessPrint>
    <PayToName1>sample string 6</PayToName1>
    <PayToName2>sample string 7</PayToName2>
    <SpecialHandlingInstructions>sample string 17</SpecialHandlingInstructions>
    <SpecialHandlingType>16</SpecialHandlingType>
    <State>sample string 11</State>
    <VendorCode>sample string 3</VendorCode>
    <Zip>sample string 12</Zip>
  </CheckPrintController.CheckPayment>
  <CheckPrintController.CheckPayment>
    <AccountIdentifier>sample string 2</AccountIdentifier>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <BankAccountId>1</BankAccountId>
    <CheckAmount>5</CheckAmount>
    <CheckDate>2026-09-21T02:44:01.2334887-05:00</CheckDate>
    <CheckNumber>1</CheckNumber>
    <City>sample string 10</City>
    <ClientId>1</ClientId>
    <Country>sample string 13</Country>
    <Details>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2334887-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2334887-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
    </Details>
    <Errors>sample string 18</Errors>
    <IsSuccessful>true</IsSuccessful>
    <Memo>sample string 14</Memo>
    <NextProcessPrint>true</NextProcessPrint>
    <PayToName1>sample string 6</PayToName1>
    <PayToName2>sample string 7</PayToName2>
    <SpecialHandlingInstructions>sample string 17</SpecialHandlingInstructions>
    <SpecialHandlingType>16</SpecialHandlingType>
    <State>sample string 11</State>
    <VendorCode>sample string 3</VendorCode>
    <Zip>sample string 12</Zip>
  </CheckPrintController.CheckPayment>
</ArrayOfCheckPrintController.CheckPayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Posted data with updated values

Collection of CheckPayment

Name	Description	Type	Additional information
ClientId	NextProcess Client Id	integer	Required
AccountIdentifier	Bank account identifier	string	Required
BankAccountId	Bank account Id: System will provide this value	integer	None.
VendorCode	Vendor Code	string	None.
CheckNumber	Check Number. If NextProcess is generating the check number leave blank.	integer	None.
CheckDate	Check Date - the desired date the check is to be printed.	date	Required
CheckAmount	Check Amount	decimal number	Required
PayToName1	Pay to name 1 - required field	string	Required
PayToName2	Pay to name 2 - optional	string	None.
Address1	Address Line 1	string	Required
Address2	Address Line 2	string	None.
City	City	string	Required
State	State	string	Required
Zip	Zip/Postal Code	string	Required
Country	Country - optional, assumber US if not specified	string	None.
Memo	Check Memo. Maximum length is 150 characters	string	None.
NextProcessPrint	True = NextProcess to print check, False = Client printed, only need to update invoice in system	boolean	None.
Details	Invoice details - information about the documents being paid by this check	Collection of PaymentDetail	None.
SpecialHandlingType	Special handling types: <list type="bullet"><item>1: N/A No special handling required</item><item>2: Overnight Send via overnight courier</item><item>3: Other See handling instructions</item><item>4: Corporate Send to corporate office</item></list>	integer	None.
SpecialHandlingInstructions	Special handling additional instructions	string	None.
IsSuccessful	True = payment was successfully loaded to system, False = payment was not loaded to system, see Errors parameter value	boolean	None.
Errors	Processing errors	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientId": 1,
    "AccountIdentifier": "sample string 2",
    "BankAccountId": 1,
    "VendorCode": "sample string 3",
    "CheckNumber": 1,
    "CheckDate": "2026-09-21T02:44:01.2584865-05:00",
    "CheckAmount": 5.0,
    "PayToName1": "sample string 6",
    "PayToName2": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "City": "sample string 10",
    "State": "sample string 11",
    "Zip": "sample string 12",
    "Country": "sample string 13",
    "Memo": "sample string 14",
    "NextProcessPrint": true,
    "Details": [
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2584865-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      },
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2584865-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      }
    ],
    "SpecialHandlingType": 16,
    "SpecialHandlingInstructions": "sample string 17",
    "IsSuccessful": true,
    "Errors": "sample string 18"
  },
  {
    "ClientId": 1,
    "AccountIdentifier": "sample string 2",
    "BankAccountId": 1,
    "VendorCode": "sample string 3",
    "CheckNumber": 1,
    "CheckDate": "2026-09-21T02:44:01.2584865-05:00",
    "CheckAmount": 5.0,
    "PayToName1": "sample string 6",
    "PayToName2": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "City": "sample string 10",
    "State": "sample string 11",
    "Zip": "sample string 12",
    "Country": "sample string 13",
    "Memo": "sample string 14",
    "NextProcessPrint": true,
    "Details": [
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2584865-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      },
      {
        "DocumentID": 1,
        "DocumentType": 1,
        "ERPReferenceID": "sample string 1",
        "CheckNumber": 1,
        "InvoiceNumber": "sample string 2",
        "InvoiceDate": "2026-09-21T02:44:01.2584865-05:00",
        "InvoiceAmount": 3.0,
        "DiscountAmount": 1.0,
        "BilledAmount": 1.0,
        "PaymentAmount": 4.0,
        "VoucherNumber": "sample string 5",
        "VendorCode": "sample string 6",
        "VendorName": "sample string 7"
      }
    ],
    "SpecialHandlingType": 16,
    "SpecialHandlingInstructions": "sample string 17",
    "IsSuccessful": true,
    "Errors": "sample string 18"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCheckPrintController.CheckPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <CheckPrintController.CheckPayment>
    <AccountIdentifier>sample string 2</AccountIdentifier>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <BankAccountId>1</BankAccountId>
    <CheckAmount>5</CheckAmount>
    <CheckDate>2026-09-21T02:44:01.2584865-05:00</CheckDate>
    <CheckNumber>1</CheckNumber>
    <City>sample string 10</City>
    <ClientId>1</ClientId>
    <Country>sample string 13</Country>
    <Details>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2584865-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2584865-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
    </Details>
    <Errors>sample string 18</Errors>
    <IsSuccessful>true</IsSuccessful>
    <Memo>sample string 14</Memo>
    <NextProcessPrint>true</NextProcessPrint>
    <PayToName1>sample string 6</PayToName1>
    <PayToName2>sample string 7</PayToName2>
    <SpecialHandlingInstructions>sample string 17</SpecialHandlingInstructions>
    <SpecialHandlingType>16</SpecialHandlingType>
    <State>sample string 11</State>
    <VendorCode>sample string 3</VendorCode>
    <Zip>sample string 12</Zip>
  </CheckPrintController.CheckPayment>
  <CheckPrintController.CheckPayment>
    <AccountIdentifier>sample string 2</AccountIdentifier>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <BankAccountId>1</BankAccountId>
    <CheckAmount>5</CheckAmount>
    <CheckDate>2026-09-21T02:44:01.2584865-05:00</CheckDate>
    <CheckNumber>1</CheckNumber>
    <City>sample string 10</City>
    <ClientId>1</ClientId>
    <Country>sample string 13</Country>
    <Details>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2584865-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
      <CheckPrintController.PaymentDetail>
        <BilledAmount>1</BilledAmount>
        <CheckNumber>1</CheckNumber>
        <DiscountAmount>1</DiscountAmount>
        <DocumentID>1</DocumentID>
        <DocumentType>1</DocumentType>
        <ERPReferenceID>sample string 1</ERPReferenceID>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:44:01.2584865-05:00</InvoiceDate>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <PaymentAmount>4</PaymentAmount>
        <VendorCode>sample string 6</VendorCode>
        <VendorName>sample string 7</VendorName>
        <VoucherNumber>sample string 5</VoucherNumber>
      </CheckPrintController.PaymentDetail>
    </Details>
    <Errors>sample string 18</Errors>
    <IsSuccessful>true</IsSuccessful>
    <Memo>sample string 14</Memo>
    <NextProcessPrint>true</NextProcessPrint>
    <PayToName1>sample string 6</PayToName1>
    <PayToName2>sample string 7</PayToName2>
    <SpecialHandlingInstructions>sample string 17</SpecialHandlingInstructions>
    <SpecialHandlingType>16</SpecialHandlingType>
    <State>sample string 11</State>
    <VendorCode>sample string 3</VendorCode>
    <Zip>sample string 12</Zip>
  </CheckPrintController.CheckPayment>
</ArrayOfCheckPrintController.CheckPayment>