SellerPayoutInvoice
Type: schema
Description
A seller invoice tracked through the payout pipeline, from eligibility to settlement in a payout batch.
TypeScript Definition
typescript
SellerPayoutInvoice: {{
/**
* Format: date-time
* @description When the invoice was pulled into a payout batch. `null` until then.
*/
batch_assigned_at?: string | null;
/** @description Billing business name from the invoice, falling back to the order. `null` when neither carries one. */
billing_business_name?: string | null;
/** @description `SellerPayoutCharge` records deducted from this invoice, such as `commission`, `tcs`, and `tds`. Their total is `marketplace_charges`. */
charges?: components["schemas"]["SellerPayoutCharge"][];
/** @description Coupon discount deducted from the invoice total. */
coupon_discount_amount?: number;
/** Format: date-time */
created_at?: string;
/** @description Invoice total payable by the customer, after discounts, tax, and shipping. Basis for the payable amount. */
grand_total?: number;
/** @description Payout invoice ULID. */
id?: string;
/** Format: date-time */
invoice_date?: string;
/** @description Underlying invoice database identifier. */
invoice_id?: number;
invoice_number?: string;
/** @description Value of loyalty points redeemed against the invoice. */
loyalty_point_redeemed?: number;
/** @description Marketplace context for this payout invoice. Returned as `null` when not applicable. */
marketplace_detail?: {
[key: string]: unknown;
} | null;
/** @description Commission and other marketplace charges deducted from this invoice, as a decimal string. */
marketplace_charges?: string;
/** @description Tax levied on `marketplace_charges`, as a decimal string. */
marketplace_charges_tax_amount?: string;
/** Format: date-time */
modified_at?: string;
order_id?: number;
order_number?: string;
/** @description Linked payout batch ULID. `null` while the invoice is unbatched. */
payout_batch_id?: string | null;
/**
* Format: date
* @description Date the invoice becomes payable, derived from the seller's configured `hold_period_days`.
*/
payout_eligible_at?: string;
/** @description Promotion discount deducted from the invoice total. */
promotion_discount_amount?: number;
seller_id?: string;
seller_name?: $Read<string>;
shipment_id?: number | null;
shipment_reference_no?: string | null;
/** @description Shipping charged on the invoice, excluding tax. */
shipping_amount?: number;
/** @description Shipping charged on the invoice, including tax. Counted towards the payout only when the seller's `include_shipping_in_payout` is `true`. */
shipping_amount_including_tax?: number;
status?: components["schemas"]["SellerPayoutInvoiceStatus"];
/** @description Item total before tax, discounts, and shipping. */
sub_total?: number;
/** @description Item total including tax. Counted towards the payout without tax when the seller's `include_tax_in_payout` is `false`. */
sub_total_including_tax?: number;
};
/**
* SellerPayoutInvoiceStatus
* @description Payout state of an invoice. Invoices move `pending` → `eligible` → `batched` → `paid`. `on_hold` invoices are skipped by batching until released.
* @enum {string}
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["SellerPayoutCharge"] | SellerPayoutCharge |
components["schemas"]["SellerPayoutInvoiceStatus"] | SellerPayoutInvoiceStatus |
OpenAPI Schema
json
{
"title": "SellerPayoutInvoice",
"description": "A seller invoice tracked through the payout pipeline, from eligibility to settlement in a payout batch.",
"type": "object",
"properties": {
"batch_assigned_at": {
"description": "When the invoice was pulled into a payout batch. `null` until then.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"billing_business_name": {
"description": "Billing business name from the invoice, falling back to the order. `null` when neither carries one.",
"type": [
"string",
"null"
]
},
"charges": {
"description": "`SellerPayoutCharge` records deducted from this invoice, such as `commission`, `tcs`, and `tds`. Their total is `marketplace_charges`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SellerPayoutCharge"
}
},
"coupon_discount_amount": {
"description": "Coupon discount deducted from the invoice total.",
"type": "number"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"grand_total": {
"description": "Invoice total payable by the customer, after discounts, tax, and shipping. Basis for the payable amount.",
"type": "number"
},
"id": {
"description": "Payout invoice ULID.",
"type": "string"
},
"invoice_date": {
"type": "string",
"format": "date-time"
},
"invoice_id": {
"description": "Underlying invoice database identifier.",
"type": "integer"
},
"invoice_number": {
"type": "string"
},
"loyalty_point_redeemed": {
"description": "Value of loyalty points redeemed against the invoice.",
"type": "number"
},
"marketplace_detail": {
"description": "Marketplace context for this payout invoice. Returned as `null` when not applicable.",
"type": [
"object",
"null"
],
"additionalProperties": true
},
"marketplace_charges": {
"description": "Commission and other marketplace charges deducted from this invoice, as a decimal string.",
"type": "string"
},
"marketplace_charges_tax_amount": {
"description": "Tax levied on `marketplace_charges`, as a decimal string.",
"type": "string"
},
"modified_at": {
"type": "string",
"format": "date-time"
},
"order_id": {
"type": "integer"
},
"order_number": {
"type": "string"
},
"payout_batch_id": {
"description": "Linked payout batch ULID. `null` while the invoice is unbatched.",
"type": [
"string",
"null"
]
},
"payout_eligible_at": {
"description": "Date the invoice becomes payable, derived from the seller's configured `hold_period_days`.",
"type": "string",
"format": "date"
},
"promotion_discount_amount": {
"description": "Promotion discount deducted from the invoice total.",
"type": "number"
},
"seller_id": {
"type": "string"
},
"seller_name": {
"type": "string",
"readOnly": true
},
"shipment_id": {
"type": [
"integer",
"null"
]
},
"shipment_reference_no": {
"type": [
"string",
"null"
]
},
"shipping_amount": {
"description": "Shipping charged on the invoice, excluding tax.",
"type": "number"
},
"shipping_amount_including_tax": {
"description": "Shipping charged on the invoice, including tax. Counted towards the payout only when the seller's `include_shipping_in_payout` is `true`.",
"type": "number"
},
"status": {
"$ref": "#/components/schemas/SellerPayoutInvoiceStatus"
},
"sub_total": {
"description": "Item total before tax, discounts, and shipping.",
"type": "number"
},
"sub_total_including_tax": {
"description": "Item total including tax. Counted towards the payout without tax when the seller's `include_tax_in_payout` is `false`.",
"type": "number"
}
},
"x-tags": [
"Payouts"
]
}Auto-generated from OpenAPI spec and TypeScript definitions