|
2576 | 2576 | }, |
2577 | 2577 | "SentToContact" : { |
2578 | 2578 | "type" : "boolean", |
2579 | | - "description" : "Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved", |
2580 | | - "readOnly" : true |
| 2579 | + "description" : "Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved" |
2581 | 2580 | }, |
2582 | 2581 | "CurrencyRate" : { |
2583 | 2582 | "type" : "number", |
|
3204 | 3203 | }, |
3205 | 3204 | "SubTotal" : { |
3206 | 3205 | "type" : "number", |
3207 | | - "description" : "Total of invoice excluding taxes", |
| 3206 | + "description" : "Total of invoice excluding taxes. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can SubTotal be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with TotalTax and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET)\n", |
3208 | 3207 | "format" : "double", |
3209 | | - "readOnly" : true, |
3210 | 3208 | "x-is-money" : true |
3211 | 3209 | }, |
3212 | 3210 | "TotalTax" : { |
3213 | 3211 | "type" : "number", |
3214 | | - "description" : "Total tax on invoice", |
| 3212 | + "description" : "Total tax on invoice. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can TotalTax be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET)\n", |
3215 | 3213 | "format" : "double", |
3216 | | - "readOnly" : true, |
3217 | 3214 | "x-is-money" : true |
3218 | 3215 | }, |
3219 | 3216 | "Total" : { |
3220 | 3217 | "type" : "number", |
3221 | | - "description" : "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts", |
| 3218 | + "description" : "Total of Invoice tax inclusive (i.e. SubTotal + TotalTax + RoundingAmount). Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can Total be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and TotalTax, it is validated against the calculated line item totals plus RoundingAmount; in all other cases this will be ignored if it does not equal the sum of the LineAmounts. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET)\n", |
3222 | 3219 | "format" : "double", |
3223 | | - "readOnly" : true, |
3224 | 3220 | "x-is-money" : true |
3225 | 3221 | }, |
3226 | 3222 | "TotalDiscount" : { |
|
3230 | 3226 | "readOnly" : true, |
3231 | 3227 | "x-is-money" : true |
3232 | 3228 | }, |
| 3229 | + "RoundingAmount" : { |
| 3230 | + "type" : "number", |
| 3231 | + "description" : "An optional rounding adjustment added to SubTotal + TotalTax to give Total (i.e. Total = SubTotal + TotalTax + RoundingAmount). Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Not validated while the invoice is DRAFT. For SUBMITTED and AUTHORISED invoices, RoundingAmount is only applied when SubTotal, TotalTax and Total are all supplied together, and must be between -0.10 and 0.10 – values outside this range are rejected with a validation error (on DRAFT invoices, an out-of-range value is ignored instead). This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET)\n", |
| 3232 | + "format" : "double", |
| 3233 | + "x-is-money" : true |
| 3234 | + }, |
| 3235 | + "EnteredTotal" : { |
| 3236 | + "type" : "number", |
| 3237 | + "description" : "The total amount as originally entered for the invoice, before any RoundingAmount adjustment is applied. Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Can only be set while the invoice is DRAFT; once the invoice is no longer DRAFT this reflects Total. This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET)\n", |
| 3238 | + "format" : "double", |
| 3239 | + "x-is-money" : true |
| 3240 | + }, |
3233 | 3241 | "InvoiceID" : { |
3234 | 3242 | "type" : "string", |
3235 | 3243 | "description" : "Xero generated unique identifier for invoice", |
|
6507 | 6515 | <nav id="scrollingNav"> |
6508 | 6516 | <ul class="sidenav nav nav-list"> |
6509 | 6517 | <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li> |
6510 | | - <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>19.1.0</li> |
| 6518 | + <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>19.2.0</li> |
6511 | 6519 | <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li> |
6512 | 6520 | <li data-group="Accounting" data-name="createAccount" class=""> |
6513 | 6521 | <a href="#api-Accounting-createAccount">createAccount</a> |
|
0 commit comments