Update currency conversion

PATCH

/billing_new/invoice_line_items/update_currency_conversion_many/v1

PATCH

/billing_new/invoice_line_items/update_currency_conversion_many/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.invoiceLineItems.updateCurrencyConversionManyV1({
        invoice_line_item_ids: [
            "invoice_line_item_ids",
        ],
        target_currency_code: "USD",
    });
}
main();

[
  {
    "_id": "_id",
    "created_at_timestamp": "2024-01-15T09:30:00Z",
    "created_by_user_id": "created_by_user_id",
    "currency_code": "USD",
    "description": "description",
    "invoice_type": "accounts_receivable",
    "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
    "last_edited_by_user_id": "last_edited_by_user_id",
    "line_item_type": "base_rate",
    "owned_by_org_id": "owned_by_org_id",
    "quantity": 1.1,
    "schema_version": 1,
    "unit_price": 1.1,
    "awb_number": "awb_number",
    "billing_period_id": "billing_period_id",
    "counterparty_driver_id": "counterparty_driver_id",
    "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
    "counterparty_org_id": "counterparty_org_id",
    "currency_conversion": {
      "conversion_rate": 1.1,
      "source_currency_code": "USD",
      "source_unit_price": 1.1,
      "description": "description"
    },
    "export_ref__sage__item_id": "export_ref__sage__item_id",
    "invoice_id": "invoice_id",
    "order_id": "order_id",
    "rate_sheet_id": "rate_sheet_id",
    "shipper_account_id": "shipper_account_id",
    "status": "draft",
    "task_group_id": "task_group_id",
    "tax_percentage": 1.1,
    "total_amount": 1.1,
    "unit": "each"
  }
]

Converts uninvoiced charges or updates exchange rates within their draft invoice currency. | 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_ratedouble or nullOptional

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 converted items and leaves unconverted items unchanged.

descriptionstring or nullOptional<=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

Allowed values:

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_numberstring or nullOptionalformat: "^\d{3}-\d{8}$"

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

billing_period_idstring or nullOptional

counterparty_driver_idstring or nullOptional

counterparty_off_chrt_org_data_idstring or nullOptional

counterparty_org_idstring or nullOptional

Must be a string starting with org_

currency_conversionobject or nullOptional

export_ref__sage__item_idstring or nullOptional<=255 characters

invoice_idstring or nullOptional

order_idstring or nullOptional

rate_sheet_idstring or nullOptional

shipper_account_idstring or nullOptional

statusenumOptional

Allowed values:

task_group_idstring or nullOptional

tax_percentagedouble or nullOptional>=0

total_amountdoubleOptionalRead-only

unitenum or nullOptional

Errors

422

Invoice Line Items Update Currency Conversion Many V1request Unprocessable Entity Error