v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

receipts

Create a single receipt

Creates a new receipt linked to an existing purchase order. The receipt_number field is required and must be provided by the client

post/receipts

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Request body

ottimate_po_idstring

Ottimate-assigned purchase order ID. Required unless using PO lookup fields (erp_vendor_id + ottimate_location_id + po_number/po_external_id).

ottimate_location_idinteger

Location ID for PO lookup. Required when using lookup fields instead of ottimate_po_id.

erp_vendor_idstring

ERP vendor ID for PO lookup. Required when using lookup fields instead of ottimate_po_id.

po_numberstring

PO number for lookup. Use with erp_vendor_id + ottimate_location_id when ottimate_po_id is not provided.

po_external_idstring

External ID (dd_unique_key) of the PO for lookup. Alternative to po_number.

external_idstring

External unique identifier for this receipt.

receipt_numberstring required

datestring date required

total_amountnumber double required

invoice_number_refstring

Invoice reference number

notestring

Response

Successfully created

idstring required

external_idstring

receipt_numberstring

ottimate_po_idstring

datestring date

total_amountnumber double

items_countinteger

created_datestring date-time

Creation timestamp. UTC ISO 8601, e.g. "2024-01-16T14:30:00Z".