POST api/Payment

Record payments

Request Information

URI Parameters

None.

Body Parameters

List of 1 or more payment records

Collection of PaymentRecord

Name	Description	Type	Additional information
ClientId	Client Id	integer	None.
DocumentID	Document ID	integer	None.
DocumentType	Document Type: 1 = Invoice, 2 = Check Request, 10 = Travel Expense	integer	None.
ERPReferenceID	ERP Reference ID	string	None.
VoucherNumber	Voucher Number	string	None.
PaymentNumber	Check Number or other payment unique identifier	string	None.
PaymentDate	Payment Date	date	None.
PaymentAmount	Payment amount applied to invoice	decimal number	None.
IsValid	Flag indicating payment was process successfully	boolean	None.
ErrorMessage	If an error was encountered the reason will be provided here	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ClientId": 1,
    "DocumentID": 2,
    "DocumentType": 3,
    "ERPReferenceID": "sample string 4",
    "VoucherNumber": "sample string 5",
    "PaymentNumber": "sample string 6",
    "PaymentDate": "2026-09-21T02:44:16.5338576-05:00",
    "PaymentAmount": 8.0,
    "IsValid": true,
    "ErrorMessage": "sample string 10"
  },
  {
    "ClientId": 1,
    "DocumentID": 2,
    "DocumentType": 3,
    "ERPReferenceID": "sample string 4",
    "VoucherNumber": "sample string 5",
    "PaymentNumber": "sample string 6",
    "PaymentDate": "2026-09-21T02:44:16.5338576-05:00",
    "PaymentAmount": 8.0,
    "IsValid": true,
    "ErrorMessage": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentController.PaymentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <PaymentController.PaymentRecord>
    <ClientId>1</ClientId>
    <DocumentID>2</DocumentID>
    <DocumentType>3</DocumentType>
    <ERPReferenceID>sample string 4</ERPReferenceID>
    <ErrorMessage>sample string 10</ErrorMessage>
    <IsValid>true</IsValid>
    <PaymentAmount>8</PaymentAmount>
    <PaymentDate>2026-09-21T02:44:16.5338576-05:00</PaymentDate>
    <PaymentNumber>sample string 6</PaymentNumber>
    <VoucherNumber>sample string 5</VoucherNumber>
  </PaymentController.PaymentRecord>
  <PaymentController.PaymentRecord>
    <ClientId>1</ClientId>
    <DocumentID>2</DocumentID>
    <DocumentType>3</DocumentType>
    <ERPReferenceID>sample string 4</ERPReferenceID>
    <ErrorMessage>sample string 10</ErrorMessage>
    <IsValid>true</IsValid>
    <PaymentAmount>8</PaymentAmount>
    <PaymentDate>2026-09-21T02:44:16.5338576-05:00</PaymentDate>
    <PaymentNumber>sample string 6</PaymentNumber>
    <VoucherNumber>sample string 5</VoucherNumber>
  </PaymentController.PaymentRecord>
</ArrayOfPaymentController.PaymentRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of payments with an update value for IsValid and an Error Message if there were errors

Collection of PaymentRecord

Name	Description	Type	Additional information
ClientId	Client Id	integer	None.
DocumentID	Document ID	integer	None.
DocumentType	Document Type: 1 = Invoice, 2 = Check Request, 10 = Travel Expense	integer	None.
ERPReferenceID	ERP Reference ID	string	None.
VoucherNumber	Voucher Number	string	None.
PaymentNumber	Check Number or other payment unique identifier	string	None.
PaymentDate	Payment Date	date	None.
PaymentAmount	Payment amount applied to invoice	decimal number	None.
IsValid	Flag indicating payment was process successfully	boolean	None.
ErrorMessage	If an error was encountered the reason will be provided here	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientId": 1,
    "DocumentID": 2,
    "DocumentType": 3,
    "ERPReferenceID": "sample string 4",
    "VoucherNumber": "sample string 5",
    "PaymentNumber": "sample string 6",
    "PaymentDate": "2026-09-21T02:44:16.5388633-05:00",
    "PaymentAmount": 8.0,
    "IsValid": true,
    "ErrorMessage": "sample string 10"
  },
  {
    "ClientId": 1,
    "DocumentID": 2,
    "DocumentType": 3,
    "ERPReferenceID": "sample string 4",
    "VoucherNumber": "sample string 5",
    "PaymentNumber": "sample string 6",
    "PaymentDate": "2026-09-21T02:44:16.5388633-05:00",
    "PaymentAmount": 8.0,
    "IsValid": true,
    "ErrorMessage": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentController.PaymentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <PaymentController.PaymentRecord>
    <ClientId>1</ClientId>
    <DocumentID>2</DocumentID>
    <DocumentType>3</DocumentType>
    <ERPReferenceID>sample string 4</ERPReferenceID>
    <ErrorMessage>sample string 10</ErrorMessage>
    <IsValid>true</IsValid>
    <PaymentAmount>8</PaymentAmount>
    <PaymentDate>2026-09-21T02:44:16.5388633-05:00</PaymentDate>
    <PaymentNumber>sample string 6</PaymentNumber>
    <VoucherNumber>sample string 5</VoucherNumber>
  </PaymentController.PaymentRecord>
  <PaymentController.PaymentRecord>
    <ClientId>1</ClientId>
    <DocumentID>2</DocumentID>
    <DocumentType>3</DocumentType>
    <ERPReferenceID>sample string 4</ERPReferenceID>
    <ErrorMessage>sample string 10</ErrorMessage>
    <IsValid>true</IsValid>
    <PaymentAmount>8</PaymentAmount>
    <PaymentDate>2026-09-21T02:44:16.5388633-05:00</PaymentDate>
    <PaymentNumber>sample string 6</PaymentNumber>
    <VoucherNumber>sample string 5</VoucherNumber>
  </PaymentController.PaymentRecord>
</ArrayOfPaymentController.PaymentRecord>