POST ApDisburse/AchPayment

Make an ACH payment.

Request Information

URI Parameters

Body Parameters

The AP Disburse object used for the ACH Payment.

Name	Description	Type	Additional Information
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
EmailACHPaymentAdviceToVendor	Determine if the payment advice report will be sent to the vendor. If not provided, the agvance preference will be used.	boolean
Vendors	The Vendors to be included and their invoices.	Collection of AchVendor	Required
PreCheckRun	Tells api whether to run precheck or not	boolean

Request Formats

application/json, text/json

Sample:

{
  "PostNextMonth": true,
  "CheckDate": "sample string 2",
  "CheckingAccount": "sample string 3",
  "LocationId": "sample string 4",
  "StartingCheckNumber": 5,
  "EmailACHPaymentAdviceToVendor": true,
  "Vendors": [
    {
      "VendorId": "sample string 1",
      "Invoices": [
        {
          "InvoiceNum": "sample string 1",
          "Discount": 2.1,
          "Payment": 3.1
        },
        {
          "InvoiceNum": "sample string 1",
          "Discount": 2.1,
          "Payment": 3.1
        }
      ]
    },
    {
      "VendorId": "sample string 1",
      "Invoices": [
        {
          "InvoiceNum": "sample string 1",
          "Discount": 2.1,
          "Payment": 3.1
        },
        {
          "InvoiceNum": "sample string 1",
          "Discount": 2.1,
          "Payment": 3.1
        }
      ]
    }
  ],
  "PreCheckRun": true
}

application/xml, text/xml

Sample:

<APDisburseACHPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AP">
  <CheckDate>sample string 2</CheckDate>
  <CheckingAccount>sample string 3</CheckingAccount>
  <EmailACHPaymentAdviceToVendor>true</EmailACHPaymentAdviceToVendor>
  <LocationId>sample string 4</LocationId>
  <PostNextMonth>true</PostNextMonth>
  <PreCheckRun>true</PreCheckRun>
  <StartingCheckNumber>5</StartingCheckNumber>
  <Vendors>
    <APDisburseAchVendor>
      <Invoices>
        <APDisburseAchInvoiceDetail>
          <Discount>2.1</Discount>
          <InvoiceNum>sample string 1</InvoiceNum>
          <Payment>3.1</Payment>
        </APDisburseAchInvoiceDetail>
        <APDisburseAchInvoiceDetail>
          <Discount>2.1</Discount>
          <InvoiceNum>sample string 1</InvoiceNum>
          <Payment>3.1</Payment>
        </APDisburseAchInvoiceDetail>
      </Invoices>
      <VendorId>sample string 1</VendorId>
    </APDisburseAchVendor>
    <APDisburseAchVendor>
      <Invoices>
        <APDisburseAchInvoiceDetail>
          <Discount>2.1</Discount>
          <InvoiceNum>sample string 1</InvoiceNum>
          <Payment>3.1</Payment>
        </APDisburseAchInvoiceDetail>
        <APDisburseAchInvoiceDetail>
          <Discount>2.1</Discount>
          <InvoiceNum>sample string 1</InvoiceNum>
          <Payment>3.1</Payment>
        </APDisburseAchInvoiceDetail>
      </Invoices>
      <VendorId>sample string 1</VendorId>
    </APDisburseAchVendor>
  </Vendors>
</APDisburseACHPayment>

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 'clsApDisburseAchPayment'.

Response Information

Resource Description

Make an ACH payment.

AgvApDisburseAchPayment

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:

<AgvApDisburseAchPayment 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>
</AgvApDisburseAchPayment>