Update currency conversion for many

PATCH

/billing_new/invoice_line_items/update_currency_conversion_many/v1

PATCH

/billing_new/invoice_line_items/update_currency_conversion_many/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.billingNew.invoiceLineItems.updateCurrencyConversionManyV1({
8         invoice_line_item_ids: [
9             "invoice_line_item_ids",
10         ],
11         target_currency_code: "USD",
12     });
13 }
14 main();

1 [
2   {
3     "_id": "_id",
4     "created_at_timestamp": "2024-01-15T09:30:00Z",
5     "created_by_user_id": "created_by_user_id",
6     "currency_code": "USD",
7     "description": "description",
8     "invoice_type": "accounts_receivable",
9     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
10     "last_edited_by_user_id": "last_edited_by_user_id",
11     "line_item_type": "base_rate",
12     "owned_by_org_id": "owned_by_org_id",
13     "quantity": 1.1,
14     "schema_version": 1,
15     "unit_price": 1.1,
16     "awb_number": "awb_number",
17     "billing_period_id": "billing_period_id",
18     "counterparty_driver_id": "counterparty_driver_id",
19     "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
20     "counterparty_org_id": "counterparty_org_id",
21     "currency_conversion": {
22       "conversion_rate": 1.1,
23       "source_currency_code": "USD",
24       "source_unit_price": 1.1,
25       "description": "description"
26     },
27     "export_ref__sage__item_id": "export_ref__sage__item_id",
28     "invoice_id": "invoice_id",
29     "order_id": "order_id",
30     "rate_sheet_id": "rate_sheet_id",
31     "shipper_account_id": "shipper_account_id",
32     "status": "draft",
33     "task_group_id": "task_group_id",
34     "tax_percentage": 1.1,
35     "unit": "each"
36   }
37 ]

Applies or reverts one currency conversion on line items from their original source values and moves attached items to the matching target-currency draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemsCurrencyConversionUpdateManyReq) -> (list[InvoiceLineItem1])

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

invoice_line_item_idslist of stringsRequired

target_currency_codeenumRequired

conversion_ratedoubleOptional

Units of target_currency_code per one unit of the line items’ original source currency — their currency_conversion.source_currency_code if already converted, otherwise their current currency_code. Always relative to that original source, never to an intermediate converted currency, so conversions never compound. Omitted when target_currency_code is the original source currency, which reverts the conversion.

Units of target_currency_code per one unit of the line items' original source currency -- their currency_conversion.source_currency_code if already converted, otherwise their current currency_code. Always relative to that original source, never to an intermediate converted currency, so conversions never compound. Omitted when target_currency_code is the original source currency, which reverts the conversion.

descriptionstringOptional<=255 characters

Response

Successful Response

_idstring

created_at_timestampdatetime

created_by_user_idstring

Must be a string starting with user_

currency_codeenum

descriptionstring1-32768 characters

invoice_typeenum

last_edited_at_timestampdatetime

last_edited_by_user_idstring

Must be a string starting with user_

line_item_typeenum

owned_by_org_idstring

Must be a string starting with org_

quantitydouble

schema_versioninteger

unit_pricedouble

awb_numberstringOptionalformat: "^\d{3}-\d{8}$"

IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. ‘020-12345678’.

billing_period_idstringOptional

counterparty_driver_idstringOptional

counterparty_off_chrt_org_data_idstringOptional

counterparty_org_idstringOptional

Must be a string starting with org_

currency_conversionobjectOptional

export_ref__sage__item_idstringOptional<=255 characters

invoice_idstringOptional

order_idstringOptional

rate_sheet_idstringOptional

shipper_account_idstringOptional

statusenumOptional

task_group_idstringOptional

tax_percentagedoubleOptional>=0

unitenumOptional

Errors

422

Invoice Line Items Update Currency Conversion Many V1request Unprocessable Entity Error