SellerPayoutCharge
Type: schema
TypeScript Definition
typescript
SellerPayoutCharge: {{
/** @description Amount the charge was calculated on, as a decimal string. */
base_amount?: string;
/** @description Deduction amount, as a decimal string. */
charge_amount?: string;
/** @enum {string} */
charge_basis?: "percent" | "fixed" | "percent_plus_fixed";
/** @description Fixed component of the charge, as a decimal string. */
charge_fixed_amount?: string;
/** @description Percent component of the charge, as a decimal string. */
charge_percent?: string;
/**
* @description Nature of the deduction. `commission` is the marketplace fee, `tcs` and `tds` are statutory withholdings derived from the seller payout config, and `other` covers manually created charges.
* @enum {string}
*/
charge_type?: "commission" | "tcs" | "tds" | "other";
/** Format: date-time */
created_at?: string;
/**
* Format: date-time
* @description Only present on the charge-create response; omitted when the charge is nested under a `SellerPayoutInvoice`.
*/
modified_at?: string;
/** @description Number of the payout invoice this charge belongs to. Only present on the charge-create response; omitted when the charge is nested under a `SellerPayoutInvoice`. */
invoice_number?: string;
remarks?: string | null;
/** @description Tax on the charge, as a decimal string. */
tax_amount?: string;
/** @description Tax rate applied to the charge, as a decimal string. */
tax_rate?: string;
};
/** SellerPayoutConfig */
}OpenAPI Schema
json
{
"title": "SellerPayoutCharge",
"type": "object",
"properties": {
"base_amount": {
"description": "Amount the charge was calculated on, as a decimal string.",
"type": "string"
},
"charge_amount": {
"description": "Deduction amount, as a decimal string.",
"type": "string"
},
"charge_basis": {
"type": "string",
"enum": [
"percent",
"fixed",
"percent_plus_fixed"
]
},
"charge_fixed_amount": {
"description": "Fixed component of the charge, as a decimal string.",
"type": "string"
},
"charge_percent": {
"description": "Percent component of the charge, as a decimal string.",
"type": "string"
},
"charge_type": {
"description": "Nature of the deduction. `commission` is the marketplace fee, `tcs` and `tds` are statutory withholdings derived from the seller payout config, and `other` covers manually created charges.",
"type": "string",
"enum": [
"commission",
"tcs",
"tds",
"other"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"modified_at": {
"description": "Only present on the charge-create response; omitted when the charge is nested under a `SellerPayoutInvoice`.",
"type": "string",
"format": "date-time"
},
"invoice_number": {
"description": "Number of the payout invoice this charge belongs to. Only present on the charge-create response; omitted when the charge is nested under a `SellerPayoutInvoice`.",
"type": "string"
},
"remarks": {
"type": [
"string",
"null"
]
},
"tax_amount": {
"description": "Tax on the charge, as a decimal string.",
"type": "string"
},
"tax_rate": {
"description": "Tax rate applied to the charge, as a decimal string.",
"type": "string"
}
},
"x-tags": [
"Payouts"
]
}Auto-generated from OpenAPI spec and TypeScript definitions