Creates the intercompany bill for a committed intercompany transfer.

POST /inventory/warehouse-transfers/{id}/bill

Group: Inventory › Warehouse Transfers · Operation ID: billWarehouseTransfer

Creates the intercompany bill for a committed intercompany transfer and marks it billed. Billing is a separate call from the commit because it cannot be undone: the cancel path refuses a billed transfer, so folding billing into the commit would make every intercompany transfer uncancelable the moment the stock moved. The bill is priced from each line's unitTransferValue, in the contractual currency the transfer supplied when it was created. A transfer that is not intercompany, one not yet committed, and one already billed each fail with their own error. The bill belongs to the vendor-bill records, so intercompanyBillId is the platform's own number, not a UUID.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the transfer to bill.

Response

200 Success

Under data (billWarehouseTransferOutput):

Field Type Required Description
id string yes The unique identifier for the transfer.
billingStatus string yes The billing status of the transfer, read back from the document. 'BILLED' on success.
intercompanyBillId string no The identifier of the bill this created, as the platform's own number. GET accounting/vendor-bills/:id takes a UUID, so this number cannot fetch that bill.
intercompanyBillNumber string no The number of that bill.
journalEntryId string no The journal entry the billing wrote. See id on GET accounting/journal-entries/:id.
warnings array of string yes Non-fatal advisories from the billing. An empty array on a clean run.

Response headers

Errors

Code Status
NOT_FOUND 400
NOT_BILLABLE 400
ALREADY_BILLED 400
POSTING_REJECTED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses