CHchrt
/billing_new
/billing_new/rate_sheets

Create

Changed on

Creates a rate sheet that prices one segment type for one counterparty. | authz: allowed_org_types=[provider], min_org_role=operator | (RateSheetClientCreate1) -> (RateSheet1)

post/billing_new/rate_sheets/create/v1

Request

Request body

schema_version1 required
namestring required
invoice_type'accounts_receivable' | 'accounts_payable' required
currency_code'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR' required
counterparty_org_idstring nullable

Must be a string starting with org_

counterparty_off_chrt_org_data_idstring nullable
counterparty_driver_idstring nullable
task_group_type'chrt_ground_provider' | 'cargo_on_flight' | 'cargo_on_vessel' | 'onboard_courier' required
applies_to_service_linesServiceLineEnum[]
effective_time_zone_namestring

IANA time zone name (e.g. America/New_York).

effective_starts_at_timestampstring date-time nullable
effective_ends_at_timestampstring date-time nullable

Example request

{
  "effective_time_zone_name": "America/New_York"
}

Response

Successful Response

schema_version1 required
namestring required
invoice_type'accounts_receivable' | 'accounts_payable' required
currency_code'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR' required
counterparty_org_idstring nullable

Must be a string starting with org_

counterparty_off_chrt_org_data_idstring nullable
counterparty_driver_idstring nullable
task_group_type'chrt_ground_provider' | 'cargo_on_flight' | 'cargo_on_vessel' | 'onboard_courier' required
applies_to_service_linesServiceLineEnum[]
effective_time_zone_namestring

IANA time zone name (e.g. America/New_York).

effective_starts_at_timestampstring date-time nullable
effective_ends_at_timestampstring date-time nullable
_idstring required
revisioninteger
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
archived_by_user_idstring nullable

Must be a string starting with user_

archived_at_timestampstring date-time nullable

Example response

{
  "effective_time_zone_name": "America/New_York"
}

Changes