POST api/ApnInvoicing/Search

Request Information

URI Parameters

None.

Body Parameters

InvoiceSearchRequest
NameDescriptionTypeAdditional information
InvoiceID

integer

None.

InvoiceGroupID

integer

None.

FromDate

date

None.

ToDate

date

None.

FromAmount

decimal number

None.

ToAmount

decimal number

None.

ChangeType

integer

None.

ChangeFromDate

date

None.

ChangeToDate

date

None.

ChangedByContactIDs

Collection of integer

None.

AccountingBatchIDs

string

None.

ParentEntityIDs

Collection of integer

None.

EntityIDs

Collection of integer

None.

Emailed

boolean

None.

EmailedFromDate

date

None.

EmailedToDate

date

None.

TrustTransferMethodIDs

Collection of integer

None.

DeliveryMethodIDs

Collection of integer

None.

BusinessIDs

Collection of integer

None.

PaymentToSelection

integer

None.

ShowInactive

boolean

None.

Top

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceID": 1,
  "InvoiceGroupID": 1,
  "FromDate": "2026-11-18T13:30:24.5034882+00:00",
  "ToDate": "2026-11-18T13:30:24.5034882+00:00",
  "FromAmount": 1.0,
  "ToAmount": 1.0,
  "ChangeType": 1,
  "ChangeFromDate": "2026-11-18T13:30:24.5034882+00:00",
  "ChangeToDate": "2026-11-18T13:30:24.5034882+00:00",
  "ChangedByContactIDs": [
    1,
    2
  ],
  "AccountingBatchIDs": "sample string 1",
  "ParentEntityIDs": [
    1,
    2
  ],
  "EntityIDs": [
    1,
    2
  ],
  "Emailed": true,
  "EmailedFromDate": "2026-11-18T13:30:24.5034882+00:00",
  "EmailedToDate": "2026-11-18T13:30:24.5034882+00:00",
  "TrustTransferMethodIDs": [
    1,
    2
  ],
  "DeliveryMethodIDs": [
    1,
    2
  ],
  "BusinessIDs": [
    1,
    2
  ],
  "PaymentToSelection": 1,
  "ShowInactive": true,
  "Top": 1
}

application/xml, text/xml

Sample:
<InvoiceSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Invoicing">
  <AccountingBatchIDs>sample string 1</AccountingBatchIDs>
  <BusinessIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BusinessIDs>
  <ChangeFromDate>2026-11-18T13:30:24.5034882+00:00</ChangeFromDate>
  <ChangeToDate>2026-11-18T13:30:24.5034882+00:00</ChangeToDate>
  <ChangeType>1</ChangeType>
  <ChangedByContactIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ChangedByContactIDs>
  <DeliveryMethodIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DeliveryMethodIDs>
  <Emailed>true</Emailed>
  <EmailedFromDate>2026-11-18T13:30:24.5034882+00:00</EmailedFromDate>
  <EmailedToDate>2026-11-18T13:30:24.5034882+00:00</EmailedToDate>
  <EntityIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EntityIDs>
  <FromAmount>1</FromAmount>
  <FromDate>2026-11-18T13:30:24.5034882+00:00</FromDate>
  <InvoiceGroupID>1</InvoiceGroupID>
  <InvoiceID>1</InvoiceID>
  <ParentEntityIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ParentEntityIDs>
  <PaymentToSelection>1</PaymentToSelection>
  <ShowInactive>true</ShowInactive>
  <ToAmount>1</ToAmount>
  <ToDate>2026-11-18T13:30:24.5034882+00:00</ToDate>
  <Top>1</Top>
  <TrustTransferMethodIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TrustTransferMethodIDs>
</InvoiceSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResultOfListOfDictionaryOfStringAndObject
NameDescriptionTypeAdditional information
Response

ApiResponse

None.

Data

Collection of Dictionary of string [key] and Object [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": {
    "Success": true,
    "ErrorMessage": "sample string 2"
  },
  "Data": [
    {
      "sample string 1": {},
      "sample string 3": {}
    },
    {
      "sample string 1": {},
      "sample string 3": {}
    }
  ]
}

application/xml, text/xml

Sample:
<ApiResultOfArrayOfArrayOfKeyValueOfstringanyTypeuHEDJ7Dj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
  </Data>
  <Response>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Success>true</Success>
  </Response>
</ApiResultOfArrayOfArrayOfKeyValueOfstringanyTypeuHEDJ7Dj>