Post a financial invoice

Post a financial invoice containing payout and financial data for orders in a given period of time.

post/finance/v1/financial-invoices

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesfinance
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/finance/v1/financial-invoices/post.ts
A function with typed inputs. Its response is checked against the schema.

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

sourceServicestring nullable

Describes the source of the order, typically from a food ordering marketplace.

currencyCodestring

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

Example request

{
  "sourceService": "ubereats",
  "payout": {
    "date": "2021-10-01T00:00:00.000Z",
    "summary": {
      "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"
      ]
    },
    "total": 19.07
  },
  "financialTransactions": [
    {
      "orderIdentifiers": {
        "id": "69f60a06-c335-46d9-b5a1-97f1a211c514"
      },
      "createdAt": "2007-12-03T09:15:30.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"
        ]
      }
    }
  ],
  "currencyCode": "EUR"
}

Response

The financial invoice 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.