Update by orders

PATCH

/billing_new/invoice_line_items/update_currency_conversion_for_receivables_across_orders/v1

PATCH

/billing_new/invoice_line_items/update_currency_conversion_for_receivables_across_orders/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.updateCurrencyConversionForReceivablesAcrossOrdersV1({
8         order_ids: [
9             "order_ids",
10         ],
11         target_currency_code: "USD",
12     });
13 }
14 main();

1 [
2   {
3     "order_id": "order_id",
4     "status": "succeeded",
5     "converted_invoice_line_items": [
6       {
7         "_id": "_id",
8         "created_at_timestamp": "2024-01-15T09:30:00Z",
9         "created_by_user_id": "created_by_user_id",
10         "currency_code": "USD",
11         "description": "description",
12         "invoice_type": "accounts_receivable",
13         "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
14         "last_edited_by_user_id": "last_edited_by_user_id",
15         "line_item_type": "base_rate",
16         "owned_by_org_id": "owned_by_org_id",
17         "quantity": 1.1,
18         "schema_version": 1,
19         "unit_price": 1.1
20       }
21     ],
22     "failure_reason": "failure_reason"
23   }
24 ]

Applies one currency conversion independently to each selected order and reports each outcome. | authz: allowed_org_types=[provider], min_org_role=operator | (ReceivablesAcrossOrdersCurrencyConversionUpdateReq) -> (list[ReceivablesAcrossOrdersCurrencyConversionOrderRes])

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

order_idslist of stringsRequired

target_currency_codeenumRequired

conversion_ratedoubleOptional

Units of target_currency_code per one unit of the order’s sole original source currency different from the target. Target-currency items are reverted or left unchanged without applying this rate.

descriptionstringOptional<=255 characters

Response

Successful Response

order_idstring

statusenum

converted_invoice_line_itemslist of objectsOptional

failure_reasonstringOptional

Errors

422

Invoice Line Items Update Currency Conversion for Receivables across Orders V1request Unprocessable Entity Error