TRANXACT.AI Help

Supply Chain · Buying

Service Receipt

A service is received by confirming it happened. Approval accrues the cost, so the ledger knows about work done before the invoice arrives.

Type REST9 operationsBase path /api/scm/service-entriesPublished as /api/v1/service-entries

Download specification (OpenAPI 3.1) Screen: Service Receipt

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Service Receipt on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablescm.service_entries · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

9 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/service-entriesList service receipt

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "entry_no": "ENT-000001",
      "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "po_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "description": "text",
      "period_start": "2026-10-30",
      "period_end": "2026-10-30",
      "quantity": "12.0000",
      "uom": "text",
      "unit_price": "1250.00",
      "amount": "1250.00",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/service-entries?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/service-entries/{id}Read one service entries

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "entry_no": "ENT-000001",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "quantity": "12.0000",
  "uom": "text",
  "unit_price": "1250.00",
  "amount": "1250.00",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/service-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/service-entriesCreate a service entries

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
po_iduuidNoAgainst order
po_line_iduuidNoPo line id
contract_iduuidNoAgainst contract
supplier_iduuidNoSupplier
descriptiontextYesWhat was done
period_startdateNoPeriod from
period_enddateNoPeriod to
quantitynumericNoQuantity
uomtextNoUnit — HR, DAY, EA…
unit_pricenumericNoRate
cost_center_iduuidNoCost center
performed_bytextNoPerformed by

Sample body

{
  "description": "text",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "entry_no": "ENT-000001",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "quantity": "12.0000",
  "uom": "text",
  "unit_price": "1250.00",
  "amount": "1250.00",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/service-entries" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description":"text","po_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","po_line_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","contract_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/service-entries/{id}Change a service entries

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
po_iduuidNoAgainst order
po_line_iduuidNoPo line id
contract_iduuidNoAgainst contract
supplier_iduuidNoSupplier
descriptiontextYesWhat was done
period_startdateNoPeriod from
period_enddateNoPeriod to
quantitynumericNoQuantity
uomtextNoUnit — HR, DAY, EA…
unit_pricenumericNoRate
cost_center_iduuidNoCost center
performed_bytextNoPerformed by

Sample body

{
  "description": "text",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "entry_no": "ENT-000001",
  "po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "quantity": "12.0000",
  "uom": "text",
  "unit_price": "1250.00",
  "amount": "1250.00",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/service-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description":"text","po_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/service-entries/{id}Delete a service entries

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/service-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/service-entries/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/service-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/scm/service-entries/{id}/approveApprove

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

accepted, reason, decision

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/service-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accepted":"value","reason":"value","decision":"value"}'
POST/api/scm/service-entries/{id}/submitSubmit

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/service-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/service-entries/{id}/mark-invoicedMark invoiced

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/service-entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mark-invoiced" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a service entries, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
entry_notextread onlyEntry no
po_iduuidread, writeAgainst order
po_line_iduuidread, writePo line id
contract_iduuidread, writeAgainst contract
supplier_iduuidread, writeSupplier
descriptiontextread, writeWhat was done
period_startdateread, writePeriod from
period_enddateread, writePeriod to
quantitynumericread, writeQuantity
uomtextread, writeUnit — HR, DAY, EA…
unit_pricenumericread, writeRate
amountnumericread onlyAmount
cost_center_iduuidread, writeCost center
performed_bytextread, writePerformed by
statustextread onlyStatus
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
rejection_reasontextread onlyRejection reason
journal_iduuidread onlyJournal id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
submitted_byuuidread onlySubmitted by
submitted_attimestamp with time zoneread onlySubmitted at
ap_invoice_iduuidread onlyAp invoice id
invoiced_attimestamp with time zoneread onlyInvoiced at

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Service Receipt for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.