TRANXACT.AI Help

Supply Chain · Invoices & Payment

Payment Proposals

What is due by a date, what discount is lost by waiting, and what to pay. Releasing it becomes a bank payment batch rather than a second way of paying.

Type REST13 operationsBase path /api/scm/payment-proposalsPublished as /api/v1/payment-proposals

Download specification (OpenAPI 3.1) Screen: Payment Proposals

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 › Payment Proposals 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.payment_proposals · 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

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

GET/api/scm/payment-proposalsList payment proposals

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",
      "proposal_no": "PRO-000001",
      "run_date": "2026-10-30",
      "pay_through": "2026-10-30",
      "currency": "USD",
      "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "payment_method": "text",
      "line_count": 10,
      "gross_amount": "1250.00",
      "discount_amount": "12.0000",
      "net_amount": "1250.00",
      "status": "draft",
      "batch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "proposal_no": "PRO-000001",
  "run_date": "2026-10-30",
  "pay_through": "2026-10-30",
  "currency": "USD",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payment_method": "text",
  "line_count": 10,
  "gross_amount": "1250.00",
  "discount_amount": "12.0000",
  "net_amount": "1250.00",
  "status": "draft",
  "batch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approved_by": "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/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/payment-proposalsCreate a payment proposals

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
run_datedateYesRun date
pay_throughdateYesPay everything due through
currencytextNoCurrency
bank_account_iduuidNoDrawn on
payment_methodtextNoMethod

Sample body

{
  "run_date": "2026-10-30",
  "pay_through": "2026-10-30",
  "currency": "USD",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payment_method": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "proposal_no": "PRO-000001",
  "run_date": "2026-10-30",
  "pay_through": "2026-10-30",
  "currency": "USD",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payment_method": "text",
  "line_count": 10,
  "gross_amount": "1250.00",
  "discount_amount": "12.0000",
  "net_amount": "1250.00",
  "status": "draft",
  "batch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/payment-proposals" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"run_date":"2026-10-30","pay_through":"2026-10-30","currency":"USD","bank_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","payment_method":"text"}'
PUT/api/scm/payment-proposals/{id}Change a payment proposals

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
run_datedateYesRun date
pay_throughdateYesPay everything due through
currencytextNoCurrency
bank_account_iduuidNoDrawn on
payment_methodtextNoMethod

Sample body

{
  "run_date": "2026-10-30",
  "pay_through": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "proposal_no": "PRO-000001",
  "run_date": "2026-10-30",
  "pay_through": "2026-10-30",
  "currency": "USD",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payment_method": "text",
  "line_count": 10,
  "gross_amount": "1250.00",
  "discount_amount": "12.0000",
  "net_amount": "1250.00",
  "status": "draft",
  "batch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"run_date":"2026-10-30","pay_through":"2026-10-30"}'
DELETE/api/scm/payment-proposals/{id}Delete a payment proposals

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/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/payment-proposals/{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/payment-proposals/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/payment-proposals/{id}/proposePropose

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/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/propose" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/payment-proposals/{id}/approveApprove

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/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/payment-proposals/{id}/releaseRelease

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/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/payment-proposals/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/payment-proposals/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/payment-proposals/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 PUT "https://demo.tranxact.ai/api/scm/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/payment-proposals/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/scm/payment-proposals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a payment proposals, 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
proposal_notextread onlyProposal no
run_datedateread, writeRun date
pay_throughdateread, writePay everything due through
currencytextread, writeCurrency
bank_account_iduuidread, writeDrawn on
payment_methodtextread, writeMethod
line_countintegerread onlyLine count
gross_amountnumericread onlyGross amount
discount_amountnumericread onlyDiscount amount
net_amountnumericread onlyNet amount
statustextread onlyStatus
batch_iduuidread onlyBatch id
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
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
proposed_byuuidread onlyProposed by
released_byuuidread onlyReleased by
released_attimestamp with time zoneread onlyReleased 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 › Payment Proposals 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.