API Reference›LMS API›Merchant advances›Record a merchant sales report

Record a merchant sales report

POSThttps://sandbox.api.lendeasy.ai/v1/merchant-advances/{advanceId}/sales-reports Bearer token · CREATE_MERCHANT_REPORT

Records verified settled sales, calculates remittance, and does not reduce balance until money posts.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances/$ADVANCE_ID/sales-reports \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "currency": "USD",
  "settledSales": "11875.40",
  "source": "processor_report",
  "sourceReference": "settlement_884210"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances/${advanceId}/sales-reports`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "currency": "USD",
  "settledSales": "11875.40",
  "source": "processor_report",
  "sourceReference": "settlement_884210"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances/{advance_id}/sales-reports",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "currency": "USD",
  "settledSales": "11875.40",
  "source": "processor_report",
  "sourceReference": "settlement_884210"
},
)

{
  "salesReportId": "msr_91DC",
  "advanceId": "ma_northstar_6N8Q",
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "settledSales": "11875.40",
  "calculatedRemittance": "1425.05",
  "status": "accepted",
  "sourceReference": "settlement_884210"
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
advanceId required in path	string	Stable opaque advance identifier.
Idempotency-Key optional in header	string	Optional stable key (1-50 chars) for this one logical mutation. Replays of a completed request return the original result with x-served-from-cache: true; an in-flight duplicate returns 409 with Retry-After. Omitted keys are server-generated per attempt.

Body parameters

Field	Type	Description
periodStart required	string
periodEnd required	string
currency required	string	ISO 4217 currency code.
settledSales required	string
source required	string	System or actor that originated the record.
sourceReference required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/merchant-advances/$ADVANCE_ID/sales-reports \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "currency": "USD",
  "settledSales": "11875.40",
  "source": "processor_report",
  "sourceReference": "settlement_884210"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/merchant-advances/${advanceId}/sales-reports`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "currency": "USD",
  "settledSales": "11875.40",
  "source": "processor_report",
  "sourceReference": "settlement_884210"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/merchant-advances/{advance_id}/sales-reports",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "currency": "USD",
  "settledSales": "11875.40",
  "source": "processor_report",
  "sourceReference": "settlement_884210"
},
)

{
  "salesReportId": "msr_91DC",
  "advanceId": "ma_northstar_6N8Q",
  "periodStart": "2026-09-08",
  "periodEnd": "2026-09-09",
  "settledSales": "11875.40",
  "calculatedRemittance": "1425.05",
  "status": "accepted",
  "sourceReference": "settlement_884210"
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}