cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/return_merchandise_authorisations/RMA-0001" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.invoices.get_invoice_rma("INV-0001", "RMA-0001")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.invoices.getInvoiceRma('INV-0001', 'RMA-0001');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->invoices->getInvoiceReturnMerchandiseAuthorisation('INV-0001', 'RMA-0001');
print_r($response->data);
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.ReturnMerchandiseAuthorisationRead;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ReturnMerchandiseAuthorisationRead> response = client.invoices().getInvoiceReturnMerchandiseAuthorisation(
"INV-0001",
"RMA-0001");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Invoices.GetInvoiceReturnMerchandiseAuthorisationAsync(
"INV-0001",
"RMA-0001");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.invoices
.getInvoiceReturnMerchandiseAuthorisation('INV-0001', 'RMA-0001');
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Invoices().GetInvoiceReturnMerchandiseAuthorisation(context.Background(), "INV-0001", "RMA-0001", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"return_merchandise_authorisation": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"href": "<string>",
"id": "<string>",
"item_count": 123,
"last_updated_by": "<unknown>",
"last_updated_on": "<unknown>",
"lines": [
"<unknown>"
],
"note": "<string>",
"object": "<string>",
"receive_rmas": [
{
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"href": "<string>",
"id": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<unknown>",
"object": "<string>",
"quantity_received": 123,
"status": "<string>"
}
],
"return_status": "<string>",
"rma_date": "<string>",
"sale_invoice": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"sale_order": "<unknown>",
"status": "<string>",
"version": 123,
"warehouse": "<unknown>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Invoices
Retrieve an invoice's return merchandise authorisation
Returns one return merchandise authorisation raised against an invoice.
GET
/
invoices
/
{invoice_id}
/
return_merchandise_authorisations
/
{rma_id}
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/return_merchandise_authorisations/RMA-0001" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.invoices.get_invoice_rma("INV-0001", "RMA-0001")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.invoices.getInvoiceRma('INV-0001', 'RMA-0001');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->invoices->getInvoiceReturnMerchandiseAuthorisation('INV-0001', 'RMA-0001');
print_r($response->data);
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.ReturnMerchandiseAuthorisationRead;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ReturnMerchandiseAuthorisationRead> response = client.invoices().getInvoiceReturnMerchandiseAuthorisation(
"INV-0001",
"RMA-0001");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Invoices.GetInvoiceReturnMerchandiseAuthorisationAsync(
"INV-0001",
"RMA-0001");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.invoices
.getInvoiceReturnMerchandiseAuthorisation('INV-0001', 'RMA-0001');
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Invoices().GetInvoiceReturnMerchandiseAuthorisation(context.Background(), "INV-0001", "RMA-0001", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"return_merchandise_authorisation": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"href": "<string>",
"id": "<string>",
"item_count": 123,
"last_updated_by": "<unknown>",
"last_updated_on": "<unknown>",
"lines": [
"<unknown>"
],
"note": "<string>",
"object": "<string>",
"receive_rmas": [
{
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"href": "<string>",
"id": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<unknown>",
"object": "<string>",
"quantity_received": 123,
"status": "<string>"
}
],
"return_status": "<string>",
"rma_date": "<string>",
"sale_invoice": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"sale_order": "<unknown>",
"status": "<string>",
"version": 123,
"warehouse": "<unknown>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Fetches a single return merchandise authorisation of the invoice, with its lines. One that belongs to a different invoice returns
404.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. 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.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The invoice's id, such as INV-0001. Not its uuid.
The return merchandise authorisation's id.
Response
The return merchandise authorisation, under return_merchandise_authorisation.
Show child attributes
Show child attributes