Represents an invoice.
| Child pages (Children Display) |
|---|
FORMAT
| Code Block | ||
|---|---|---|
| ||
<ApiInvoice> <InvoiceId>2147483647</InvoiceId> <InvoiceReference>String content</InvoiceReference> <InvoiceStatus>255</InvoiceStatus> <Published_>255</Published_> <IsSupplierInvoice>true</IsSupplierInvoice> <SupplierCompanyId>2147483647</SupplierCompanyId> <ClientCompanyId>2147483647</ClientCompanyId> <ProjectId>2147483647</ProjectId> <ProjectReference>String content</ProjectReference> <InvoiceNo>String content</InvoiceNo> <InvoiceDate>1999-05-31T11:20:00</InvoiceDate> <QuoteNo>String content</QuoteNo> <QuoteDate>1999-05-31T11:20:00</QuoteDate> <EffectiveDate>1999-05-31T11:20:00</EffectiveDate> <ProjectStatus>255</ProjectStatus> <Date>1999-05-31T11:20:00</Date> <TotalExVAT>12678967.543233</TotalExVAT> <TotalExVATBase>12678967.543233</TotalExVATBase> <VAT>12678967.543233</VAT> <TotalVAT>12678967.543233</TotalVAT> <Currency>String content</Currency> <DecimalPlaces>255</DecimalPlaces> <HeaderLine>String content</HeaderLine> <MasterComments>String content</MasterComments> <Labels>String content</Labels> <ContractNumber>String content</ContractNumber> <QuoteFileName>String content</QuoteFileName> <QuoteFileDate>1999-05-31T11:20:00</QuoteFileDate> <QuoteFilePersonId>2147483647</QuoteFilePersonId> <InvoiceFileName>String content</InvoiceFileName> <InvoiceFileDate>1999-05-31T11:20:00</InvoiceFileDate> <InvoiceFilePersonId>2147483647</InvoiceFilePersonId> <OrderId>2147483647</OrderId> <IsAggregation>true</IsAggregation> <AggregationInvoiceId>2147483647</AggregationInvoiceId> <AggPeriodFrom>1999-05-31T11:20:00</AggPeriodFrom> <AggPeriodTo>1999-05-31T11:20:00</AggPeriodTo> <DistributionEmail_>255</DistributionEmail_> <DistributionPrint_>255</DistributionPrint_> <TemplateVariant>255</TemplateVariant> <DoAggregate>true</DoAggregate> <CustomStr1>String content</CustomStr1> <CustomStr2>String content</CustomStr2> <CustomStr3>String content</CustomStr3> <CustomStr4>String content</CustomStr4> <CustomStr5>String content</CustomStr5> <CustomStr6>String content</CustomStr6> <CustomStr7>String content</CustomStr7> <CustomStr8>String content</CustomStr8> <CustomStr9>String content</CustomStr9> <CustomStr10>String content</CustomStr10> <CustomStr11>String content</CustomStr11> <CustomStr12>String content</CustomStr12> <CustomStr13>String content</CustomStr13> <CustomStr14>String content</CustomStr14> <CustomStr15>String content</CustomStr15> <CustomStr16>String content</CustomStr16> <CustomStr17>String content</CustomStr17> <CustomStr18>String content</CustomStr18> <CustomStr19>String content</CustomStr19> <CustomStr20>String content</CustomStr20> < /ApiInvoice> |
PROPERTIES
InvoiceId | The id of the invoice |
InvoiceReference | The reference of the invoice or quote |
InvoiceStatus | The invoice status. Any of these values: /// <summary> /// The invoice is under preparation /// </summary> ProposalDraft = 0, /// <summary> /// The invoice is sent /// </summary> ProposalSent = 1, /// <summary> /// The proposal is accepted by client /// </summary> ProposalAccepted = 2, /// <summary> /// The invoice is a draft /// </summary> InvoiceDraft = 10, /// <summary> /// The invoice is sent /// </summary> InvoiceSent = 11, /// <summary> /// The invoice is paid /// </summary> InvoicePaid = 12, /// <summary> /// The invoice has a problem /// </summary> InvoiceProblem = 13, /// <summary> /// The invoice is approved. Comes after InvoiceDraft and typically means that /// an invoice number and date is assigned. /// </summary> InvoiceApproved = 15, /// <summary> /// The invoice is cancelled /// </summary> Cancelled = 20 |
Published_ | Indicates whether invoice is visible to client/supplier and editable |
IsSupplierInvoice | Is 'true' if the document is created for a supplier (such as a freelancer). Otherwise it is for a client. |
SupplierCompanyId | The id of the supplier company |
ClientCompanyId | The id of the client company |
ProjectId | The attached project id |
ProjectReference | The project reference |
InvoiceNo | The invoice number. Typically assigned when the invoice is approved. |
InvoiceDate | The official date of the invoice. Typically assigned when the invoice is approved. |
QuoteNo | The quote or purchase order number. Typically assigned when the quote has been approved. |
QuoteDate | The official date of the quote or purchase order. Typically assigned when the quote has been approved. |
EffectiveDate | The financial period to which a details invoice is attributed. Assigned when the cost calculation becomes a draft invoice. |
ProjectStatus | The status of the project. |
Date | The date when the invoice or quote was last updated. |
TotatExVAT | Total amout excluding VAT. |
TotalExVATBase | Total amout excluding VAT and any reduction. |
VAT | The value of the VAT rate as a percentage between 0 and 100. |
TotalVAT | Total VAT amount as calculated from the VAT rate and the total excluding VAT. |
Currency | The currency formatted as a 3 letter ISO code. |
DecimalPlaces | The number of decimals to print for amounts. |
HeaderLine | The invoice header line |
MasterComments | The invoice comments |
Labels | The invoice labels |
ContractNumber | The contract number field as copied from the applicable price list when creating the invoice. |
QuoteFileDate | Date when the optional quote printout (Excel or Pdf) was saved to the quote record. |
QuoteFilePersonId | The Wordbee user who created or attached the quote printout. |
InvoiceFileDate | Date when the optional invoice printout (Excel or Pdf) was saved to the quote record. |
InvoiceFilePersonId | The Wordbee user who created or attached the invoice printout |
OrderId | The id of the attached order |
IsAggregation | If 'true', then this flag means that the present invoice aggregates details invoices. Otherwise the value is 'false'. |
AggregationInvoiceId | The id of the parent invoice that aggregates this one. |
AggPeriodFrom | If the invoice is an aggregation parent or child, then this is the first date of the aggregation period. The invoice dates of all aggregated details invoices lie within this period. |
AggPeriodTo | If the invoice is an aggregation parent or child, then this is the last date of the aggregation period. The invoice dates of all aggregated details invoices lie within this period. |
DistributionEmail_ | Indicates if the finished invoice was sent out by email. |
DistributionPrint_ | Indicates if the finished invoice needs to be sent by postal mail. |
TemplateVariant |
|
DoAggregate | Indicates whether this invoice shall be aggregated at the end of a financial period. |
CustomStr1 | Custom field |
CustomStr2 | Custom field |
CustomStr3 | Custom field |
CustomStr4 | Custom field |
CustomStr5 | Custom field |
CustomStr6 | Custom field |
CustomStr7Custom field | |
CustomStr8Custom field | |
CustomStr9Custom field | |
| CustomStr10 | Custom field |
CustomStr11 | Custom field |
CustomStr12 | Custom field |
CustomStr13 | Custom field |
CustomStr14 | Custom field |
CustomStr15 | Custom field |
CustomStr16 | Custom field |
CustomStr17 | Custom field |
CustomStr18 | Custom field |
CustomStr19 | Custom field |
CustomStr20 | Custom field |