GET api/{database}/CustomerInvoice/{invoiceId}
Gets the specified CustomerInvoice.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
invoiceId | The invoiceId. |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
{ "accountManager": "sample string 1", "accountManagerId": "sample string 2", "messages": [], "amountCreditSqueeze": 3.0, "amountCreditSqueezeCur": 4.0, "amountRebate": 5.0, "amountRebateCur": 6.0, "amountTotal": 7.0, "amountTotalCur": 8.0, "autoCalculateVat": true, "bordereauxNumber": "sample string 10", "canChange": true, "cannotChangeReason": "sample string 12", "contactPerson": "sample string 13", "contactPersonId": "sample string 14", "currencyId": "sample string 15", "customerId": "sample string 16", "customerInvoiceLines": null, "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": 17, "dunForPayment": true, "exchangeRate": 19.0, "fiscalYear": 20, "invoiceDate": "sample string 21", "invoiceExpirationDate": "sample string 22", "invoiceId": "sample string 23", "invoiceType": 0, "journalId": "sample string 24", "journalSection": "sample string 25", "journalTransaction": 26, "kvcPaymentCondition": true, "mandateId": "sample string 28", "numberOfReminders": 29, "openingBalance": true, "orderId": "sample string 31", "paymentConditionId": "sample string 32", "paymentReference": "sample string 33", "periodNumber": 34, "processedBy": "sample string 35", "processedById": "sample string 36", "rebateExpirationDate": "sample string 37", "rebatePercentage": 38.0, "reference": "sample string 39", "systemInvoice": true, "totalAmountVatExcl": 41.0, "totalAmountVatExclCur": 42.0, "vatAdjusted": true, "vatAmount": 44.0, "vatAmountCur": 45.0, "vatOnInvoice": true, "vatScenarioId": 1, "vatTransactionLines": null }
application/xml, text/xml
Sample:
<CustomerInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Edit"> <AccountManager>sample string 1</AccountManager> <AccountManagerId>sample string 2</AccountManagerId> <AmountCreditSqueeze>3</AmountCreditSqueeze> <AmountCreditSqueezeCur>4</AmountCreditSqueezeCur> <AmountRebate>5</AmountRebate> <AmountRebateCur>6</AmountRebateCur> <AmountTotal>7</AmountTotal> <AmountTotalCur>8</AmountTotalCur> <AutoCalculateVat>true</AutoCalculateVat> <BordereauxNumber>sample string 10</BordereauxNumber> <CanChange>true</CanChange> <CannotChangeReason>sample string 12</CannotChangeReason> <ContactPerson>sample string 13</ContactPerson> <ContactPersonId>sample string 14</ContactPersonId> <CurrencyId>sample string 15</CurrencyId> <CustomerId>sample string 16</CustomerId> <CustomerInvoiceLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Financial.Lists" i:nil="true" /> <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>17</DocumentNumber> <DunForPayment>true</DunForPayment> <ExchangeRate>19</ExchangeRate> <FiscalYear>20</FiscalYear> <InvoiceDate>sample string 21</InvoiceDate> <InvoiceExpirationDate>sample string 22</InvoiceExpirationDate> <InvoiceId>sample string 23</InvoiceId> <InvoiceType>SalesInvoice</InvoiceType> <JournalId>sample string 24</JournalId> <JournalSection>sample string 25</JournalSection> <JournalTransaction>26</JournalTransaction> <KVCPaymentCondition>true</KVCPaymentCondition> <MandateId>sample string 28</MandateId> <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" /> <NumberOfReminders>29</NumberOfReminders> <OpeningBalance>true</OpeningBalance> <OrderId>sample string 31</OrderId> <PaymentConditionId>sample string 32</PaymentConditionId> <PaymentReference>sample string 33</PaymentReference> <PeriodNumber>34</PeriodNumber> <ProcessedBy>sample string 35</ProcessedBy> <ProcessedById>sample string 36</ProcessedById> <RebateExpirationDate>sample string 37</RebateExpirationDate> <RebatePercentage>38</RebatePercentage> <Reference>sample string 39</Reference> <SystemInvoice>true</SystemInvoice> <TotalAmountVatExcl>41</TotalAmountVatExcl> <TotalAmountVatExclCur>42</TotalAmountVatExclCur> <VatAdjusted>true</VatAdjusted> <VatAmount>44</VatAmount> <VatAmountCur>45</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" /> </CustomerInvoice>