GET V2/odata/OverviewInvoice

Gets OverviewInvoice entities

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of QicsUnity.Api.Areas.V2.Models.OverviewInvoice

Name	Description	Type	Additional information
InvoiceHeaderId	Gets or sets InvoiceHeaderId	integer	64-bit signed integer
AsyncServerCommandId	Gets or sets AsyncServerCommandId	integer	64-bit signed integer
InvoiceNumber	Gets or sets InvoiceNumber	string	None.
InvoiceHeaderState	Gets or sets InvoiceHeaderState	QicsUnity.Api.Areas.V2.Models.InvoiceHeaderState	None.
InvoiceDate	Gets or sets InvoiceDate	date	date and time of day Nullable
WorkInProgressDate	Gets or sets WorkInProgressDate	date	date and time of day
CustomerId	Gets or sets CustomerCompany.CustomerId	integer	64-bit signed integer
CustomerName	Gets or sets CustomerCompany.Customer.Name	string	None.
CustomerCompanyCustomerCode	Gets or sets CustomerCompany.CustomerCode	string	None.
InvoiceCustomerId	Gets or sets InvoiceCustomerCompany.CustomerId	integer	64-bit signed integer
InvoiceCustomerName	Gets or sets InvoiceCustomerCompany.Customer.Name	string	None.
InvoiceCustomerCompanyCustomerCode	Gets or sets InvoiceCustomerCompany.CustomerCode	string	None.
CustomerCategoryId	Gets or sets CustomerCompany.Customer.CategoryId	integer	64-bit signed integer Nullable
CustomerCategoryName	Gets or sets CustomerCompany.Customer.Category.Name	string	None.
ProjectCategoryId	Gets or sets project category id	integer	64-bit signed integer Nullable
ProjectCategoryName	Gets or sets project category name	string	None.
ProjectId	Gets or sets project id	integer	64-bit signed integer Nullable
ProjectName	Gets or sets project name	string	None.
ProjectCode	Gets or sets project code	string	None.
ProjectStateId	Gets or sets project state id	integer	64-bit signed integer Nullable
ProjectStateName	Gets or sets project state name	string	None.
ProjectManagerResourceName	Gets or sets project manager (resource) name	string	None.
ProjectManagerResourceId	Gets or sets project manager (resource) id	integer	64-bit signed integer Nullable
ProjectEndDate	Gets or sets project end date	date	date and time of day Nullable
ProjectDescription	Gets or sets project description	string	None.
AccountManagerResourceCompanyId	Gets or sets AccountManagerResourceCompanyId	integer	64-bit signed integer Nullable
AccountManagerName	Gets or sets CustomerCompany.Customer.Name	string	None.
TotalAmount	Gets or sets TotalAmount (amount with irregularity and surcharges but without vat)	decimal number	None.
OriginalAmount	Gets or sets OriginalAmount	decimal number	None.
AddedAmount	Gets or sets AddedValue	decimal number	None.
DeductedAmount	Gets or sets DeductedValue	decimal number	None.
InvoiceNotes	Gets or sets InvoiceNotes	string	None.
InvoiceText	Gets or sets InvoiceText	string	None.
ContactPerson	Gets or sets ContactPerson	string	None.
InvoiceReference	Gets or sets InvoiceReference	string	None.
CurrencyId	Gets or sets CurrencyId	integer	64-bit signed integer
CurrencySymbol	Gets or sets Currency.Symbol	string	None.
CurrencyCode	Gets or sets Currency.Code	string	None.
CompanyName	Gets or sets CustomerCompany.Company.Name	string	None.
CompanyCode	Gets or sets CustomerCompany.Company.CompanyCode	string	None.
CompanyId	Gets or sets CustomerCompany.CompanyId	integer	64-bit signed integer
CreatedOn	Gets or sets CreatedOn	date	date and time of day, relative to Coordinated Universal Time (UTC)
CreatedBy	Gets or sets CreatedBy	string	None.
ModifiedOn	Gets or sets ModifiedOn	date	date and time of day, relative to Coordinated Universal Time (UTC)
ModifiedBy	Gets or sets ModifiedBy	string	None.
RejectionReason	Gets or sets RejectionReason	string	None.
InvoiceMutationReasonId	Gets or sets InvoiceMutationReasonId (useful for deduct functionality)	integer	64-bit signed integer Nullable
DeductIt	Gets or sets a value indicating whether this invoice should be decuted - when set to true, server knows it should deduct all invoice lines	boolean	None.
InvoiceProcessingBatchId	Gets or sets invoice processing batch id	integer	64-bit signed integer Nullable
ProcessingFailureReason	Gets or sets ProcessingFailureReason	string	None.
InvoiceHeaderType	Gets or sets InvoiceHeaderType	QicsUnity.Api.Areas.V2.Models.InvoiceHeaderType	None.
OriginalInvoiceHeaderId	Gets or sets InvoiceHeader.OriginalInvoiceHeaderId	integer	64-bit signed integer Nullable
OriginalInvoiceNumber	Gets or sets InvoiceHeader.OriginalInvoiceHeader.InvoiceNumber	string	None.
OriginalInvoiceHeaderState	Gets or sets InvoiceHeader.OriginalInvoiceHeader.InvoiceHeaderState	QicsUnity.Api.Areas.V2.Models.InvoiceHeaderState	Nullable
IsCorrected	Gets or sets a value indicating whether an invoice of type Correction exists for this invoice	boolean	None.
ProcessedInvoicePdf	Gets or sets the processed invoice PDF stream	System.IO.Stream	None.
ProcessedInvoiceXml	Gets or sets the processed invoice XML stream	System.IO.Stream	None.
PaymentConditionId	Gets or sets PaymentConditionId	integer	64-bit signed integer
PaymentConditionName	Gets or sets PaymentCondition.Name	string	None.
PaymentConditionCode	Gets or sets PaymentCondition.Code	string	None.
PaymentTerm	Gets or sets PaymentTerm	integer	None.
PaymentConditionType	Gets or sets PaymentConditionType	QicsUnity.Api.Areas.V2.Models.PaymentConditionType	None.
EntityStateAttemptsCount	Gets or sets EntityState.AttemptsCount	integer	Nullable
EntityStateDataSourceKey	Gets or sets EntityState.DataSourceKey	string	None.
EntityStateFirstAttemptOn	Gets or sets EntityState.FirstAttemptOn	date	date and time of day, relative to Coordinated Universal Time (UTC) Nullable
EntityStateDataSourceDate	Gets or sets EntityState.DataSourceDate	date	date and time of day, relative to Coordinated Universal Time (UTC) Nullable
EntityStateIsError	Gets or sets EntityState.IsError	boolean	Nullable

Response Formats

application/json, text/json

Sample:

[
  {
    "InvoiceHeaderId": "1",
    "AsyncServerCommandId": "2",
    "InvoiceNumber": "sample 3",
    "InvoiceHeaderState": "Proposed",
    "InvoiceDate": "2024-12-22T22:28:42.2962609+00:00",
    "WorkInProgressDate": "2024-12-22T22:28:42.2962609+00:00",
    "CustomerId": "5",
    "CustomerName": "sample 6",
    "CustomerCompanyCustomerCode": "sample 7",
    "InvoiceCustomerId": "8",
    "InvoiceCustomerName": "sample 9",
    "InvoiceCustomerCompanyCustomerCode": "sample 10",
    "CustomerCategoryId": "1",
    "CustomerCategoryName": "sample 11",
    "ProjectCategoryId": "1",
    "ProjectCategoryName": "sample 12",
    "ProjectId": "1",
    "ProjectName": "sample 13",
    "ProjectCode": "sample 14",
    "ProjectStateId": "1",
    "ProjectStateName": "sample 15",
    "ProjectManagerResourceName": "sample 16",
    "ProjectManagerResourceId": "1",
    "ProjectEndDate": "2024-12-22T22:28:42.2962609+00:00",
    "ProjectDescription": "sample 17",
    "AccountManagerResourceCompanyId": "1",
    "AccountManagerName": "sample 18",
    "TotalAmount": "19",
    "OriginalAmount": "20",
    "AddedAmount": "21",
    "DeductedAmount": "22",
    "InvoiceNotes": "sample 23",
    "InvoiceText": "sample 24",
    "ContactPerson": "sample 25",
    "InvoiceReference": "sample 26",
    "CurrencyId": "27",
    "CurrencySymbol": "sample 28",
    "CurrencyCode": "sample 29",
    "CompanyName": "sample 30",
    "CompanyCode": "sample 31",
    "CompanyId": "32",
    "CreatedOn": "2024-12-22T22:28:42.2962609+00:00",
    "CreatedBy": "sample 34",
    "ModifiedOn": "2024-12-22T22:28:42.2962609+00:00",
    "ModifiedBy": "sample 36",
    "RejectionReason": "sample 37",
    "InvoiceMutationReasonId": "1",
    "DeductIt": true,
    "InvoiceProcessingBatchId": "1",
    "ProcessingFailureReason": "sample 39",
    "InvoiceHeaderType": "Normal",
    "OriginalInvoiceHeaderId": "1",
    "OriginalInvoiceNumber": "sample 40",
    "OriginalInvoiceHeaderState": "Proposed",
    "IsCorrected": true,
    "ProcessedInvoicePdf": null,
    "ProcessedInvoiceXml": null,
    "PaymentConditionId": "42",
    "PaymentConditionName": "sample 43",
    "PaymentConditionCode": "sample 44",
    "PaymentTerm": "45",
    "PaymentConditionType": "DirectDebit",
    "EntityStateAttemptsCount": "1",
    "EntityStateDataSourceKey": "sample 46",
    "EntityStateFirstAttemptOn": "2024-12-22T22:28:42.2962609+00:00",
    "EntityStateDataSourceDate": "2024-12-22T22:28:42.2962609+00:00",
    "EntityStateIsError": true
  },
  {
    "InvoiceHeaderId": "1",
    "AsyncServerCommandId": "2",
    "InvoiceNumber": "sample 3",
    "InvoiceHeaderState": "Proposed",
    "InvoiceDate": "2024-12-22T22:28:42.2962609+00:00",
    "WorkInProgressDate": "2024-12-22T22:28:42.2962609+00:00",
    "CustomerId": "5",
    "CustomerName": "sample 6",
    "CustomerCompanyCustomerCode": "sample 7",
    "InvoiceCustomerId": "8",
    "InvoiceCustomerName": "sample 9",
    "InvoiceCustomerCompanyCustomerCode": "sample 10",
    "CustomerCategoryId": "1",
    "CustomerCategoryName": "sample 11",
    "ProjectCategoryId": "1",
    "ProjectCategoryName": "sample 12",
    "ProjectId": "1",
    "ProjectName": "sample 13",
    "ProjectCode": "sample 14",
    "ProjectStateId": "1",
    "ProjectStateName": "sample 15",
    "ProjectManagerResourceName": "sample 16",
    "ProjectManagerResourceId": "1",
    "ProjectEndDate": "2024-12-22T22:28:42.2962609+00:00",
    "ProjectDescription": "sample 17",
    "AccountManagerResourceCompanyId": "1",
    "AccountManagerName": "sample 18",
    "TotalAmount": "19",
    "OriginalAmount": "20",
    "AddedAmount": "21",
    "DeductedAmount": "22",
    "InvoiceNotes": "sample 23",
    "InvoiceText": "sample 24",
    "ContactPerson": "sample 25",
    "InvoiceReference": "sample 26",
    "CurrencyId": "27",
    "CurrencySymbol": "sample 28",
    "CurrencyCode": "sample 29",
    "CompanyName": "sample 30",
    "CompanyCode": "sample 31",
    "CompanyId": "32",
    "CreatedOn": "2024-12-22T22:28:42.2962609+00:00",
    "CreatedBy": "sample 34",
    "ModifiedOn": "2024-12-22T22:28:42.2962609+00:00",
    "ModifiedBy": "sample 36",
    "RejectionReason": "sample 37",
    "InvoiceMutationReasonId": "1",
    "DeductIt": true,
    "InvoiceProcessingBatchId": "1",
    "ProcessingFailureReason": "sample 39",
    "InvoiceHeaderType": "Normal",
    "OriginalInvoiceHeaderId": "1",
    "OriginalInvoiceNumber": "sample 40",
    "OriginalInvoiceHeaderState": "Proposed",
    "IsCorrected": true,
    "ProcessedInvoicePdf": null,
    "ProcessedInvoiceXml": null,
    "PaymentConditionId": "42",
    "PaymentConditionName": "sample 43",
    "PaymentConditionCode": "sample 44",
    "PaymentTerm": "45",
    "PaymentConditionType": "DirectDebit",
    "EntityStateAttemptsCount": "1",
    "EntityStateDataSourceKey": "sample 46",
    "EntityStateFirstAttemptOn": "2024-12-22T22:28:42.2962609+00:00",
    "EntityStateDataSourceDate": "2024-12-22T22:28:42.2962609+00:00",
    "EntityStateIsError": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfOverviewInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V2.Models">
  <OverviewInvoice>
    <AccountManagerName>sample 18</AccountManagerName>
    <AccountManagerResourceCompanyId>1</AccountManagerResourceCompanyId>
    <AddedAmount>21</AddedAmount>
    <AsyncServerCommandId>2</AsyncServerCommandId>
    <CompanyCode>sample 31</CompanyCode>
    <CompanyId>32</CompanyId>
    <CompanyName>sample 30</CompanyName>
    <ContactPerson>sample 25</ContactPerson>
    <CreatedBy>sample 34</CreatedBy>
    <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedOn>
    <CurrencyCode>sample 29</CurrencyCode>
    <CurrencyId>27</CurrencyId>
    <CurrencySymbol>sample 28</CurrencySymbol>
    <CustomerCategoryId>1</CustomerCategoryId>
    <CustomerCategoryName>sample 11</CustomerCategoryName>
    <CustomerCompanyCustomerCode>sample 7</CustomerCompanyCustomerCode>
    <CustomerId>5</CustomerId>
    <CustomerName>sample 6</CustomerName>
    <DeductIt>true</DeductIt>
    <DeductedAmount>22</DeductedAmount>
    <EntityStateAttemptsCount>1</EntityStateAttemptsCount>
    <EntityStateDataSourceDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EntityStateDataSourceDate>
    <EntityStateDataSourceKey>sample 46</EntityStateDataSourceKey>
    <EntityStateFirstAttemptOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EntityStateFirstAttemptOn>
    <EntityStateIsError>true</EntityStateIsError>
    <InvoiceCustomerCompanyCustomerCode>sample 10</InvoiceCustomerCompanyCustomerCode>
    <InvoiceCustomerId>8</InvoiceCustomerId>
    <InvoiceCustomerName>sample 9</InvoiceCustomerName>
    <InvoiceDate>2024-12-22T22:28:42.2962609+00:00</InvoiceDate>
    <InvoiceHeaderId>1</InvoiceHeaderId>
    <InvoiceHeaderState>Proposed</InvoiceHeaderState>
    <InvoiceHeaderType>Normal</InvoiceHeaderType>
    <InvoiceMutationReasonId>1</InvoiceMutationReasonId>
    <InvoiceNotes>sample 23</InvoiceNotes>
    <InvoiceNumber>sample 3</InvoiceNumber>
    <InvoiceProcessingBatchId>1</InvoiceProcessingBatchId>
    <InvoiceReference>sample 26</InvoiceReference>
    <InvoiceText>sample 24</InvoiceText>
    <IsCorrected>true</IsCorrected>
    <ModifiedBy>sample 36</ModifiedBy>
    <ModifiedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </ModifiedOn>
    <OriginalAmount>20</OriginalAmount>
    <OriginalInvoiceHeaderId>1</OriginalInvoiceHeaderId>
    <OriginalInvoiceHeaderState>Proposed</OriginalInvoiceHeaderState>
    <OriginalInvoiceNumber>sample 40</OriginalInvoiceNumber>
    <PaymentConditionCode>sample 44</PaymentConditionCode>
    <PaymentConditionId>42</PaymentConditionId>
    <PaymentConditionName>sample 43</PaymentConditionName>
    <PaymentConditionType>DirectDebit</PaymentConditionType>
    <PaymentTerm>45</PaymentTerm>
    <ProcessedInvoicePdf xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <ProcessedInvoiceXml xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <ProcessingFailureReason>sample 39</ProcessingFailureReason>
    <ProjectCategoryId>1</ProjectCategoryId>
    <ProjectCategoryName>sample 12</ProjectCategoryName>
    <ProjectCode>sample 14</ProjectCode>
    <ProjectDescription>sample 17</ProjectDescription>
    <ProjectEndDate>2024-12-22T22:28:42.2962609+00:00</ProjectEndDate>
    <ProjectId>1</ProjectId>
    <ProjectManagerResourceId>1</ProjectManagerResourceId>
    <ProjectManagerResourceName>sample 16</ProjectManagerResourceName>
    <ProjectName>sample 13</ProjectName>
    <ProjectStateId>1</ProjectStateId>
    <ProjectStateName>sample 15</ProjectStateName>
    <RejectionReason>sample 37</RejectionReason>
    <TotalAmount>19</TotalAmount>
    <WorkInProgressDate>2024-12-22T22:28:42.2962609+00:00</WorkInProgressDate>
  </OverviewInvoice>
  <OverviewInvoice>
    <AccountManagerName>sample 18</AccountManagerName>
    <AccountManagerResourceCompanyId>1</AccountManagerResourceCompanyId>
    <AddedAmount>21</AddedAmount>
    <AsyncServerCommandId>2</AsyncServerCommandId>
    <CompanyCode>sample 31</CompanyCode>
    <CompanyId>32</CompanyId>
    <CompanyName>sample 30</CompanyName>
    <ContactPerson>sample 25</ContactPerson>
    <CreatedBy>sample 34</CreatedBy>
    <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedOn>
    <CurrencyCode>sample 29</CurrencyCode>
    <CurrencyId>27</CurrencyId>
    <CurrencySymbol>sample 28</CurrencySymbol>
    <CustomerCategoryId>1</CustomerCategoryId>
    <CustomerCategoryName>sample 11</CustomerCategoryName>
    <CustomerCompanyCustomerCode>sample 7</CustomerCompanyCustomerCode>
    <CustomerId>5</CustomerId>
    <CustomerName>sample 6</CustomerName>
    <DeductIt>true</DeductIt>
    <DeductedAmount>22</DeductedAmount>
    <EntityStateAttemptsCount>1</EntityStateAttemptsCount>
    <EntityStateDataSourceDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EntityStateDataSourceDate>
    <EntityStateDataSourceKey>sample 46</EntityStateDataSourceKey>
    <EntityStateFirstAttemptOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EntityStateFirstAttemptOn>
    <EntityStateIsError>true</EntityStateIsError>
    <InvoiceCustomerCompanyCustomerCode>sample 10</InvoiceCustomerCompanyCustomerCode>
    <InvoiceCustomerId>8</InvoiceCustomerId>
    <InvoiceCustomerName>sample 9</InvoiceCustomerName>
    <InvoiceDate>2024-12-22T22:28:42.2962609+00:00</InvoiceDate>
    <InvoiceHeaderId>1</InvoiceHeaderId>
    <InvoiceHeaderState>Proposed</InvoiceHeaderState>
    <InvoiceHeaderType>Normal</InvoiceHeaderType>
    <InvoiceMutationReasonId>1</InvoiceMutationReasonId>
    <InvoiceNotes>sample 23</InvoiceNotes>
    <InvoiceNumber>sample 3</InvoiceNumber>
    <InvoiceProcessingBatchId>1</InvoiceProcessingBatchId>
    <InvoiceReference>sample 26</InvoiceReference>
    <InvoiceText>sample 24</InvoiceText>
    <IsCorrected>true</IsCorrected>
    <ModifiedBy>sample 36</ModifiedBy>
    <ModifiedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-22T22:28:42.2962609Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </ModifiedOn>
    <OriginalAmount>20</OriginalAmount>
    <OriginalInvoiceHeaderId>1</OriginalInvoiceHeaderId>
    <OriginalInvoiceHeaderState>Proposed</OriginalInvoiceHeaderState>
    <OriginalInvoiceNumber>sample 40</OriginalInvoiceNumber>
    <PaymentConditionCode>sample 44</PaymentConditionCode>
    <PaymentConditionId>42</PaymentConditionId>
    <PaymentConditionName>sample 43</PaymentConditionName>
    <PaymentConditionType>DirectDebit</PaymentConditionType>
    <PaymentTerm>45</PaymentTerm>
    <ProcessedInvoicePdf xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <ProcessedInvoiceXml xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <ProcessingFailureReason>sample 39</ProcessingFailureReason>
    <ProjectCategoryId>1</ProjectCategoryId>
    <ProjectCategoryName>sample 12</ProjectCategoryName>
    <ProjectCode>sample 14</ProjectCode>
    <ProjectDescription>sample 17</ProjectDescription>
    <ProjectEndDate>2024-12-22T22:28:42.2962609+00:00</ProjectEndDate>
    <ProjectId>1</ProjectId>
    <ProjectManagerResourceId>1</ProjectManagerResourceId>
    <ProjectManagerResourceName>sample 16</ProjectManagerResourceName>
    <ProjectName>sample 13</ProjectName>
    <ProjectStateId>1</ProjectStateId>
    <ProjectStateName>sample 15</ProjectStateName>
    <RejectionReason>sample 37</RejectionReason>
    <TotalAmount>19</TotalAmount>
    <WorkInProgressDate>2024-12-22T22:28:42.2962609+00:00</WorkInProgressDate>
  </OverviewInvoice>
</ArrayOfOverviewInvoice>