Hoppa till innehållet

Goods receipts

Goods receipts — what physically arrived, from purchase orders and inbound transfers. Addressed by receiptNumber. Receiving against a purchase order line is done under PurchaseOrders.

3 calls GET Base URL https://api.erp.fluit.cloud/preview

Authentication, error codes, rate limits, idempotency and pagination apply to every call and are documented once under Getting started.

GET /receipts

List goods receipts

Returns a paginated list of goods receipts, sorted by receiptNumber. A receipt records what physically arrived; each line points back to the purchase order line or transfer order line it received against.

Show the full description

Receipts are created by receiving against a purchase order (POST /preview/purchase-orders/{orderNumber}/lines/{lineNumber}/receive) or a transfer order — there is no endpoint to create one directly, because a receipt without a document behind it is a stock adjustment.

Query parameters

Field Type Description
search string Matches the receipt number, case-insensitively and on partial words.
status enum Filters on how far the receipt has been processed. Draft InProgress Completed Cancelled
warehouseCode string Returns only the receipts booked into this warehouse.
modifiedSince string(date-time) Returns only records created or changed at or after this instant (ISO 8601 UTC datetime). A change anywhere inside the record counts, including on its lines.
page integer Page to return, 1-based. Default 1.
pageSize integer Number of records per page. Default 50, max 200.

Responses

200 PagedResult_PublicReceiptResponse

Paginated response: the fields below sit in items[], wrapped in totalCount, page, pageSize, totalPages, hasPreviousPage and hasNextPage. Paginated

Field Type Description
createdDate string(date-time) UTC timestamp when the receipt was created.
lines ReceiptLine[] · nullable The receipt's lines.
links Links Hypermedia links for a public API resource. Exposed as a computed `links` property on the public response DTOs so that create and read responses carry the same self-reference — the canonical URL is derived from the business key already present on the DTO and can never drift from the route it points at.
modifiedDate string(date-time) · nullable UTC timestamp when the receipt was last modified. Null if never modified.
notes string · nullable Free-text notes. Null if not set.
receiptDate string(date-time) UTC timestamp of the receipt.
receiptNumber string · nullable Unique receipt number.
status enum Status of a goods receipt. Draft InProgress Completed Cancelled
warehouseCode string · nullable Warehouse the goods arrived at.
400 ProblemDetails ?status= got a value outside its list.
Field Type
detail string · nullable
instance string · nullable
status integer · nullable
title string · nullable
type string · nullable

Standard errors: 401 403 Errors

Examples

curl
curl "https://api.erp.fluit.cloud/preview/receipts" \
  -H "X-Api-Key: fluit_live_sk_..."
Response 200
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "createdDate": "2026-06-11T09:24:13.418",
      "lines": [
        {
          "batchNumber": "ABC-001",
          "itemName": "Widget A",
          "itemNumber": "WIDGET-A",
          "lineNumber": 1,
          "locationCode": "STD",
          "notes": "string",
          "purchaseOrderNumber": "ABC-001",
          "quantity": "10",
          "serialNumber": "ABC-001",
          "transferOrderNumber": "ABC-001",
          "unitCost": "299.00"
        }
      ],
      "links": {
        "self": "string"
      },
      "modifiedDate": "2026-06-11T09:24:13.418",
      "notes": "string",
      "receiptDate": "2026-06-11T09:24:13.418",
      "receiptNumber": "REC-2026-0231",
      "status": "Draft",
      "warehouseCode": "MAIN"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalCount": 137,
  "totalPages": 3
}

Base URL https://api.erp.fluit.cloud/preview. The response example is generated from the schema: the shape is right, the values are made up.

GET /receipts/{receiptNumber}

Get a goods receipt by receipt number

Returns a goods receipt with its lines: what arrived, in what quantity, at what unit cost and into which location. Each line carries the purchase order number or transfer order number it received against, so the receipt can be matched back to the document that ordered it.

Show the full description

Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

receipts:read Supports ETag

Path parameters

Field Type Description
receiptNumber Required string Receipt number of the goods receipt to read.

Responses

200 PublicReceiptResponse
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Field Type Description
createdDate string(date-time) UTC timestamp when the receipt was created.
lines ReceiptLine[] · nullable The receipt's lines.
links Links Hypermedia links for a public API resource. Exposed as a computed `links` property on the public response DTOs so that create and read responses carry the same self-reference — the canonical URL is derived from the business key already present on the DTO and can never drift from the route it points at.
modifiedDate string(date-time) · nullable UTC timestamp when the receipt was last modified. Null if never modified.
notes string · nullable Free-text notes. Null if not set.
receiptDate string(date-time) UTC timestamp of the receipt.
receiptNumber string · nullable Unique receipt number.
status enum Status of a goods receipt. Draft InProgress Completed Cancelled
warehouseCode string · nullable Warehouse the goods arrived at.
304 Empty body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
404 ProblemDetails No goods receipt with that receipt number.
Field Type
detail string · nullable
instance string · nullable
status integer · nullable
title string · nullable
type string · nullable

Standard errors: 401 403 Errors

Examples

curl
curl "https://api.erp.fluit.cloud/preview/receipts/{receiptNumber}" \
  -H "X-Api-Key: fluit_live_sk_..."
Response 200
{
  "createdDate": "2026-06-11T09:24:13.418",
  "lines": [
    {
      "batchNumber": "ABC-001",
      "itemName": "Widget A",
      "itemNumber": "WIDGET-A",
      "lineNumber": 1,
      "locationCode": "STD",
      "notes": "string",
      "purchaseOrderNumber": "ABC-001",
      "quantity": "10",
      "serialNumber": "ABC-001",
      "transferOrderNumber": "ABC-001",
      "unitCost": "299.00"
    }
  ],
  "links": {
    "self": "string"
  },
  "modifiedDate": "2026-06-11T09:24:13.418",
  "notes": "string",
  "receiptDate": "2026-06-11T09:24:13.418",
  "receiptNumber": "REC-2026-0231",
  "status": "Draft",
  "warehouseCode": "MAIN"
}

Base URL https://api.erp.fluit.cloud/preview. The response example is generated from the schema: the shape is right, the values are made up.

GET /receipts/{receiptNumber}/lines

List goods receipt lines

Returns the lines on a goods receipt, sorted by line number ascending. The same lines are also embedded in GET /preview/receipts/{receiptNumber}; this endpoint exists so that a goods receipt with many lines can be paged through rather than arriving as one unbounded array.

receipts:read Paginated

Path parameters

Field Type Description
receiptNumber Required string Receipt number of the goods receipt whose lines to list.

Query parameters

Field Type Description
page integer Page to return, 1-based. Default 1.
pageSize integer Number of records per page. Default 50, max 200.

Responses

200 PagedResult_PublicReceiptLineResponse

Paginated response: the fields below sit in items[], wrapped in totalCount, page, pageSize, totalPages, hasPreviousPage and hasNextPage. Paginated

Field Type Description
batchNumber string · nullable Batch / lot number, for batch-tracked items.
itemName string · nullable Display name of the item.
itemNumber string · nullable Item number received.
lineNumber integer Line number, unique within the receipt.
locationCode string · nullable Location the goods were put into.
notes string · nullable Free-text notes on the line. Null if not set.
purchaseOrderNumber string · nullable Purchase order number this line received against. Null for transfer receipts.
quantity decimal Quantity received. Serialised as a decimal string.
serialNumber string · nullable Serial number, for serial-tracked items.
transferOrderNumber string · nullable Transfer order number this line received against. Null for purchase receipts.
unitCost decimal Unit cost booked, in the tenant's base currency. Serialised as a decimal string.
404 ProblemDetails No goods receipt with that receipt number.
Field Type
detail string · nullable
instance string · nullable
status integer · nullable
title string · nullable
type string · nullable

Standard errors: 401 403 Errors

Examples

curl
curl "https://api.erp.fluit.cloud/preview/receipts/{receiptNumber}/lines" \
  -H "X-Api-Key: fluit_live_sk_..."
Response 200
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "batchNumber": "ABC-001",
      "itemName": "Widget A",
      "itemNumber": "WIDGET-A",
      "lineNumber": 1,
      "locationCode": "STD",
      "notes": "string",
      "purchaseOrderNumber": "ABC-001",
      "quantity": "10",
      "serialNumber": "ABC-001",
      "transferOrderNumber": "ABC-001",
      "unitCost": "299.00"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalCount": 137,
  "totalPages": 3
}

Base URL https://api.erp.fluit.cloud/preview. The response example is generated from the schema: the shape is right, the values are made up.

Schemas

The objects this group's calls refer to. The field tables above go one level deep and link here rather than repeating the same schema on every endpoint.

ReceiptLine

PublicReceiptLineResponse

A line on a goods receipt.

Field Type Description
batchNumber string · nullable Batch / lot number, for batch-tracked items.
itemName string · nullable Display name of the item.
itemNumber string · nullable Item number received.
lineNumber integer Line number, unique within the receipt.
locationCode string · nullable Location the goods were put into.
notes string · nullable Free-text notes on the line. Null if not set.
purchaseOrderNumber string · nullable Purchase order number this line received against. Null for transfer receipts.
quantity decimal Quantity received. Serialised as a decimal string.
serialNumber string · nullable Serial number, for serial-tracked items.
transferOrderNumber string · nullable Transfer order number this line received against. Null for purchase receipts.
unitCost decimal Unit cost booked, in the tenant's base currency. Serialised as a decimal string.