GET V2/odata/Invoice({key})

Gets Invoice entity by key

Request Information

URI Parameters

Name	Description	Type	Additional information
key	InvoiceHeaderId from Invoice entity	integer	Required

Body Parameters

None.

Response Information

Resource Description

QicsUnity.Api.Areas.V2.Models.Invoice

Name	Description	Type	Additional information
InvoiceHeaderId	Gets or sets InvoiceHeaderId	integer	Required 64-bit signed integer
AsyncServerCommandId	Gets or sets AsyncServerCommandId	integer	Required 64-bit signed integer
InvoiceNumber	Gets or sets InvoiceNumber	string
InvoiceHeaderState	Gets or sets InvoiceHeaderState	QicsUnity.Api.Areas.V2.Models.InvoiceHeaderState	Required
CurrencyId	Gets or sets CurrencyId	integer	Required 64-bit signed integer
InvoiceDate	Gets or sets InvoiceDate	date	date and time of day Nullable
WorkInProgressDate	Gets or sets WorkInProgressDate	date	Required date and time of day
CustomerCompanyId	Gets or sets CustomerCompanyId	integer	Required 64-bit signed integer
InvoiceCustomerCompanyId	Gets or sets InvoiceCustomerCompanyId	integer	Required 64-bit signed integer
InvoiceNotes	Gets or sets InvoiceNotes	string
InvoiceText	Gets or sets InvoiceText	string
ContactPerson	Gets or sets ContactPerson	string
InvoiceReference	Gets or sets InvoiceReference	string
CreatedOn	Gets or sets CreatedOn	date	Required date and time of day, relative to Coordinated Universal Time (UTC)
RejectionReason	Gets or sets RejectionReason	string
ProcessingFailureReason	Gets or sets ProcessingFailureReason	string
InvoiceHeaderType	Gets or sets InvoiceHeaderType	QicsUnity.Api.Areas.V2.Models.InvoiceHeaderType	Required
OriginalInvoiceHeaderId	Gets or sets InvoiceHeader.OriginalInvoiceHeaderId	integer	64-bit signed integer Nullable
OriginalInvoiceNumber	Gets or sets InvoiceHeader.OriginalInvoiceHeader.InvoiceNumber	string
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
ProcessedInvoicePdf	Gets or sets the processed invoice PDF stream	System.IO.Stream
ProcessedInvoiceXml	Gets or sets the processed invoice XML stream	System.IO.Stream
PaymentConditionId	Gets or sets PaymentConditionId	integer	Required 64-bit signed integer
PaymentTerm	Gets or sets PaymentTerm	integer	Nullable
PaymentConditionType	Gets or sets PaymentConditionType	QicsUnity.Api.Areas.V2.Models.PaymentConditionType	Nullable

Response Formats

application/json, text/json

Sample:

{
  "InvoiceHeaderId": "1",
  "AsyncServerCommandId": "2",
  "InvoiceNumber": "sample 3",
  "InvoiceHeaderState": "Proposed",
  "CurrencyId": "4",
  "InvoiceDate": "2024-12-22T22:48:41.3545425+00:00",
  "WorkInProgressDate": "2024-12-22T22:48:41.3545425+00:00",
  "CustomerCompanyId": "6",
  "InvoiceCustomerCompanyId": "7",
  "InvoiceNotes": "sample 8",
  "InvoiceText": "sample 9",
  "ContactPerson": "sample 10",
  "InvoiceReference": "sample 11",
  "CreatedOn": "2024-12-22T22:48:41.3545425+00:00",
  "RejectionReason": "sample 13",
  "ProcessingFailureReason": "sample 14",
  "InvoiceHeaderType": "Normal",
  "OriginalInvoiceHeaderId": "1",
  "OriginalInvoiceNumber": "sample 15",
  "OriginalInvoiceHeaderState": "Proposed",
  "IsCorrected": true,
  "ProcessedInvoicePdf": null,
  "ProcessedInvoiceXml": null,
  "PaymentConditionId": "17",
  "PaymentTerm": "1",
  "PaymentConditionType": "DirectDebit"
}

application/xml, text/xml

Sample:

<Invoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V2.Models">
  <AsyncServerCommandId>2</AsyncServerCommandId>
  <ContactPerson>sample 10</ContactPerson>
  <CreatedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-12-22T22:48:41.3545425Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedOn>
  <CurrencyId>4</CurrencyId>
  <CustomerCompanyId>6</CustomerCompanyId>
  <InvoiceCustomerCompanyId>7</InvoiceCustomerCompanyId>
  <InvoiceDate>2024-12-22T22:48:41.3545425+00:00</InvoiceDate>
  <InvoiceHeaderId>1</InvoiceHeaderId>
  <InvoiceHeaderState>Proposed</InvoiceHeaderState>
  <InvoiceHeaderType>Normal</InvoiceHeaderType>
  <InvoiceNotes>sample 8</InvoiceNotes>
  <InvoiceNumber>sample 3</InvoiceNumber>
  <InvoiceReference>sample 11</InvoiceReference>
  <InvoiceText>sample 9</InvoiceText>
  <IsCorrected>true</IsCorrected>
  <OriginalInvoiceHeaderId>1</OriginalInvoiceHeaderId>
  <OriginalInvoiceHeaderState>Proposed</OriginalInvoiceHeaderState>
  <OriginalInvoiceNumber>sample 15</OriginalInvoiceNumber>
  <PaymentConditionId>17</PaymentConditionId>
  <PaymentConditionType>DirectDebit</PaymentConditionType>
  <PaymentTerm>1</PaymentTerm>
  <ProcessedInvoicePdf xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <ProcessedInvoiceXml xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <ProcessingFailureReason>sample 14</ProcessingFailureReason>
  <RejectionReason>sample 13</RejectionReason>
  <WorkInProgressDate>2024-12-22T22:48:41.3545425+00:00</WorkInProgressDate>
</Invoice>