---
updatedAt: 2025-06-05T21:41:11.000Z
agentTools:
  projectIndex: https://apidocs.officient.io/llms.txt
---

# Set payout method and status

This end-point allows you to set the payout method, status and other related information for an existing expense.

Scope required: expenses:write

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "officient-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.officient.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/1.0/expenses/{expense_id}/updatePayout": {
      "post": {
        "summary": "Set payout method and status",
        "description": "",
        "operationId": "set-payout-method-and-status",
        "parameters": [
          {
            "name": "expense_id",
            "in": "path",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "new_payout_method"
                ],
                "properties": {
                  "new_payout_method": {
                    "type": "string",
                    "enum": [
                      "UNDECIDED",
                      "DO_NOT_PAYOUT",
                      "PAYOUT_ACCOUNTING",
                      "PAYOUT_OTHER",
                      "PAYOUT_MANUALLY",
                      "PAYOUT_USING_PAYROLL_PROVIDER"
                    ]
                  },
                  "payout_other_reason": {
                    "type": "string"
                  },
                  "payout_status": {
                    "type": "string",
                    "description": "This field is required when the \"new\"payout_method\" is either PAYOUT_ACCOUNTING, PAYOUT_OTHER or PAYOUT_MANUALLY",
                    "enum": [
                      "PAID_OUT",
                      "NOT_PAID_OUT"
                    ]
                  },
                  "period": {
                    "type": "string"
                  },
                  "year": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"success\": 1\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status_code\": 400,\n    \"reason_phrase\": \"Missing payout status. Please set a valid payout_status.\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status_code": {
                          "type": "integer",
                          "example": 400,
                          "default": 0
                        },
                        "reason_phrase": {
                          "type": "string",
                          "example": "Invalid payout method."
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "status_code": {
                          "type": "integer",
                          "example": 400,
                          "default": 0
                        },
                        "reason_phrase": {
                          "type": "string",
                          "example": "Undecided, unpaid and payroll expenses can't have a payout status. Update new_payout_method to another method."
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "status_code": {
                          "type": "integer",
                          "example": 400,
                          "default": 0
                        },
                        "reason_phrase": {
                          "type": "string",
                          "example": "Missing payout status. Please set a valid payout_status."
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```