GET api/CheckRequest/ReadyToPay/{clientId}

Get ready to pay check requests by client ID

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client ID	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of CheckRequest

Name	Description	Type	Additional information
AccountingDate	Accounting Date	date	None.
CheckTotal	Check Request Total	decimal number	None.
UserText1	User Defined text 1	string	None.
UserText2	User Defined text 2	string	None.
UserText3	User Defined text 3	string	None.
UserText4	User Defined text 4	string	None.
UserText5	User Defined text 5	string	None.
UserText6	User Defined text 6	string	None.
ClassName	Check Request Class Name	string	None.
CompanyCode	Company Code	string	None.
CompanyName	Company Name	string	None.
CreateDate	Create Date - Date invoice was loaded into APex	date	None.
CreatedByUser	Created by User	string	None.
Currency	Currency	string	None.
DocumentID	Document ID	integer	None.
DocumentGUID	Document Guid	globally unique identifier	None.
Handling	Check request handling instructions	string	None.
InvoiceDate	Invoice Date	date	None.
InvoiceNumber	Invocie Number	string	None.
LocationCode	Location Code	string	None.
LocationName	Location Name	string	None.
NeedByDate	Need By Date	date	None.
PONumber	Purchase Order Number	string	None.
Purpose	Check Request Purpose	string	None.
Terms	Invoice terms	string	None.
VendorCode	Vendor Code (ID)	string	None.
VendorName	Vendor Name	string	None.
RemitAddress1	Remit Address Line 1	string	None.
RemitAddress2	Remit Address Line 2	string	None.
RemitCity	Remit City	string	None.
RemitState	Remit State	string	None.
RemitZip	Remit Zip	string	None.
Lines	Check Request Lines - zero to many possible	Collection of CRLine	None.
DetailAmounts	Check Request Detail Amounts - zero to many possible	Collection of DetailAmount	None.
Distributions	Check Request Distributions - zero to many possible	Collection of Distribution	None.
Notes	Invoice Notes - zero to many possible	Collection of Note	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AccountingDate": "2026-09-21T02:44:58.1372167-05:00",
    "CheckTotal": 1.0,
    "UserText1": "sample string 2",
    "UserText2": "sample string 3",
    "UserText3": "sample string 4",
    "UserText4": "sample string 5",
    "UserText5": "sample string 6",
    "UserText6": "sample string 7",
    "ClassName": "sample string 8",
    "CompanyCode": "sample string 9",
    "CompanyName": "sample string 10",
    "CreateDate": "2026-09-21T02:44:58.1372167-05:00",
    "CreatedByUser": "sample string 12",
    "Currency": "sample string 13",
    "DocumentID": 14,
    "DocumentGUID": "5317dbed-8e49-439c-ab4b-ba3b9b3d7bf9",
    "Handling": "sample string 16",
    "InvoiceDate": "2026-09-21T02:44:58.1372167-05:00",
    "InvoiceNumber": "sample string 17",
    "LocationCode": "sample string 18",
    "LocationName": "sample string 19",
    "NeedByDate": "2026-09-21T02:44:58.1372167-05:00",
    "PONumber": "sample string 20",
    "Purpose": "sample string 21",
    "Terms": "sample string 22",
    "VendorCode": "sample string 23",
    "VendorName": "sample string 24",
    "RemitAddress1": "sample string 25",
    "RemitAddress2": "sample string 26",
    "RemitCity": "sample string 27",
    "RemitState": "sample string 28",
    "RemitZip": "sample string 29",
    "Lines": [
      {
        "LineId": 1,
        "LineNumber": 1,
        "ItemNumber": "sample string 2",
        "ItemDescription": "sample string 3",
        "Quantity": 4.0,
        "UnitOfMeasure": "sample string 5",
        "UnitPrice": 6.0,
        "LineTotal": 7.0,
        "UserText1": "sample string 8",
        "UserText2": "sample string 9",
        "UserText3": "sample string 10"
      },
      {
        "LineId": 1,
        "LineNumber": 1,
        "ItemNumber": "sample string 2",
        "ItemDescription": "sample string 3",
        "Quantity": 4.0,
        "UnitOfMeasure": "sample string 5",
        "UnitPrice": 6.0,
        "LineTotal": 7.0,
        "UserText1": "sample string 8",
        "UserText2": "sample string 9",
        "UserText3": "sample string 10"
      }
    ],
    "DetailAmounts": [
      {
        "Amount": 1.0,
        "DetailType": "sample string 1",
        "Description": "sample string 2"
      },
      {
        "Amount": 1.0,
        "DetailType": "sample string 1",
        "Description": "sample string 2"
      }
    ],
    "Distributions": [
      {
        "Segment1": "sample string 1",
        "Segment2": "sample string 2",
        "Segment3": "sample string 3",
        "Segment4": "sample string 4",
        "Segment5": "sample string 5",
        "Segment6": "sample string 6",
        "Segment7": "sample string 7",
        "Segment8": "sample string 8",
        "Segment9": "sample string 9",
        "Segment10": "sample string 10",
        "Amount": 11.0,
        "Notes": "sample string 12",
        "AssignedByName": "sample string 13",
        "DistributionContext": "sample string 14"
      },
      {
        "Segment1": "sample string 1",
        "Segment2": "sample string 2",
        "Segment3": "sample string 3",
        "Segment4": "sample string 4",
        "Segment5": "sample string 5",
        "Segment6": "sample string 6",
        "Segment7": "sample string 7",
        "Segment8": "sample string 8",
        "Segment9": "sample string 9",
        "Segment10": "sample string 10",
        "Amount": 11.0,
        "Notes": "sample string 12",
        "AssignedByName": "sample string 13",
        "DistributionContext": "sample string 14"
      }
    ],
    "Notes": [
      {
        "NoteDate": "2026-09-21T02:44:58.1372167-05:00",
        "NoteText": "sample string 2",
        "Creator": "sample string 3"
      },
      {
        "NoteDate": "2026-09-21T02:44:58.1372167-05:00",
        "NoteText": "sample string 2",
        "Creator": "sample string 3"
      }
    ]
  },
  {
    "AccountingDate": "2026-09-21T02:44:58.1372167-05:00",
    "CheckTotal": 1.0,
    "UserText1": "sample string 2",
    "UserText2": "sample string 3",
    "UserText3": "sample string 4",
    "UserText4": "sample string 5",
    "UserText5": "sample string 6",
    "UserText6": "sample string 7",
    "ClassName": "sample string 8",
    "CompanyCode": "sample string 9",
    "CompanyName": "sample string 10",
    "CreateDate": "2026-09-21T02:44:58.1372167-05:00",
    "CreatedByUser": "sample string 12",
    "Currency": "sample string 13",
    "DocumentID": 14,
    "DocumentGUID": "5317dbed-8e49-439c-ab4b-ba3b9b3d7bf9",
    "Handling": "sample string 16",
    "InvoiceDate": "2026-09-21T02:44:58.1372167-05:00",
    "InvoiceNumber": "sample string 17",
    "LocationCode": "sample string 18",
    "LocationName": "sample string 19",
    "NeedByDate": "2026-09-21T02:44:58.1372167-05:00",
    "PONumber": "sample string 20",
    "Purpose": "sample string 21",
    "Terms": "sample string 22",
    "VendorCode": "sample string 23",
    "VendorName": "sample string 24",
    "RemitAddress1": "sample string 25",
    "RemitAddress2": "sample string 26",
    "RemitCity": "sample string 27",
    "RemitState": "sample string 28",
    "RemitZip": "sample string 29",
    "Lines": [
      {
        "LineId": 1,
        "LineNumber": 1,
        "ItemNumber": "sample string 2",
        "ItemDescription": "sample string 3",
        "Quantity": 4.0,
        "UnitOfMeasure": "sample string 5",
        "UnitPrice": 6.0,
        "LineTotal": 7.0,
        "UserText1": "sample string 8",
        "UserText2": "sample string 9",
        "UserText3": "sample string 10"
      },
      {
        "LineId": 1,
        "LineNumber": 1,
        "ItemNumber": "sample string 2",
        "ItemDescription": "sample string 3",
        "Quantity": 4.0,
        "UnitOfMeasure": "sample string 5",
        "UnitPrice": 6.0,
        "LineTotal": 7.0,
        "UserText1": "sample string 8",
        "UserText2": "sample string 9",
        "UserText3": "sample string 10"
      }
    ],
    "DetailAmounts": [
      {
        "Amount": 1.0,
        "DetailType": "sample string 1",
        "Description": "sample string 2"
      },
      {
        "Amount": 1.0,
        "DetailType": "sample string 1",
        "Description": "sample string 2"
      }
    ],
    "Distributions": [
      {
        "Segment1": "sample string 1",
        "Segment2": "sample string 2",
        "Segment3": "sample string 3",
        "Segment4": "sample string 4",
        "Segment5": "sample string 5",
        "Segment6": "sample string 6",
        "Segment7": "sample string 7",
        "Segment8": "sample string 8",
        "Segment9": "sample string 9",
        "Segment10": "sample string 10",
        "Amount": 11.0,
        "Notes": "sample string 12",
        "AssignedByName": "sample string 13",
        "DistributionContext": "sample string 14"
      },
      {
        "Segment1": "sample string 1",
        "Segment2": "sample string 2",
        "Segment3": "sample string 3",
        "Segment4": "sample string 4",
        "Segment5": "sample string 5",
        "Segment6": "sample string 6",
        "Segment7": "sample string 7",
        "Segment8": "sample string 8",
        "Segment9": "sample string 9",
        "Segment10": "sample string 10",
        "Amount": 11.0,
        "Notes": "sample string 12",
        "AssignedByName": "sample string 13",
        "DistributionContext": "sample string 14"
      }
    ],
    "Notes": [
      {
        "NoteDate": "2026-09-21T02:44:58.1372167-05:00",
        "NoteText": "sample string 2",
        "Creator": "sample string 3"
      },
      {
        "NoteDate": "2026-09-21T02:44:58.1372167-05:00",
        "NoteText": "sample string 2",
        "Creator": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCheckRequestController.CheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <CheckRequestController.CheckRequest>
    <AccountingDate>2026-09-21T02:44:58.1372167-05:00</AccountingDate>
    <CheckTotal>1</CheckTotal>
    <ClassName>sample string 8</ClassName>
    <CompanyCode>sample string 9</CompanyCode>
    <CompanyName>sample string 10</CompanyName>
    <CreateDate>2026-09-21T02:44:58.1372167-05:00</CreateDate>
    <CreatedByUser>sample string 12</CreatedByUser>
    <Currency>sample string 13</Currency>
    <DetailAmounts xmlns:d3p1="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
      <d3p1:DetailAmount>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Description>sample string 2</d3p1:Description>
        <d3p1:DetailType>sample string 1</d3p1:DetailType>
      </d3p1:DetailAmount>
      <d3p1:DetailAmount>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Description>sample string 2</d3p1:Description>
        <d3p1:DetailType>sample string 1</d3p1:DetailType>
      </d3p1:DetailAmount>
    </DetailAmounts>
    <Distributions xmlns:d3p1="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
      <d3p1:Distribution>
        <d3p1:Amount>11</d3p1:Amount>
        <d3p1:AssignedByName>sample string 13</d3p1:AssignedByName>
        <d3p1:DistributionContext>sample string 14</d3p1:DistributionContext>
        <d3p1:Notes>sample string 12</d3p1:Notes>
        <d3p1:Segment1>sample string 1</d3p1:Segment1>
        <d3p1:Segment10>sample string 10</d3p1:Segment10>
        <d3p1:Segment2>sample string 2</d3p1:Segment2>
        <d3p1:Segment3>sample string 3</d3p1:Segment3>
        <d3p1:Segment4>sample string 4</d3p1:Segment4>
        <d3p1:Segment5>sample string 5</d3p1:Segment5>
        <d3p1:Segment6>sample string 6</d3p1:Segment6>
        <d3p1:Segment7>sample string 7</d3p1:Segment7>
        <d3p1:Segment8>sample string 8</d3p1:Segment8>
        <d3p1:Segment9>sample string 9</d3p1:Segment9>
      </d3p1:Distribution>
      <d3p1:Distribution>
        <d3p1:Amount>11</d3p1:Amount>
        <d3p1:AssignedByName>sample string 13</d3p1:AssignedByName>
        <d3p1:DistributionContext>sample string 14</d3p1:DistributionContext>
        <d3p1:Notes>sample string 12</d3p1:Notes>
        <d3p1:Segment1>sample string 1</d3p1:Segment1>
        <d3p1:Segment10>sample string 10</d3p1:Segment10>
        <d3p1:Segment2>sample string 2</d3p1:Segment2>
        <d3p1:Segment3>sample string 3</d3p1:Segment3>
        <d3p1:Segment4>sample string 4</d3p1:Segment4>
        <d3p1:Segment5>sample string 5</d3p1:Segment5>
        <d3p1:Segment6>sample string 6</d3p1:Segment6>
        <d3p1:Segment7>sample string 7</d3p1:Segment7>
        <d3p1:Segment8>sample string 8</d3p1:Segment8>
        <d3p1:Segment9>sample string 9</d3p1:Segment9>
      </d3p1:Distribution>
    </Distributions>
    <DocumentGUID>5317dbed-8e49-439c-ab4b-ba3b9b3d7bf9</DocumentGUID>
    <DocumentID>14</DocumentID>
    <Handling>sample string 16</Handling>
    <InvoiceDate>2026-09-21T02:44:58.1372167-05:00</InvoiceDate>
    <InvoiceNumber>sample string 17</InvoiceNumber>
    <Lines>
      <CheckRequestController.CRLine>
        <ItemDescription>sample string 3</ItemDescription>
        <ItemNumber>sample string 2</ItemNumber>
        <LineId>1</LineId>
        <LineNumber>1</LineNumber>
        <LineTotal>7</LineTotal>
        <Quantity>4</Quantity>
        <UnitOfMeasure>sample string 5</UnitOfMeasure>
        <UnitPrice>6</UnitPrice>
        <UserText1>sample string 8</UserText1>
        <UserText2>sample string 9</UserText2>
        <UserText3>sample string 10</UserText3>
      </CheckRequestController.CRLine>
      <CheckRequestController.CRLine>
        <ItemDescription>sample string 3</ItemDescription>
        <ItemNumber>sample string 2</ItemNumber>
        <LineId>1</LineId>
        <LineNumber>1</LineNumber>
        <LineTotal>7</LineTotal>
        <Quantity>4</Quantity>
        <UnitOfMeasure>sample string 5</UnitOfMeasure>
        <UnitPrice>6</UnitPrice>
        <UserText1>sample string 8</UserText1>
        <UserText2>sample string 9</UserText2>
        <UserText3>sample string 10</UserText3>
      </CheckRequestController.CRLine>
    </Lines>
    <LocationCode>sample string 18</LocationCode>
    <LocationName>sample string 19</LocationName>
    <NeedByDate>2026-09-21T02:44:58.1372167-05:00</NeedByDate>
    <Notes xmlns:d3p1="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
      <d3p1:Note>
        <d3p1:Creator>sample string 3</d3p1:Creator>
        <d3p1:NoteDate>2026-09-21T02:44:58.1372167-05:00</d3p1:NoteDate>
        <d3p1:NoteText>sample string 2</d3p1:NoteText>
      </d3p1:Note>
      <d3p1:Note>
        <d3p1:Creator>sample string 3</d3p1:Creator>
        <d3p1:NoteDate>2026-09-21T02:44:58.1372167-05:00</d3p1:NoteDate>
        <d3p1:NoteText>sample string 2</d3p1:NoteText>
      </d3p1:Note>
    </Notes>
    <PONumber>sample string 20</PONumber>
    <Purpose>sample string 21</Purpose>
    <RemitAddress1>sample string 25</RemitAddress1>
    <RemitAddress2>sample string 26</RemitAddress2>
    <RemitCity>sample string 27</RemitCity>
    <RemitState>sample string 28</RemitState>
    <RemitZip>sample string 29</RemitZip>
    <Terms>sample string 22</Terms>
    <UserText1>sample string 2</UserText1>
    <UserText2>sample string 3</UserText2>
    <UserText3>sample string 4</UserText3>
    <UserText4>sample string 5</UserText4>
    <UserText5>sample string 6</UserText5>
    <UserText6>sample string 7</UserText6>
    <VendorCode>sample string 23</VendorCode>
    <VendorName>sample string 24</VendorName>
  </CheckRequestController.CheckRequest>
  <CheckRequestController.CheckRequest>
    <AccountingDate>2026-09-21T02:44:58.1372167-05:00</AccountingDate>
    <CheckTotal>1</CheckTotal>
    <ClassName>sample string 8</ClassName>
    <CompanyCode>sample string 9</CompanyCode>
    <CompanyName>sample string 10</CompanyName>
    <CreateDate>2026-09-21T02:44:58.1372167-05:00</CreateDate>
    <CreatedByUser>sample string 12</CreatedByUser>
    <Currency>sample string 13</Currency>
    <DetailAmounts xmlns:d3p1="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
      <d3p1:DetailAmount>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Description>sample string 2</d3p1:Description>
        <d3p1:DetailType>sample string 1</d3p1:DetailType>
      </d3p1:DetailAmount>
      <d3p1:DetailAmount>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Description>sample string 2</d3p1:Description>
        <d3p1:DetailType>sample string 1</d3p1:DetailType>
      </d3p1:DetailAmount>
    </DetailAmounts>
    <Distributions xmlns:d3p1="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
      <d3p1:Distribution>
        <d3p1:Amount>11</d3p1:Amount>
        <d3p1:AssignedByName>sample string 13</d3p1:AssignedByName>
        <d3p1:DistributionContext>sample string 14</d3p1:DistributionContext>
        <d3p1:Notes>sample string 12</d3p1:Notes>
        <d3p1:Segment1>sample string 1</d3p1:Segment1>
        <d3p1:Segment10>sample string 10</d3p1:Segment10>
        <d3p1:Segment2>sample string 2</d3p1:Segment2>
        <d3p1:Segment3>sample string 3</d3p1:Segment3>
        <d3p1:Segment4>sample string 4</d3p1:Segment4>
        <d3p1:Segment5>sample string 5</d3p1:Segment5>
        <d3p1:Segment6>sample string 6</d3p1:Segment6>
        <d3p1:Segment7>sample string 7</d3p1:Segment7>
        <d3p1:Segment8>sample string 8</d3p1:Segment8>
        <d3p1:Segment9>sample string 9</d3p1:Segment9>
      </d3p1:Distribution>
      <d3p1:Distribution>
        <d3p1:Amount>11</d3p1:Amount>
        <d3p1:AssignedByName>sample string 13</d3p1:AssignedByName>
        <d3p1:DistributionContext>sample string 14</d3p1:DistributionContext>
        <d3p1:Notes>sample string 12</d3p1:Notes>
        <d3p1:Segment1>sample string 1</d3p1:Segment1>
        <d3p1:Segment10>sample string 10</d3p1:Segment10>
        <d3p1:Segment2>sample string 2</d3p1:Segment2>
        <d3p1:Segment3>sample string 3</d3p1:Segment3>
        <d3p1:Segment4>sample string 4</d3p1:Segment4>
        <d3p1:Segment5>sample string 5</d3p1:Segment5>
        <d3p1:Segment6>sample string 6</d3p1:Segment6>
        <d3p1:Segment7>sample string 7</d3p1:Segment7>
        <d3p1:Segment8>sample string 8</d3p1:Segment8>
        <d3p1:Segment9>sample string 9</d3p1:Segment9>
      </d3p1:Distribution>
    </Distributions>
    <DocumentGUID>5317dbed-8e49-439c-ab4b-ba3b9b3d7bf9</DocumentGUID>
    <DocumentID>14</DocumentID>
    <Handling>sample string 16</Handling>
    <InvoiceDate>2026-09-21T02:44:58.1372167-05:00</InvoiceDate>
    <InvoiceNumber>sample string 17</InvoiceNumber>
    <Lines>
      <CheckRequestController.CRLine>
        <ItemDescription>sample string 3</ItemDescription>
        <ItemNumber>sample string 2</ItemNumber>
        <LineId>1</LineId>
        <LineNumber>1</LineNumber>
        <LineTotal>7</LineTotal>
        <Quantity>4</Quantity>
        <UnitOfMeasure>sample string 5</UnitOfMeasure>
        <UnitPrice>6</UnitPrice>
        <UserText1>sample string 8</UserText1>
        <UserText2>sample string 9</UserText2>
        <UserText3>sample string 10</UserText3>
      </CheckRequestController.CRLine>
      <CheckRequestController.CRLine>
        <ItemDescription>sample string 3</ItemDescription>
        <ItemNumber>sample string 2</ItemNumber>
        <LineId>1</LineId>
        <LineNumber>1</LineNumber>
        <LineTotal>7</LineTotal>
        <Quantity>4</Quantity>
        <UnitOfMeasure>sample string 5</UnitOfMeasure>
        <UnitPrice>6</UnitPrice>
        <UserText1>sample string 8</UserText1>
        <UserText2>sample string 9</UserText2>
        <UserText3>sample string 10</UserText3>
      </CheckRequestController.CRLine>
    </Lines>
    <LocationCode>sample string 18</LocationCode>
    <LocationName>sample string 19</LocationName>
    <NeedByDate>2026-09-21T02:44:58.1372167-05:00</NeedByDate>
    <Notes xmlns:d3p1="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
      <d3p1:Note>
        <d3p1:Creator>sample string 3</d3p1:Creator>
        <d3p1:NoteDate>2026-09-21T02:44:58.1372167-05:00</d3p1:NoteDate>
        <d3p1:NoteText>sample string 2</d3p1:NoteText>
      </d3p1:Note>
      <d3p1:Note>
        <d3p1:Creator>sample string 3</d3p1:Creator>
        <d3p1:NoteDate>2026-09-21T02:44:58.1372167-05:00</d3p1:NoteDate>
        <d3p1:NoteText>sample string 2</d3p1:NoteText>
      </d3p1:Note>
    </Notes>
    <PONumber>sample string 20</PONumber>
    <Purpose>sample string 21</Purpose>
    <RemitAddress1>sample string 25</RemitAddress1>
    <RemitAddress2>sample string 26</RemitAddress2>
    <RemitCity>sample string 27</RemitCity>
    <RemitState>sample string 28</RemitState>
    <RemitZip>sample string 29</RemitZip>
    <Terms>sample string 22</Terms>
    <UserText1>sample string 2</UserText1>
    <UserText2>sample string 3</UserText2>
    <UserText3>sample string 4</UserText3>
    <UserText4>sample string 5</UserText4>
    <UserText5>sample string 6</UserText5>
    <UserText6>sample string 7</UserText6>
    <VendorCode>sample string 23</VendorCode>
    <VendorName>sample string 24</VendorName>
  </CheckRequestController.CheckRequest>
</ArrayOfCheckRequestController.CheckRequest>