Update source

PATCH

/billing_new/invoice_line_items/update_source/v1/:invoice_line_item_id

PATCH

/billing_new/invoice_line_items/update_source/v1/:invoice_line_item_id

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.updateSourceV1("invoice_line_item_id", {});
8 }
9 main();

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

Updates an owner-scoped line item’s source fields, reapplies any existing currency conversion, and rebuilds its draft invoice when attached. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemClientUpdate1) -> (InvoiceLineItem1)

Authentication

AuthorizationBearer

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

Path parameters

invoice_line_item_idstringRequired

Request

This endpoint expects an object.

descriptionstringOptional1-32768 characters

export_ref__sage__item_idstringOptional<=255 characters

export_ref__sage__item_id__set_to_NonebooleanOptionalDefaults to false

invoice_typeenumOptional

Allowed values:

quantitydoubleOptional

source_currency_codeenumOptional

source_unit_pricedoubleOptional

unitenumOptional

unit__set_to_NonebooleanOptionalDefaults to false

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 Source V1request Unprocessable Entity Error