> ## 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 an RMA

> Creates an RMA against a fulfilled invoice.

Send `sale_invoice.id` and the `returns` lines under `return_merchandise_authorisation`. The invoice must have fulfilled stock, and each return names a fulfilled invoice line and a quantity. The new RMA has `status` `active` and `return_status` `pending`.

> [!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_merchandise_authorisations
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_merchandise_authorisations:
    post:
      tags:
        - Return merchandise authorisations
      summary: Create an RMA
      description: >-
        Send `sale_invoice.id` and the `returns` lines under
        `return_merchandise_authorisation`. The invoice must have fulfilled
        stock, and each return names a fulfilled invoice line and a quantity.
        The new RMA has `status` `active` and `return_status` `pending`.
      operationId: >-
        return_merchandise_authorisations_create_return_merchandise_authorisation
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - return_merchandise_authorisation
              properties:
                return_merchandise_authorisation:
                  type: object
                  properties:
                    sale_invoice:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            The invoice's internal id: `inv_` followed by the
                            invoice's `uuid` with the hyphens removed.
                    returns:
                      type: array
                      items:
                        type: object
                        properties:
                          sale_invoice_line:
                            type: string
                            description: The `id` of a fulfilled line of the invoice.
                          rma_quantity:
                            type: number
            example:
              return_merchandise_authorisation:
                sale_invoice:
                  id: INVOICE_INTERNAL_ID
                returns:
                  - sale_invoice_line: INVOICE_LINE_ID
                    rma_quantity: 1
      responses:
        '201':
          description: >-
            The new RMA's `id`, `code`, `status` and `version`, under
            `return_merchandise_authorisation`.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ReturnMerchandiseAuthorisationCreateResponse
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            "$EXSITED_BASE_URL/api/v4/return_merchandise_authorisations" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "return_merchandise_authorisation": {
                  "sale_invoice": {
                    "id": "INVOICE_INTERNAL_ID"
                  },
                  "returns": [
                    {
                      "sale_invoice_line": "INVOICE_LINE_ID",
                      "rma_quantity": 1
                    }
                  ]
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = (
                client.return_merchandise_authorisations.create_return_merchandise_authorisation(
                    {
                        "return_merchandise_authorisation": {
                            "sale_invoice": {"id": "INVOICE_INTERNAL_ID"},
                            "returns": [
                                {"sale_invoice_line": "INVOICE_LINE_ID", "rma_quantity": 1}
                            ],
                        }
                    }
                )
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.returnMerchandiseAuthorisations.createReturnMerchandiseAuthorisation({
                return_merchandise_authorisation: {
                    sale_invoice: {id: 'INVOICE_INTERNAL_ID'},
                    returns: [{sale_invoice_line: 'INVOICE_LINE_ID', rma_quantity: 1}],
                },
            });

            console.log(response.data);
        - lang: php
          label: PHP
          source: >
            use Exsited\Client\ClientRegistry;


            $client = ClientRegistry::buildClient();


            $response =
            $client->returnMerchandiseAuthorisations->createReturnMerchandiseAuthorisation([
                'return_merchandise_authorisation' => [
                    'sale_invoice' => ['id' => 'INVOICE_INTERNAL_ID'],
                    'returns' => [['sale_invoice_line' => 'INVOICE_LINE_ID', 'rma_quantity' => 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_merchandise_authorisations.return_merchandise_authorisations_dto.ReturnMerchandiseAuthorisationsDto;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ReturnMerchandiseAuthorisationsDto.ReturnMerchandiseAuthorisations>
            response =
            client.returnMerchandiseAuthorisations().createReturnMerchandiseAuthorisation(
                    Map.of(
                            "return_merchandise_authorisation", Map.of(
                                    "sale_invoice", Map.of("id", "INVOICE_INTERNAL_ID"),
                                    "returns", List.of(
                                            Map.of("sale_invoice_line", "INVOICE_LINE_ID", "rma_quantity", 1)))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.ReturnMerchandiseAuthorisations.CreateReturnMerchandiseAuthorisationAsync(new
            Dictionary<string, object?>

            {
                ["return_merchandise_authorisation"] = new Dictionary<string, object?>
                {
                    ["sale_invoice"] = new Dictionary<string, object?>
                    {
                        ["id"] = "INVOICE_INTERNAL_ID",
                    },
                    ["returns"] = new List<object?>
                    {
                        new Dictionary<string, object?>
                        {
                            ["sale_invoice_line"] = "INVOICE_LINE_ID",
                            ["rma_quantity"] = 1,
                        },
                    },
                },
            });


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.returnMerchandiseAuthorisations
                .createReturnMerchandiseAuthorisation({
                  'return_merchandise_authorisation': {
                    'sale_invoice': {'id': 'INVOICE_INTERNAL_ID'},
                    'returns': [
                      {'sale_invoice_line': 'INVOICE_LINE_ID', 'rma_quantity': 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.ReturnMerchandiseAuthorisations().CreateReturnMerchandiseAuthorisation(context.Background(), map[string]any{\n\t\"return_merchandise_authorisation\": map[string]any{\n\t\t\"sale_invoice\": map[string]any{\"id\": \"INVOICE_INTERNAL_ID\"},\n\t\t\"returns\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"sale_invoice_line\": \"INVOICE_LINE_ID\",\n\t\t\t\t\"rma_quantity\":      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:
    ReturnMerchandiseAuthorisationCreateResponse:
      type: object
      required:
        - return_merchandise_authorisation
      properties:
        return_merchandise_authorisation:
          $ref: '#/components/schemas/ReturnMerchandiseAuthorisationCreated'
    ReturnMerchandiseAuthorisationCreated:
      type: object
      properties:
        activity_logs:
          type: array
        code:
          type: string
        href:
          type: string
        id:
          type: string
        object:
          type: string
        status:
          type: string
        version:
          type: integer
  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.