CHchrt
/billing_new
/billing_new/billing_periods

Create

Changed on

Creates an open owner-scoped billing period. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingPeriodClientCreate1) -> (BillingPeriod1)

post/billing_new/billing_periods/create/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/billing_new/billing_periods/create/v1
  • Auth
    HTTP bearer

Request body

schema_version1 required
invoice_type'accounts_receivable' | 'accounts_payable' required
currency_code'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR' required
namestring nullable
descriptionstring required
amountnumber required
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
period_start_at_timestampstring date-time required
period_end_at_timestampstring date-time required
cycle'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required
task_group_idsstring[]

Response

Successful Response

schema_version1 required
invoice_type'accounts_receivable' | 'accounts_payable' required
currency_code'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR' required
namestring nullable
descriptionstring required
amountnumber required
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
period_start_at_timestampstring date-time required
period_end_at_timestampstring date-time required
cycle'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required
task_group_idsstring[]
owned_by_org_idstring required

Must be a string starting with org_

status'open' | 'closed'
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
closed_by_user_idstring nullable

Must be a string starting with user_

closed_at_timestampstring date-time nullable
_idstring required

Changes

  • 9a30893d8db1Revision changes
    • breaking

      removed the enum value XXX of the request property

    • info

      api tag /billing_new/billing_periods added

    • info

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