Create an intake

Allowed Scopes: experimental:intake:write

Create a new incoming invoice or credit note for a company's invoice inbox. This is step 3 of 3 in creating an intake from a document.

documentId is required and comes from an earlier upload: create one with Create an intake file upload, send the file to the presigned URL, then poll Get an intake file upload status until it reports ready and returns the documentId.

Idempotent retries. Send an optional Idempotency-Key header, any string of 1 to 255 characters such as your own system or ERP reference, to make a retry safe. Repeating a request with the same key for the same company returns 201 with the original intake and alreadyExisted: true, and creates nothing. The key is scoped to the company, so the same key sent by two companies creates two intakes, and it never expires. Once an intake is deleted, its key stays spent: retrying with it returns 409 rather than recreating the intake.

Note that the request body is ignored when a key is reused: if you send the same key with a different invoice, you receive the first intake back and the new body is discarded. Use a new key for each genuinely different invoice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company ID.

Body Params
string
enum
required
Allowed:
string
length ≥ 1

ID of the user to assign the intake to.

string
required

ID of the uploaded document, returned by a ready intake file upload.

string

Invoice currency.

date-time

Invoice due date. In the ISO 8601 date-time format.

number

Invoice gross amount.

string

Invoice number.

date-time

Invoice issue date. In the ISO 8601 date-time format.

string
length ≥ 1

ID of the purchase order to link. Takes precedence over purchaseOrderNumber. The purchase order must exist, be open, and be visible to the assignee, otherwise the request is rejected.

string
length ≤ 30
^([Pp][Oo]-)?\d+$

Related purchase order number, in the format: PO-123 or 123 (case insensitive). Ignored when purchaseOrderId is provided.

supplier
object
required
string

Free-text description.

string

ID of the cost center to associate with the intake.

number

Net amount.

customFieldsAssociations
array of objects

Custom field associations to apply to the intake.

customFieldsAssociations
lineItems
array of objects
length ≤ 1000

Line items extracted from the invoice.

lineItems
Headers
string
length between 1 and 255

Optional idempotency key. Repeating a request with the same key for the same company returns the original resource instead of creating a second one. Any string of 1 to 255 characters, for example your own system or ERP reference.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json