...
Contained as a collection in Invoice Document Record
Table of Contents |
---|
PROPERTIES
| A sequential number for the lines, starting at 1. | int | |
| The line description, a free text. Optional. | string? | |
| Optional. The source language code of the service. To discover all languages see settings/languages | string? | |
| Optional. The target language code of the service. To discover all languages see settings/languages | string? | |
| Optional. The service task code such as TR for translation or RV for revision. To discover all task types, see settings/tasks/codes | string? | |
| Total amount including VAT. Equals totalExVat + totalVat. | decimalOptional product / service code. | string? |
Fuzzy match & Pre-translation | |||
| Indicates if the line refers to a pre-translation or fuzzy match or repetition. Options are:
| string? | |
| If
| int | |
Unit price | |||
| Optional. The unit that is costed. Such as “WD” (words) or “CH” (characters). See also: Price units. Null if the invoice lines does not state a unit price. | string? | |
| Optional. Number of units included in the unit price. 0 if not specified. | int | |
| Optional. Unit price that is the price of | decimal? | |
| Total count. Optional, can be null if the line does not state any counts. | int? | |
| Boolean. True if | bool | |
Fees and reductions | |||
| Applicable reduction in %. Must be between 0 and 100. The reduction is applied to the base total in | int | |
| If not null then the invoice line represents a fee or discount.
The fee is calculated from all invoice lines as per When setting the fee, other properties such as unit prices, counts, etc. are not populated or used. | decimal? | |
| Optional, null if no fee defined. Values are:
Also see the Wordbee Translator system on how to configure fees in the invoice details page. | string? | |
| Total amount after reductions. See | decimal? | |
| Total amount before reductions. Null if not specified. | decimal? |
...
Code Block |
---|
{ "idx": 1, "desc": "20% discount", "src": null, "trg": null, "task": null, "code": null, "pretrans": null, "pretransBoundary": 0, "serviceUnit": null, "serviceUnitCount": 0, "serviceUnitAmount": null, "count": null, "countIgnore": true, "reduction": 0.0000, "feeMode": "PercentBefore", "feePercent": -20.0000, "amount": -35.9600, "amountBase": -35.9600 } |
INSERTING AND UPDATING
When inserting or updating a line, you need to include all properties you want to assign to the line.
Comments:
idx
: Not required and will be automatically assigned.All properties are optional and you can literally submit an empty JSON such as
{ }
just fine. It won't make sense of course…
At minimum we recommend to supply at minimum these properties:
desc
amount