Create from orders

POST

/billing_new/invoices/create_from_orders/v1

POST

/billing_new/invoices/create_from_orders/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.billingNew.invoices.createFromOrdersV1({
        currency_code: "USD",
        invoice_type: "accounts_receivable",
        order_ids: [
            "order_ids",
        ],
        schema_version: 1,
    });
}
main();

{
  "added_invoice_line_item_ids": [
    "added_invoice_line_item_ids"
  ],
  "already_invoiced_line_item_ids": [
    "already_invoiced_line_item_ids"
  ],
  "finalized_line_item_ids": [
    "finalized_line_item_ids"
  ],
  "invoice": {
    "_id": "_id",
    "created_at_timestamp": "2024-01-15T09:30:00Z",
    "created_by_user_id": "created_by_user_id",
    "currency_code": "USD",
    "invoice_type": "accounts_receivable",
    "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
    "last_edited_by_user_id": "last_edited_by_user_id",
    "owned_by_org_id": "owned_by_org_id",
    "period_end_at_timestamp": "2024-01-15T09:30:00Z",
    "period_start_at_timestamp": "2024-01-15T09:30:00Z",
    "schema_version": 1,
    "approved_at_timestamp": "2024-01-15T09:30:00Z",
    "approved_by_user_id": "approved_by_user_id",
    "counterparty_account_ids": [
      "counterparty_account_ids"
    ],
    "counterparty_driver_id": "counterparty_driver_id",
    "counterparty_off_chrt_org_data_id": "counterparty_off_chrt_org_data_id",
    "counterparty_org_id": "counterparty_org_id",
    "description": "description",
    "export_ref__sage__customer_id": "export_ref__sage__customer_id",
    "export_ref__sage__department_id": "export_ref__sage__department_id",
    "file_exported_at_timestamp": "2024-01-15T09:30:00Z",
    "file_exported_by_user_id": "file_exported_by_user_id",
    "invoice_line_item_ids": [
      "invoice_line_item_ids"
    ],
    "merge_exported_at_timestamp": "2024-01-15T09:30:00Z",
    "merge_exported_by_user_id": "merge_exported_by_user_id",
    "merge_invoice_id": "merge_invoice_id",
    "merge_invoice_number": "merge_invoice_number",
    "merge_invoice_url": "merge_invoice_url",
    "merge_linked_account_id": "merge_linked_account_id",
    "merge_remote_id": "merge_remote_id",
    "merge_remote_was_deleted": true,
    "merge_status": "draft",
    "name": "name",
    "status": "draft",
    "stripe_exported_at_timestamp": "2024-01-15T09:30:00Z",
    "stripe_exported_by_user_id": "stripe_exported_by_user_id",
    "stripe_invoice_id": "stripe_invoice_id",
    "stripe_invoice_number": "stripe_invoice_number",
    "stripe_invoice_url": "stripe_invoice_url",
    "stripe_status": "draft",
    "stripe_was_deleted": true,
    "total_amount": 1.1,
    "void_reason": "void_reason",
    "voided_at_timestamp": "2024-01-15T09:30:00Z",
    "voided_by_user_id": "voided_by_user_id"
  },
  "orders_without_added_charges": [
    "orders_without_added_charges"
  ],
  "unmatched_line_item_ids": [
    "unmatched_line_item_ids"
  ]
}

Creates one draft from matching order charges and reports skipped items. Billing period dates do not filter charges. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceCreateFromOrdersReq) -> (InvoiceCreateFromOrdersRes)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

currency_codeenumRequired

invoice_typeenumRequired

Allowed values:

order_idslist of stringsRequired

schema_versionintegerRequired

counterparty_driver_idstringOptional

counterparty_off_chrt_org_data_idstringOptional

counterparty_org_idstringOptional

Must be a string starting with org_

descriptionstringOptional<=32768 characters

export_ref__sage__customer_idstringOptional<=255 characters

export_ref__sage__department_idstringOptional<=255 characters

namestringOptional<=255 characters

period_end_at_timestampdatetimeOptional

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

period_start_at_timestampdatetimeOptional

Supply both bounds or omit both to derive the period from delivery completion days in UTC.

Response

Successful Response

added_invoice_line_item_idslist of stringsOptional

already_invoiced_line_item_idslist of stringsOptional

finalized_line_item_idslist of stringsOptional

invoiceobjectOptional

Created draft, or null when no charges qualify.

orders_without_added_chargeslist of stringsOptional

unmatched_line_item_idslist of stringsOptional

Charges for another counterparty, invoice type, or currency, regardless of status.

Errors

422

Invoices Create from Orders V1request Unprocessable Entity Error