CHchrt
/billing_new
/billing_new/invoice_line_items

Retrieve (via POST) ad-hoc preview

Changed on

Previews account-split ad-hoc line items without persisting them. | authz: allowed_org_types=[provider], min_org_role=operator | (AdHocInvoiceLineItemsReq) -> (list[InvoiceLineItemServerCreate1])

post/billing_new/invoice_line_items/ad_hoc/preview/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/billing_new/invoice_line_items/ad_hoc/preview/v1
  • Auth
    HTTP bearer

Request body

task_group_idstring required

Response

Successful Response

schema_version1 required
invoice_type'accounts_receivable' | 'accounts_payable' required
descriptionstring required
quantitynumber required
unit'each' | 'shipment' | 'hour' | 'day' | 'mile' | 'kilometer' | 'pound' | 'kilogram'
unit_pricenumber required
currency_code'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR' required
line_item_type'base_rate' | 'additional_mileage' | 'long_distance_mileage' | 'fuel' | 'extra_stop' | 'wait_time' | 'attempt' | 'pick_and_hold' | 'parking' | 'tolls' | 'additional_fee' | 'dispute' | 'equipment' | 'dangerous_goods' | 'special_vehicle' | 'after_hours' | 'weekend' | 'holiday' | 'air_waybill' | 'insurance' | 'off_network_carrier' | 'obc_day_rate' | 'flight_ticket' | 'tracking_device_label' | 'tracking_device_tag' | 'tracking_device_other' | 'tax' | 'other' required
tax_percentagenumber nullable
counterparty_org_idstring nullable

Must be a string starting with org_

counterparty_off_chrt_org_data_idstring nullable
counterparty_driver_idstring nullable
shipper_account_idstring nullable
awb_numberstring nullable

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

export_ref__sage__item_idstring nullable
order_idstring nullable
task_group_idstring nullable
billing_period_idstring nullable
invoice_idstring nullable
rate_sheet_idstring nullable
status'draft' | 'approved' | 'finalized'
owned_by_org_idstring required

Must be a string starting with org_

created_by_user_idstring required

Must be a string starting with user_

created_at_timestampstring date-time required
last_edited_by_user_idstring required

Must be a string starting with user_

last_edited_at_timestampstring date-time required

Changes

  • 9a30893d8db1Revision changes
    • breaking

      removed the enum value XXX of the request property ///

    • breaking

      removed the enum value tax_1 of the request property ///

    • breaking

      removed the enum value tax_2 of the request property ///

    • breaking

      removed the enum value tax_3 of the request property ///

    • warning

      added the new tax enum value to the / response property for the response status

    • info

      api tag /billing_new/invoice_line_items added

    • info

      added the new tax enum value to the request property ///

    • info

      removed the XXX enum value from the / response property for the response status

    • info

      removed the XXX enum value from the /// response property for the response status

    • info

      removed the tax_1 enum value from the / response property for the response status

    • info

      removed the tax_2 enum value from the / response property for the response status

    • info

      removed the tax_3 enum value from the / response property for the response status