CHchrt
/billing_new
/billing_new/invoices

Preview selected orders

Changed on

Selects matching uninvoiced ordinary charges, reports omitted items, and previews current taxes and billing dates without saving. Period dates do not filter charges. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceCreateFromOrdersReq) -> (InvoicePreviewFromOrdersRes)

post/billing_new/invoices/preview_from_orders/v1

Request

  • Base URL
    http://localhost:8000
  • Auth
    HTTP bearer

Request body

schema_version1 required
invoice_type'accounts_receivable' | 'accounts_payable' required
counterparty_org_idstring nullable

Must be a string starting with org_

counterparty_off_chrt_org_data_idstring nullable
counterparty_driver_idstring nullable
currency_code'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR' required
namestring nullable
descriptionstring nullable
export_ref__sage__department_idstring nullable
export_ref__sage__customer_idstring nullable
period_start_at_timestampstring date-time nullable

Supply both bounds or omit both to derive the period from completed or attempted delivery days, or a cancelled order's cancellation day, in UTC.

period_end_at_timestampstring date-time nullable

When derived, the exclusive UTC midnight after the last delivery day. Explicit bounds are preserved.

order_idsstring[] required

Response

Successful Response

tax_configurations_by_line_item_idobject
already_invoiced_line_item_idsstring[]
finalized_line_item_idsstring[]
unmatched_line_item_idsstring[]
tax_line_item_idsstring[]
orders_without_selected_chargesstring[]

Changes

  • 05afd8b01f0cRevision changes
    • breaking

      response property invoice_line_items/items/created_by_user_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property invoice_line_items/items/last_edited_by_user_id list-of-types was widened by adding types null to media type application/json of response 200

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property ///// to the response with the status

  • 1a1e5a995fc9Revision changes
    • breaking

      removed the required property /// from the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status