> ## Documentation Index > Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create a return vendor authorization > Creates a return to a supplier for purchase order lines and returns it under `return_vendor_authorization`. Creates a return vendor authorization for lines of a purchase order, wrapped in `return_vendor_authorization`. Name the purchase order by its `id`, and each line by its `purchase_order_line` id with the `rva_qty` to return. Send `create_as_draft: true` to save it as a draft. > [!NOTE] > > The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload. ## OpenAPI ````yaml POST /return_vendor_authorizations openapi: 3.1.0 info: title: Exsited API version: v4 servers: - url: https://{host}/api/v4 variables: host: default: your-api-host.example.com description: Your Exsited API host name, without https://. security: - bearerAuth: [] tags: - name: Authentication - name: Accounts - name: Account emails - name: Account groups - name: Communications - name: Communication profiles - name: Orders - name: Quote orders - name: Express - name: Usages - name: Sales reps - name: Gift certificates - name: Invoices - name: Pro-forma invoices - name: Payments - name: Refunds - name: Credit notes - name: Credit note applications - name: Reconciliations - name: Items - name: Inventory adjustments - name: Units of measurement - name: Zones - name: Shipping packages - name: Shipping rules - name: Fulfillment profiles - name: Fulfillment terms - name: Item fulfillments - name: Item receipts - name: Bookings - name: Rental assets - name: Return merchandise authorisations - name: Purchase orders - name: Purchase invoices - name: Purchase payments - name: Purchase refunds - name: Purchase credit notes - name: Purchase credit note applications - name: Purchase express - name: Return vendor authorizations - name: ABA files - name: Receive terms - name: Labours - name: Tasks - name: Timesheets - name: Milestones - name: Employees - name: Departments - name: Designations - name: Teams - name: Time periods - name: Workflows - name: Workflow settings - name: Events - name: Custom events - name: System events - name: Approvals - name: Approval profiles - name: Approval user groups - name: Alerts - name: Alert responsibility settings - name: Alert responsibilities - name: Action scripts - name: Note groups - name: Note attachments - name: Instance settings - name: Accounting codes - name: Additional codes - name: Billing periods - name: Charging periods - name: Pricing periods - name: Invoice terms - name: Days of the month - name: Countries - name: Salutations - name: Document templates - name: Email templates - name: Roles - name: Operators - name: Operator groups - name: User settings - name: Custom attributes - name: Custom components - name: Custom features - name: Custom fields - name: Custom forms - name: Attribute attachments - name: Portal - name: Integration connections - name: External databases - name: Reports - name: Applications - name: Organisation - name: Child organisations - name: Webhooks paths: /return_vendor_authorizations: post: tags: - Return vendor authorizations summary: Create a return vendor authorization description: >- Creates a return vendor authorization for lines of a purchase order, wrapped in `return_vendor_authorization`. Name the purchase order by its `id`, and each line by its `purchase_order_line` id with the `rva_qty` to return. Send `create_as_draft: true` to save it as a draft. operationId: return_vendor_authorizations_create_return_vendor_authorization parameters: [] requestBody: required: true content: application/json: schema: type: object properties: return_vendor_authorization: type: object properties: purchase_order: type: string description: The purchase order's `id`. create_as_draft: type: boolean description: '`true` saves the return as a draft.' lines: type: array items: type: object properties: purchase_order_line: type: string description: >- The purchase order line's `id`, from the purchase order's lines list. rva_qty: type: number description: How many units to return. required: - return_vendor_authorization example: return_vendor_authorization: purchase_order: PURCHASE_ORDER_ID create_as_draft: true lines: - purchase_order_line: line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c rva_qty: 1 responses: '201': description: >- The new return vendor authorization, under `return_vendor_authorization`. content: application/json: schema: $ref: '#/components/schemas/ReturnVendorAuthorizationResponse' x-codeSamples: - lang: bash label: cURL source: >- curl -X POST "$EXSITED_BASE_URL/api/v4/return_vendor_authorizations" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "return_vendor_authorization": { "purchase_order": "PURCHASE_ORDER_ID", "create_as_draft": true, "lines": [ { "purchase_order_line": "line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c", "rva_qty": 1 } ] } }' - lang: python label: Python source: > from exsited import build_client client = build_client() response = client.return_vendor_authorizations.create_return_vendor_authorization( { "return_vendor_authorization": { "purchase_order": "PURCHASE_ORDER_ID", "create_as_draft": True, "lines": [ { "purchase_order_line": "line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c", "rva_qty": 1, } ], } } ) print(response.data) - lang: javascript label: JavaScript source: > import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.returnVendorAuthorizations.createReturnVendorAuthorization({ return_vendor_authorization: { purchase_order: 'PURCHASE_ORDER_ID', create_as_draft: true, lines: [{purchase_order_line: 'line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c', rva_qty: 1}], }, }); console.log(response.data); - lang: php label: PHP source: > use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->returnVendorAuthorizations->createReturnVendorAuthorization([ 'return_vendor_authorization' => [ 'purchase_order' => 'PURCHASE_ORDER_ID', 'create_as_draft' => true, 'lines' => [ ['purchase_order_line' => 'line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c', 'rva_qty' => 1], ], ], ]); print_r($response->data); - lang: java label: Java source: > import com.exsited.client.ApiResponse; import com.exsited.client.ClientRegistry; import com.exsited.client.ExsitedClient; import com.exsited.resources.return_vendor_authorizations.return_vendor_authorizations_dto.ReturnVendorAuthorizationsDto.ReturnVendorAuthorizationView; import java.util.List; import java.util.Map; ExsitedClient client = ClientRegistry.buildClient(); ApiResponse response = client.returnVendorAuthorizations().createReturnVendorAuthorization( Map.of( "return_vendor_authorization", Map.of( "purchase_order", "PURCHASE_ORDER_ID", "create_as_draft", true, "lines", List.of( Map.of( "purchase_order_line", "line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c", "rva_qty", 1))))); System.out.println(response.getMap()); - lang: csharp label: .NET source: > using Exsited.Client; await using var client = ExsitedClient.BuildClient(); var response = await client.ReturnVendorAuthorizations.CreateReturnVendorAuthorizationAsync(new Dictionary { ["return_vendor_authorization"] = new Dictionary { ["purchase_order"] = "PURCHASE_ORDER_ID", ["create_as_draft"] = true, ["lines"] = new List { new Dictionary { ["purchase_order_line"] = "line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c", ["rva_qty"] = 1, }, }, }, }); Console.WriteLine(response.Json); - lang: dart label: Dart source: | import 'package:exsited/exsited.dart'; final client = buildClient(); final response = await client.returnVendorAuthorizations .createReturnVendorAuthorization({ 'return_vendor_authorization': { 'purchase_order': 'PURCHASE_ORDER_ID', 'create_as_draft': true, 'lines': [ { 'purchase_order_line': 'line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c', 'rva_qty': 1, }, ], }, }); print(response.map); - lang: go label: Go source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.ReturnVendorAuthorizations().CreateReturnVendorAuthorization(context.Background(), map[string]any{\n\t\"return_vendor_authorization\": map[string]any{\n\t\t\"purchase_order\": \"PURCHASE_ORDER_ID\",\n\t\t\"create_as_draft\": true,\n\t\t\"lines\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"purchase_order_line\": \"line_3f2a9c1e7b4d4e8a9c0b1d2e3f4a5b6c\",\n\t\t\t\t\"rva_qty\": 1,\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: schemas: ReturnVendorAuthorizationResponse: type: object properties: return_vendor_authorization: $ref: '#/components/schemas/ReturnVendorAuthorizationView' ReturnVendorAuthorizationView: type: object properties: account: $ref: '#/components/schemas/ReturnVendorAuthorizationAccount' code: type: string created_by: $ref: '#/components/schemas/ReturnVendorAuthorizationCreatedBy' created_on: type: string href: type: string id: type: string item_count: type: integer last_updated_by: {} last_updated_on: {} note: type: string object: type: string purchase_order: $ref: '#/components/schemas/ReturnVendorAuthorizationPurchaseOrder' return_status: type: string rva_date: type: string status: type: string version: type: integer lines: type: array items: {} receive_rvas: type: array items: {} ReturnVendorAuthorizationAccount: type: object properties: code: type: string href: type: string id: type: string name: type: string object: type: string ReturnVendorAuthorizationCreatedBy: type: object properties: name: type: string object: type: string ReturnVendorAuthorizationPurchaseOrder: type: object properties: code: type: string href: type: string id: type: string object: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: >- An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.