POST Payments/Payment/{paymentID}/PaymentInvoice

Request Information

URI Parameters

Name	Description	Type	Additional information
paymentID		integer	Required

Body Parameters

FindPaymentInvoiceCriteria

Name	Type	Additional information
BusinessUnits	Collection of integer	None.
Invoices	Collection of integer	None.
InvoiceNumber	string	None.
InvoicesToExclude	Collection of integer	None.
SelectedInvoices	Collection of integer	None.
ClientName	NameDTO	None.
PaymentMethod	PaymentMethod	None.
EndDate	date	None.
ResidentTypes	Collection of string	None.
FunderIDs	Collection of integer	None.
Skip	integer	None.
Limit	integer	None.
IncludeClientWithNoBankAccount	boolean	None.
ExcludePaymentMethod	boolean	None.
BusinessUnitStatusTypes	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "businessUnits": [
    1,
    2
  ],
  "invoices": [
    1,
    2
  ],
  "invoiceNumber": "sample string 1",
  "invoicesToExclude": [
    1,
    2
  ],
  "selectedInvoices": [
    1,
    2
  ],
  "clientName": {
    "lastName": "sample string 1",
    "firstName": "sample string 2",
    "preferredName": "sample string 3",
    "middleName": "sample string 4",
    "prefix": "sample string 5",
    "suffix": "sample string 6",
    "summary": "sample string 1, sample string 2 (sample string 3)"
  },
  "paymentMethod": 10,
  "endDate": "2024-12-04T07:45:03.5391547+00:00",
  "residentTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "funderIDs": [
    1,
    2
  ],
  "skip": 2,
  "limit": 3,
  "includeClientWithNoBankAccount": true,
  "excludePaymentMethod": true,
  "businessUnitStatusTypes": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<FindPaymentInvoiceCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Billings.Models.Criteria">
  <BusinessUnitStatusTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BusinessUnitStatusTypes>
  <BusinessUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BusinessUnits>
  <ClientName xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:LastName>sample string 1</d2p1:LastName>
    <d2p1:MiddleName>sample string 4</d2p1:MiddleName>
    <d2p1:PreferredName>sample string 3</d2p1:PreferredName>
    <d2p1:Prefix>sample string 5</d2p1:Prefix>
    <d2p1:Suffix>sample string 6</d2p1:Suffix>
  </ClientName>
  <EndDate>2024-12-04T07:45:03.5391547+00:00</EndDate>
  <ExcludePaymentMethod>true</ExcludePaymentMethod>
  <FunderIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FunderIDs>
  <IncludeClientWithNoBankAccount>true</IncludeClientWithNoBankAccount>
  <InvoiceNumber>sample string 1</InvoiceNumber>
  <Invoices xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Invoices>
  <InvoicesToExclude xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </InvoicesToExclude>
  <Limit>3</Limit>
  <PaymentMethod>Cash</PaymentMethod>
  <ResidentTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ResidentTypes>
  <SelectedInvoices xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SelectedInvoices>
  <Skip>2</Skip>
</FindPaymentInvoiceCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

�uRKN�0�J��9?*�ʢ*$�X n�B�j;�?�UՓ��H\7-Ұ�<��g����&3oQ����%�9�ӗ��~������W30��U#!�Π~�r�ַ�Rz?�$�ĸ+ZJ�&\�Hn���
�?h��@ƀ�ed��P	�p���T����h!��Y�����c�l�V�R!�;p�Z�И�#�&S��$�|J�,/�΋�2)�����`��E�����'�nX!��kf<:a���D�BGX���-��	�|R_s��*���@q�C������Cv��������v��Cn:�~

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/x-compressed-json

Sample:

Sample not available.