GET V3/odata/InvoicingAgreement({key})

Gets InvoicingAgreement entity by key

Request Information

URI Parameters

Name	Description	Type	Additional information
key	InvoicingAgreementId from InvoicingAgreement entity	integer	Required

Body Parameters

None.

Response Information

Resource Description

QicsUnity.Api.Areas.V3.Models.InvoicingAgreement

Name	Description	Type	Additional information
InvoicingAgreementId	Gets or sets InvoicingAgreementId	integer	Required 64-bit signed integer
ProjectId	Gets or sets ProjectId	integer	Required 64-bit signed integer
Code	Gets or sets Code	string
Name	Gets or sets Name	string	Required
InvoicingMethod	Gets or sets InvoicingMethod	QicsUnity.Api.Areas.V3.Models.InvoicingMethod	Required
StartDate	Gets or sets StartDate	date	Required date and time of day
EndDate	Gets or sets EndDate	date	date and time of day Nullable
IsActive	Gets or sets a value indicating whether invoicing agreement is active	boolean
AllowHourEntry	Gets or sets a value indicating whether hour entries are allowed	boolean
AllowExpenseEntry	Gets or sets a value indicating whether expense entries are allowed	boolean
PaymentConditionId	Gets or sets PaymentConditionId	integer	64-bit signed integer Nullable
CustomerCompanyId	Gets or sets CustomerCompanyId	integer	Required 64-bit signed integer
IsInvoiceCustomerCustom	Gets or sets a value indicating whether invoice customer is custom	boolean	None.
InvoiceCustomerCompanyId	Gets or sets InvoiceCustomerCompanyId (Debtor)	integer	Required 64-bit signed integer
CurrencyId	Gets or sets CurrencyId	integer	64-bit signed integer
InvoiceReference	Gets or sets InvoiceReference	string
InvoiceNotes	Gets or sets InvoiceNotes	string
InvoiceGroup	Gets or sets InvoiceGroup	string
InvoiceLayoutId	Gets or sets InvoiceLayoutId	integer	64-bit signed integer Nullable
EmailAddressTo	Gets or sets the email address	string
SurchargePercentage	Gets or sets SurchargePercentage	decimal number	Nullable
ContractValue	Gets or sets ContractValue	decimal number	Nullable
ProlongedUntil	Gets or sets ProlongedUntil	date	date and time of day Nullable
Quantity	Gets or sets Quantity for Installment/Advance defaults	decimal number	Nullable
Price	Gets or sets Price for Installment/Advance defaults	decimal number	Nullable

Response Formats

application/json, text/json

Sample:

{
  "InvoicingAgreementId": "1",
  "ProjectId": "2",
  "Code": "sample 3",
  "Name": "sample 4",
  "InvoicingMethod": "NoInvoicing",
  "StartDate": "2024-12-22T17:21:03.3405048+00:00",
  "EndDate": "2024-12-22T17:21:03.3405048+00:00",
  "IsActive": true,
  "AllowHourEntry": true,
  "AllowExpenseEntry": true,
  "PaymentConditionId": "1",
  "CustomerCompanyId": "9",
  "IsInvoiceCustomerCustom": true,
  "InvoiceCustomerCompanyId": "11",
  "CurrencyId": "12",
  "InvoiceReference": "sample 13",
  "InvoiceNotes": "sample 14",
  "InvoiceGroup": "sample 15",
  "InvoiceLayoutId": "1",
  "EmailAddressTo": "sample 16",
  "SurchargePercentage": "1",
  "ContractValue": "1",
  "ProlongedUntil": "2024-12-22T17:21:03.3405048+00:00",
  "Quantity": "1",
  "Price": "1"
}

application/xml, text/xml

Sample:

<InvoicingAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V3.Models">
  <AllowExpenseEntry>true</AllowExpenseEntry>
  <AllowHourEntry>true</AllowHourEntry>
  <Code>sample 3</Code>
  <ContractValue>1</ContractValue>
  <CurrencyId>12</CurrencyId>
  <CustomerCompanyId>9</CustomerCompanyId>
  <EmailAddressTo>sample 16</EmailAddressTo>
  <EndDate>2024-12-22T17:21:03.3405048+00:00</EndDate>
  <InvoiceCustomerCompanyId>11</InvoiceCustomerCompanyId>
  <InvoiceGroup>sample 15</InvoiceGroup>
  <InvoiceLayoutId>1</InvoiceLayoutId>
  <InvoiceNotes>sample 14</InvoiceNotes>
  <InvoiceReference>sample 13</InvoiceReference>
  <InvoicingAgreementId>1</InvoicingAgreementId>
  <InvoicingMethod>NoInvoicing</InvoicingMethod>
  <IsActive>true</IsActive>
  <IsInvoiceCustomerCustom>true</IsInvoiceCustomerCustom>
  <Name>sample 4</Name>
  <PaymentConditionId>1</PaymentConditionId>
  <Price>1</Price>
  <ProjectId>2</ProjectId>
  <ProlongedUntil>2024-12-22T17:21:03.3405048+00:00</ProlongedUntil>
  <Quantity>1</Quantity>
  <StartDate>2024-12-22T17:21:03.3405048+00:00</StartDate>
  <SurchargePercentage>1</SurchargePercentage>
</InvoicingAgreement>