POST api/recurringinvoices/runinvoices

POST api/recurringinvoices/runinvoices Look for eligible recurring invoices and process them

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Assessmentdate	Requird, assessment date is used to determine elegible rec. invoices.	date	Required
Superentityid	Optional, this is used to process a specific Super Entity's rec. invoices	integer	None.
RecurringInvoiceIds	Optional, option to process only an specific subset of recurring invoices.	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "assessmentdate": "2025-04-03T17:54:55.5834341-04:00",
  "superentityid": 1,
  "recurringInvoiceIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<RecurringInvoicesRunParamsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Assessmentdate>2025-04-03T17:54:55.5834341-04:00</Assessmentdate>
  <RecurringInvoiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RecurringInvoiceIds>
  <Superentityid>1</Superentityid>
</RecurringInvoicesRunParamsViewModel>

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

Response Information

Resource Description

RecurringInvoiceResultModel

Name	Type	Additional information
RecurringInvoiceIds	Collection of integer	None.
InvoiceIds	Collection of integer	None.
CheckIds	Collection of integer	None.
JournalEntryIds	Collection of integer	None.
CheckJournalEntryIds	Collection of integer	None.
Error	string	None.
BadList	Dictionary of integer [key] and Collection of string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "recurringInvoiceIds": [
    1,
    2
  ],
  "invoiceIds": [
    1,
    2
  ],
  "checkIds": [
    1,
    2
  ],
  "journalEntryIds": [
    1,
    2
  ],
  "checkJournalEntryIds": [
    1,
    2
  ],
  "error": "sample string 1",
  "badList": {
    "1": [
      "sample string 1",
      "sample string 2"
    ],
    "2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<RecurringInvoiceResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Core.Models">
  <BadList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
      <d2p1:Key>2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
  </BadList>
  <CheckIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CheckIds>
  <CheckJournalEntryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CheckJournalEntryIds>
  <Error>sample string 1</Error>
  <InvoiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </InvoiceIds>
  <JournalEntryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </JournalEntryIds>
  <RecurringInvoiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RecurringInvoiceIds>
</RecurringInvoiceResultModel>