PUT api/{database}/SupplierInvoice/{invoiceId}
Updates the specified SupplierInvoice
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| invoiceId | The invoiceId. |
Define this parameter in the request URI. |
| value | The updated values for SupplierInvoice. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"activateInvoiceApproval": true,
"messages": [],
"amountCreditSqueeze": 2.0,
"amountCreditSqueezeCur": 3.0,
"amountFrozen": 4.0,
"amountFrozenCur": 5.0,
"amountRebate": 6.0,
"amountRebateCur": 7.0,
"amountTotal": 8.0,
"amountTotalCur": 9.0,
"approvedById": "sample string 10",
"autoCalculateVat": true,
"bordereauxNumber": "sample string 12",
"canChange": true,
"cannotChangeReason": "sample string 14",
"contactPerson": "sample string 15",
"contactPersonId": "sample string 16",
"currencyId": "sample string 17",
"documentLink": {
"messages": [],
"canChange": true,
"cannotChangeReason": "sample string 2",
"dateCreated": "sample string 3",
"description": "sample string 4",
"documentLink": "sample string 5",
"documentType": "sample string 6",
"linkCategoryName": "sample string 7",
"linkId": "sample string 8",
"linkType": "sample string 9",
"reference": "sample string 10",
"subject": "sample string 11"
},
"documentNumber": 18,
"exchangeRate": 19.0,
"fiscalYear": 20,
"invoiceDate": "sample string 21",
"invoiceExpirationDate": "sample string 22",
"invoiceId": "sample string 23",
"invoiceType": 0,
"isApproved": true,
"journalId": "sample string 25",
"journalSection": "sample string 26",
"journalTransaction": 27,
"kvcPaymentCondition": true,
"numberOfReminders": 29,
"openingBalance": true,
"paymentConditionId": "sample string 31",
"paymentReference": "sample string 32",
"periodNumber": 33,
"processedBy": "sample string 34",
"processedById": "sample string 35",
"rebateExpirationDate": "sample string 36",
"rebatePercentage": 37.0,
"reference": "sample string 38",
"supplierId": "sample string 39",
"supplierInvoiceLines": null,
"supplierIsSubcontractor": true,
"systemInvoice": true,
"totalAmountVatExcl": 42.0,
"totalAmountVatExclCur": 43.0,
"vatAdjusted": true,
"vatAmount": 45.0,
"vatAmountCur": 46.0,
"vatOnInvoice": true,
"vatScenarioId": 1,
"vatTransactionLines": null
}
application/xml, text/xml
Sample:
<SupplierInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Edit">
<ActivateInvoiceApproval>true</ActivateInvoiceApproval>
<AmountCreditSqueeze>2</AmountCreditSqueeze>
<AmountCreditSqueezeCur>3</AmountCreditSqueezeCur>
<AmountFrozen>4</AmountFrozen>
<AmountFrozenCur>5</AmountFrozenCur>
<AmountRebate>6</AmountRebate>
<AmountRebateCur>7</AmountRebateCur>
<AmountTotal>8</AmountTotal>
<AmountTotalCur>9</AmountTotalCur>
<ApprovedById>sample string 10</ApprovedById>
<AutoCalculateVat>true</AutoCalculateVat>
<BordereauxNumber>sample string 12</BordereauxNumber>
<CanChange>true</CanChange>
<CannotChangeReason>sample string 14</CannotChangeReason>
<ContactPerson>sample string 15</ContactPerson>
<ContactPersonId>sample string 16</ContactPersonId>
<CurrencyId>sample string 17</CurrencyId>
<DocumentLink xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.DocMan.Edit">
<d2p1:CanChange>true</d2p1:CanChange>
<d2p1:CannotChangeReason>sample string 2</d2p1:CannotChangeReason>
<d2p1:DateCreated>sample string 3</d2p1:DateCreated>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:DocumentLink>sample string 5</d2p1:DocumentLink>
<d2p1:DocumentType>sample string 6</d2p1:DocumentType>
<d2p1:LinkCategoryName>sample string 7</d2p1:LinkCategoryName>
<d2p1:LinkId>sample string 8</d2p1:LinkId>
<d2p1:LinkType>sample string 9</d2p1:LinkType>
<d2p1:Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
<d2p1:Reference>sample string 10</d2p1:Reference>
<d2p1:Subject>sample string 11</d2p1:Subject>
</DocumentLink>
<DocumentNumber>18</DocumentNumber>
<ExchangeRate>19</ExchangeRate>
<FiscalYear>20</FiscalYear>
<InvoiceDate>sample string 21</InvoiceDate>
<InvoiceExpirationDate>sample string 22</InvoiceExpirationDate>
<InvoiceId>sample string 23</InvoiceId>
<InvoiceType>SalesInvoice</InvoiceType>
<IsApproved>true</IsApproved>
<JournalId>sample string 25</JournalId>
<JournalSection>sample string 26</JournalSection>
<JournalTransaction>27</JournalTransaction>
<KVCPaymentCondition>true</KVCPaymentCondition>
<Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
<NumberOfReminders>29</NumberOfReminders>
<OpeningBalance>true</OpeningBalance>
<PaymentConditionId>sample string 31</PaymentConditionId>
<PaymentReference>sample string 32</PaymentReference>
<PeriodNumber>33</PeriodNumber>
<ProcessedBy>sample string 34</ProcessedBy>
<ProcessedById>sample string 35</ProcessedById>
<RebateExpirationDate>sample string 36</RebateExpirationDate>
<RebatePercentage>37</RebatePercentage>
<Reference>sample string 38</Reference>
<SupplierId>sample string 39</SupplierId>
<SupplierInvoiceLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Lists" i:nil="true" />
<SupplierIsSubcontractor>true</SupplierIsSubcontractor>
<SystemInvoice>true</SystemInvoice>
<TotalAmountVatExcl>42</TotalAmountVatExcl>
<TotalAmountVatExclCur>43</TotalAmountVatExclCur>
<VatAdjusted>true</VatAdjusted>
<VatAmount>45</VatAmount>
<VatAmountCur>46</VatAmountCur>
<VatOnInvoice>true</VatOnInvoice>
<VatScenarioId>1</VatScenarioId>
<VatTransactionLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Lists" i:nil="true" />
</SupplierInvoice>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{
"activateInvoiceApproval": true,
"messages": [],
"amountCreditSqueeze": 2.0,
"amountCreditSqueezeCur": 3.0,
"amountFrozen": 4.0,
"amountFrozenCur": 5.0,
"amountRebate": 6.0,
"amountRebateCur": 7.0,
"amountTotal": 8.0,
"amountTotalCur": 9.0,
"approvedById": "sample string 10",
"autoCalculateVat": true,
"bordereauxNumber": "sample string 12",
"canChange": true,
"cannotChangeReason": "sample string 14",
"contactPerson": "sample string 15",
"contactPersonId": "sample string 16",
"currencyId": "sample string 17",
"documentLink": {
"messages": [],
"canChange": true,
"cannotChangeReason": "sample string 2",
"dateCreated": "sample string 3",
"description": "sample string 4",
"documentLink": "sample string 5",
"documentType": "sample string 6",
"linkCategoryName": "sample string 7",
"linkId": "sample string 8",
"linkType": "sample string 9",
"reference": "sample string 10",
"subject": "sample string 11"
},
"documentNumber": 18,
"exchangeRate": 19.0,
"fiscalYear": 20,
"invoiceDate": "sample string 21",
"invoiceExpirationDate": "sample string 22",
"invoiceId": "sample string 23",
"invoiceType": 0,
"isApproved": true,
"journalId": "sample string 25",
"journalSection": "sample string 26",
"journalTransaction": 27,
"kvcPaymentCondition": true,
"numberOfReminders": 29,
"openingBalance": true,
"paymentConditionId": "sample string 31",
"paymentReference": "sample string 32",
"periodNumber": 33,
"processedBy": "sample string 34",
"processedById": "sample string 35",
"rebateExpirationDate": "sample string 36",
"rebatePercentage": 37.0,
"reference": "sample string 38",
"supplierId": "sample string 39",
"supplierInvoiceLines": null,
"supplierIsSubcontractor": true,
"systemInvoice": true,
"totalAmountVatExcl": 42.0,
"totalAmountVatExclCur": 43.0,
"vatAdjusted": true,
"vatAmount": 45.0,
"vatAmountCur": 46.0,
"vatOnInvoice": true,
"vatScenarioId": 1,
"vatTransactionLines": null
}
application/xml, text/xml
Sample:
<SupplierInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Edit">
<ActivateInvoiceApproval>true</ActivateInvoiceApproval>
<AmountCreditSqueeze>2</AmountCreditSqueeze>
<AmountCreditSqueezeCur>3</AmountCreditSqueezeCur>
<AmountFrozen>4</AmountFrozen>
<AmountFrozenCur>5</AmountFrozenCur>
<AmountRebate>6</AmountRebate>
<AmountRebateCur>7</AmountRebateCur>
<AmountTotal>8</AmountTotal>
<AmountTotalCur>9</AmountTotalCur>
<ApprovedById>sample string 10</ApprovedById>
<AutoCalculateVat>true</AutoCalculateVat>
<BordereauxNumber>sample string 12</BordereauxNumber>
<CanChange>true</CanChange>
<CannotChangeReason>sample string 14</CannotChangeReason>
<ContactPerson>sample string 15</ContactPerson>
<ContactPersonId>sample string 16</ContactPersonId>
<CurrencyId>sample string 17</CurrencyId>
<DocumentLink xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.DocMan.Edit">
<d2p1:CanChange>true</d2p1:CanChange>
<d2p1:CannotChangeReason>sample string 2</d2p1:CannotChangeReason>
<d2p1:DateCreated>sample string 3</d2p1:DateCreated>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:DocumentLink>sample string 5</d2p1:DocumentLink>
<d2p1:DocumentType>sample string 6</d2p1:DocumentType>
<d2p1:LinkCategoryName>sample string 7</d2p1:LinkCategoryName>
<d2p1:LinkId>sample string 8</d2p1:LinkId>
<d2p1:LinkType>sample string 9</d2p1:LinkType>
<d2p1:Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
<d2p1:Reference>sample string 10</d2p1:Reference>
<d2p1:Subject>sample string 11</d2p1:Subject>
</DocumentLink>
<DocumentNumber>18</DocumentNumber>
<ExchangeRate>19</ExchangeRate>
<FiscalYear>20</FiscalYear>
<InvoiceDate>sample string 21</InvoiceDate>
<InvoiceExpirationDate>sample string 22</InvoiceExpirationDate>
<InvoiceId>sample string 23</InvoiceId>
<InvoiceType>SalesInvoice</InvoiceType>
<IsApproved>true</IsApproved>
<JournalId>sample string 25</JournalId>
<JournalSection>sample string 26</JournalSection>
<JournalTransaction>27</JournalTransaction>
<KVCPaymentCondition>true</KVCPaymentCondition>
<Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
<NumberOfReminders>29</NumberOfReminders>
<OpeningBalance>true</OpeningBalance>
<PaymentConditionId>sample string 31</PaymentConditionId>
<PaymentReference>sample string 32</PaymentReference>
<PeriodNumber>33</PeriodNumber>
<ProcessedBy>sample string 34</ProcessedBy>
<ProcessedById>sample string 35</ProcessedById>
<RebateExpirationDate>sample string 36</RebateExpirationDate>
<RebatePercentage>37</RebatePercentage>
<Reference>sample string 38</Reference>
<SupplierId>sample string 39</SupplierId>
<SupplierInvoiceLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Lists" i:nil="true" />
<SupplierIsSubcontractor>true</SupplierIsSubcontractor>
<SystemInvoice>true</SystemInvoice>
<TotalAmountVatExcl>42</TotalAmountVatExcl>
<TotalAmountVatExclCur>43</TotalAmountVatExclCur>
<VatAdjusted>true</VatAdjusted>
<VatAmount>45</VatAmount>
<VatAmountCur>46</VatAmountCur>
<VatOnInvoice>true</VatOnInvoice>
<VatScenarioId>1</VatScenarioId>
<VatTransactionLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Lists" i:nil="true" />
</SupplierInvoice>