POST api/ApnInvoicing/MassGenerate

Request Information

URI Parameters

None.

Body Parameters

MassInvoiceEntityRequest
NameDescriptionTypeAdditional information
InvoiceGroupID

integer

None.

EntityID

integer

None.

SubEntitySelection

string

None.

Terms

integer

None.

IssueDateFromInvoiceTo

boolean

None.

InvoiceTemplateID

integer

None.

CreditNoteTemplateID

integer

None.

InvoiceFrom

date

None.

InvoiceTo

date

None.

SiteIDs

Collection of integer

None.

BusinessIDs

Collection of integer

None.

FrequencyIDs

Collection of integer

None.

IncludePayments

boolean

None.

IncludeCosts

boolean

None.

IncludeBillableTime

boolean

None.

IncludeEntityCosts

boolean

None.

IncludeEntityAdjustments

boolean

None.

PaymentToSelection

integer

None.

UseAllocationDate

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceGroupID": 1,
  "EntityID": 2,
  "SubEntitySelection": "sample string 3",
  "Terms": 1,
  "IssueDateFromInvoiceTo": true,
  "InvoiceTemplateID": 1,
  "CreditNoteTemplateID": 1,
  "InvoiceFrom": "2026-11-18T13:30:27.5973932+00:00",
  "InvoiceTo": "2026-11-18T13:30:27.5973932+00:00",
  "SiteIDs": [
    1,
    2
  ],
  "BusinessIDs": [
    1,
    2
  ],
  "FrequencyIDs": [
    1,
    2
  ],
  "IncludePayments": true,
  "IncludeCosts": true,
  "IncludeBillableTime": true,
  "IncludeEntityCosts": true,
  "IncludeEntityAdjustments": true,
  "PaymentToSelection": 1,
  "UseAllocationDate": true
}

application/xml, text/xml

Sample:
<MassInvoiceEntityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Invoicing">
  <BusinessIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BusinessIDs>
  <FrequencyIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FrequencyIDs>
  <IncludeBillableTime>true</IncludeBillableTime>
  <IncludeCosts>true</IncludeCosts>
  <IncludeEntityAdjustments>true</IncludeEntityAdjustments>
  <IncludeEntityCosts>true</IncludeEntityCosts>
  <IncludePayments>true</IncludePayments>
  <InvoiceFrom>2026-11-18T13:30:27.5973932+00:00</InvoiceFrom>
  <InvoiceTo>2026-11-18T13:30:27.5973932+00:00</InvoiceTo>
  <PaymentToSelection>1</PaymentToSelection>
  <SiteIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SiteIDs>
  <UseAllocationDate>true</UseAllocationDate>
  <CreditNoteTemplateID>1</CreditNoteTemplateID>
  <EntityID>2</EntityID>
  <InvoiceGroupID>1</InvoiceGroupID>
  <InvoiceTemplateID>1</InvoiceTemplateID>
  <IssueDateFromInvoiceTo>true</IssueDateFromInvoiceTo>
  <SubEntitySelection>sample string 3</SubEntitySelection>
  <Terms>1</Terms>
</MassInvoiceEntityRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResultOfMassInvoiceEntityResult
NameDescriptionTypeAdditional information
Response

ApiResponse

None.

Data

MassInvoiceEntityResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": {
    "Success": true,
    "ErrorMessage": "sample string 2"
  },
  "Data": {
    "EntityID": 1,
    "InvoiceID": 1,
    "CreditNoteID": 1
  }
}

application/xml, text/xml

Sample:
<ApiResultOfMassInvoiceEntityResulttq7NQ_Pm_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Invoicing">
    <d2p1:CreditNoteID>1</d2p1:CreditNoteID>
    <d2p1:EntityID>1</d2p1:EntityID>
    <d2p1:InvoiceID>1</d2p1:InvoiceID>
  </Data>
  <Response>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Success>true</Success>
  </Response>
</ApiResultOfMassInvoiceEntityResulttq7NQ_Pm_P>