CLcloudkitchens
finance_endpoints

Post financial transactions

Post financial data related to a given order.

post/finance/v1/financial-transactions

Request

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Request body

idstring required

Stable external financial transaction identifier. Resubmitting with the same identifier and store updates the existing transaction; changing an identity value may create a separate record.

pendingboolean required

Whether the transaction may be corrected later. The current ingestion API does not reject a later submission solely because this value was false.

currencyCodestring required

The 3-letter currency code (ISO 4217) to use for all monetary values in this order.

createdAtstring date-time required

The date (in UTC) when the financial transaction was created.

customerIdstring nullable

Customer identifier.

notesstring nullable

General notes about the financial transaction.

type'PAYMENT' | 'ADJUSTMENT' | 'CANCELLATION' | 'MISC' required

Financial transaction operation type.

Example request

{
  "orderIdentifiers": {
    "id": "69f60a06-c335-46d9-b5a1-97f1a211c514",
    "source": "ubereats"
  },
  "currencyCode": "EUR",
  "createdAt": "2007-12-03T09:15:30.000Z",
  "payout": {
    "date": "2021-10-01T00:00:00.000Z"
  },
  "data": {
    "foodSales": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "feeForRestaurantProvidedDelivery": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "restaurantFundedDiscount": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "voucherDiscount": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "promotionDiscount": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "operatorDiscount": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "loyaltyDiscount": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "tipForRestaurant": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "adjustments": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "packingFee": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "bagFee": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "serviceProviderDiscount": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "tipForServiceProviderCourier": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "feeForServiceProviderDelivery": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "smallOrderFee": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "serviceFee": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "otherFee": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "netPayout": {
      "breakdown": [
        {
          "name": "sales tax.",
          "value": 3.4
        }
      ]
    },
    "couponCodes": [
      "TACOWED5OFF"
    ]
  }
}

Response

The financial transaction passed synchronous validation and was published to and queued by the ingestion system. This response does not confirm processing completion, including downstream validation, order association, or persistence.

Changes

No recorded changes to this operation across all 1 revision of this API.