POST ApDisburse/PrintChecks

Print an AP disburse check.

Request Information

URI Parameters

Body Parameters

The AP Disburse object used to be printed.

Name	Description	Type	Additional Information
VendorId	The Vendor ID of the disbursement.	string	Required Max length: 10
MemoCheck	Print memo checks	boolean	Required
PostNextMonth	Post to next month	boolean	Required
CheckDate	The date of the check.	string	Required Data type: DateTime Format must be MM/dd/yyyy
CheckingAccount	The checking account number.	string	Required
LocationId	The LocationID for transaction posting	string	Required Max length: 6
StartingCheckNumber	The Starting Check Number.	integer	Required
Invoices	The invoice Numbers of the disbursement to be printed.	Collection of InvoiceDetail	Required
TopMargin	Can be used to match the Agvance User Setting for the top margin. If TopMargin is not provided, the top margin from the accounting preference will be used if it exists.	decimal number
PreCheckRun	Tells API whether to run precheck or not	boolean
CreateCheckAsTextFile	Tells the API to create a Text or PDF check. True = Text, False = PDF, Default = False	boolean

Request Formats

application/json, text/json

Sample:

{
  "VendorId": "sample string 1",
  "MemoCheck": true,
  "PostNextMonth": true,
  "CheckDate": "sample string 4",
  "CheckingAccount": "sample string 5",
  "LocationId": "sample string 6",
  "StartingCheckNumber": 7,
  "Invoices": [
    {
      "InvoiceNum": "sample string 1",
      "Discount": 2.1,
      "Payment": 3.1
    },
    {
      "InvoiceNum": "sample string 1",
      "Discount": 2.1,
      "Payment": 3.1
    }
  ],
  "TopMargin": 1.1,
  "PreCheckRun": true,
  "CreateCheckAsTextFile": true
}

application/xml, text/xml

Sample:

<APDisbursePrintChecks xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AP">
  <CheckDate>sample string 4</CheckDate>
  <CheckingAccount>sample string 5</CheckingAccount>
  <CreateCheckAsTextFile>true</CreateCheckAsTextFile>
  <Invoices>
    <APDisburseInvoiceDetail>
      <Discount>2.1</Discount>
      <InvoiceNum>sample string 1</InvoiceNum>
      <Payment>3.1</Payment>
    </APDisburseInvoiceDetail>
    <APDisburseInvoiceDetail>
      <Discount>2.1</Discount>
      <InvoiceNum>sample string 1</InvoiceNum>
      <Payment>3.1</Payment>
    </APDisburseInvoiceDetail>
  </Invoices>
  <LocationId>sample string 6</LocationId>
  <MemoCheck>true</MemoCheck>
  <PostNextMonth>true</PostNextMonth>
  <PreCheckRun>true</PreCheckRun>
  <StartingCheckNumber>7</StartingCheckNumber>
  <TopMargin>1.1</TopMargin>
  <VendorId>sample string 1</VendorId>
</APDisbursePrintChecks>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'clsApDisbursePrintChecks'.

Response Information

Resource Description

Print an AP disburse check.

AgvApDisbursePrintChecks

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
ErrorList	List of error messages of the API call.	Collection of string
WarningList	List of warning messages of the API call.	Collection of string
Documents	List of presigned url of the checks	Collection of ApDisburseDocument

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Documents": [
    {
      "Key": "sample string 1",
      "VendorId": "sample string 2",
      "PreSignedUrl": "sample string 3"
    },
    {
      "Key": "sample string 1",
      "VendorId": "sample string 2",
      "PreSignedUrl": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvApDisbursePrintChecks xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vendor">
  <Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AP">
    <d2p1:APDisburseDocument>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:PreSignedUrl>sample string 3</d2p1:PreSignedUrl>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:APDisburseDocument>
    <d2p1:APDisburseDocument>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:PreSignedUrl>sample string 3</d2p1:PreSignedUrl>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:APDisburseDocument>
  </Documents>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvApDisbursePrintChecks>