RMA returns

Returned lines against an RMA.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
rma_arorderid	integer	Rma arorderid. Id only.
return_date	string	Date the goods were returned.
taxid	integer	Taxid. Id only.
taxcreditmoney	string(5dp)	Stored as `decimal(19,5)`.
taxid2	integer	Second sales tax applied to the return.
taxcredit2money	string(5dp)	Stored as `decimal(19,5)`.
taxid3	integer	Third sales tax applied to the return.
taxcredit3money	string(5dp)	Stored as `decimal(19,5)`.
shipping_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
restock_feemoney	string(5dp)	Stored as `decimal(19,5)`.
total_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
voucherid	integer	Voucherid. Id only.
voucher	string(50)	The `voucher` of the referenced gltransactions, instead of the id. Send this or `voucherid`, not both unless they agree.
new_orderid	integer	New orderid. Id only.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydate	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/rmareturns/batch 207

Create many.

Requires scope orders:write.

Parameters

Name	In	Type	Notes
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
rma_arorderid	integer	Rma arorderid. Id only.
return_date	string	Date the goods were returned.
taxid	integer	Taxid. Id only.
taxcreditmoney	string(5dp)	Stored as `decimal(19,5)`.
taxid2	integer	Second sales tax applied to the return.
taxcredit2money	string(5dp)	Stored as `decimal(19,5)`.
taxid3	integer	Third sales tax applied to the return.
taxcredit3money	string(5dp)	Stored as `decimal(19,5)`.
shipping_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
restock_feemoney	string(5dp)	Stored as `decimal(19,5)`.
total_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
voucherid	integer	Voucherid. Id only.
voucher	string(50)	The `voucher` of the referenced gltransactions, instead of the id. Send this or `voucherid`, not both unless they agree.
new_orderid	integer	New orderid. Id only.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydate	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/rmareturns/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "rma_arorderid": 104,
        "return_date": "2026-08-01",
        "taxid": 104,
        "taxcredit": "125.0000",
        "taxid2": 1,
        "taxcredit2": "125.0000"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/rmareturns/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'rma_arorderid' => 104,
      'return_date' => '2026-08-01',
      'taxid' => 104,
      'taxcredit' => '125.0000',
      'taxid2' => 1,
      'taxcredit2' => '125.0000',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/rmareturns/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "rma_arorderid": 104,
            "return_date": "2026-08-01",
            "taxid": 104,
            "taxcredit": "125.0000",
            "taxid2": 1,
            "taxcredit2": "125.0000",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/rmareturns/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        rma_arorderid: 104,
        return_date: "2026-08-01",
        taxid: 104,
        taxcredit: "125.0000",
        taxid2: 1,
        taxcredit2: "125.0000",
      },
    ]),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new[] {
    new {
        rma_arorderid = 104,
        return_date = "2026-08-01",
        taxid = 104,
        taxcredit = "125.0000",
        taxid2 = 1,
        taxcredit2 = "125.0000",
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/rmareturns/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/rmareturns 200403

List rma returns.

Requires scope orders:read.

Parameters

Name	In	Type	Notes
invoiceid	query	string	Restrict to one invoiceid.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
externalid	query	string	Exact match on your own key.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks read scope.

curl \
  'https://acme.nolapro.com/!/api/v2/rmareturns' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/rmareturns');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/rmareturns",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/rmareturns',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/rmareturns");
res.EnsureSuccessStatusCode();

POST/rmareturns 201400

Create.

Requires scope orders:write.

Parameters

Name	In	Type	Notes
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
rma_arorderid	integer	Rma arorderid. Id only.
return_date	string	Date the goods were returned.
taxid	integer	Taxid. Id only.
taxcreditmoney	string(5dp)	Stored as `decimal(19,5)`.
taxid2	integer	Second sales tax applied to the return.
taxcredit2money	string(5dp)	Stored as `decimal(19,5)`.
taxid3	integer	Third sales tax applied to the return.
taxcredit3money	string(5dp)	Stored as `decimal(19,5)`.
shipping_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
restock_feemoney	string(5dp)	Stored as `decimal(19,5)`.
total_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
voucherid	integer	Voucherid. Id only.
voucher	string(50)	The `voucher` of the referenced gltransactions, instead of the id. Send this or `voucherid`, not both unless they agree.
new_orderid	integer	New orderid. Id only.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydate	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/rmareturns' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "rma_arorderid": 104,
    "return_date": "2026-08-01",
    "taxid": 104,
    "taxcredit": "125.0000",
    "taxid2": 1,
    "taxcredit2": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/rmareturns');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'rma_arorderid' => 104,
    'return_date' => '2026-08-01',
    'taxid' => 104,
    'taxcredit' => '125.0000',
    'taxid2' => 1,
    'taxcredit2' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/rmareturns",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "rma_arorderid": 104,
        "return_date": "2026-08-01",
        "taxid": 104,
        "taxcredit": "125.0000",
        "taxid2": 1,
        "taxcredit2": "125.0000",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/rmareturns',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      rma_arorderid: 104,
      return_date: "2026-08-01",
      taxid: 104,
      taxcredit: "125.0000",
      taxid2: 1,
      taxcredit2: "125.0000",
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    rma_arorderid = 104,
    return_date = "2026-08-01",
    taxid = 104,
    taxcredit = "125.0000",
    taxid2 = 1,
    taxcredit2 = "125.0000",
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/rmareturns") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "rma_arorderid": 104,
    "return_date": "2026-08-01",
    "taxid": 104,
    "taxcredit": "125.0000",
    "taxid2": 1,
    "taxcredit2": "125.0000"
}

GET/rmareturns/{id} 200404

Retrieve one record.

Requires scope orders:read.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/rmareturns/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/rmareturns/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/rmareturns/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/rmareturns/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/rmareturns/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "rma_arorderid": 104,
    "return_date": "2026-08-01",
    "taxid": 104,
    "taxcredit": "125.0000",
    "taxid2": 1,
    "taxcredit2": "125.0000"
}

PATCH/rmareturns/{id} 200404

Update.

Requires scope orders:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
rma_arorderid	integer	Rma arorderid. Id only.
return_date	string	Date the goods were returned.
taxid	integer	Taxid. Id only.
taxcreditmoney	string(5dp)	Stored as `decimal(19,5)`.
taxid2	integer	Second sales tax applied to the return.
taxcredit2money	string(5dp)	Stored as `decimal(19,5)`.
taxid3	integer	Third sales tax applied to the return.
taxcredit3money	string(5dp)	Stored as `decimal(19,5)`.
shipping_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
restock_feemoney	string(5dp)	Stored as `decimal(19,5)`.
total_creditmoney	string(5dp)	Stored as `decimal(19,5)`.
invoiceid	integer	Invoiceid. Id only.
invoice	string(30)	The `invoicenumber` of the referenced invoices, instead of the id. Send this or `invoiceid`, not both unless they agree.
voucherid	integer	Voucherid. Id only.
voucher	string(50)	The `voucher` of the referenced gltransactions, instead of the id. Send this or `voucherid`, not both unless they agree.
new_orderid	integer	New orderid. Id only.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydate	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/rmareturns/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "rma_arorderid": 104,
    "return_date": "2026-08-01",
    "taxid": 104,
    "taxcredit": "125.0000",
    "taxid2": 1,
    "taxcredit2": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/rmareturns/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'rma_arorderid' => 104,
    'return_date' => '2026-08-01',
    'taxid' => 104,
    'taxcredit' => '125.0000',
    'taxid2' => 1,
    'taxcredit2' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/rmareturns/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "rma_arorderid": 104,
        "return_date": "2026-08-01",
        "taxid": 104,
        "taxcredit": "125.0000",
        "taxid2": 1,
        "taxcredit2": "125.0000",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/rmareturns/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      rma_arorderid: 104,
      return_date: "2026-08-01",
      taxid: 104,
      taxcredit: "125.0000",
      taxid2: 1,
      taxcredit2: "125.0000",
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    rma_arorderid = 104,
    return_date = "2026-08-01",
    taxid = 104,
    taxcredit = "125.0000",
    taxid2 = 1,
    taxcredit2 = "125.0000",
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/rmareturns/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "rma_arorderid": 104,
    "return_date": "2026-08-01",
    "taxid": 104,
    "taxcredit": "125.0000",
    "taxid2": 1,
    "taxcredit2": "125.0000"
}

DELETE/rmareturns/{id} 200404

Cancel.

Requires scope orders:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/rmareturns/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/rmareturns/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/rmareturns/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/rmareturns/104',
  {
    method: 'DELETE',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/rmareturns/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "rma_arorderid": 104,
    "return_date": "2026-08-01",
    "taxid": 104,
    "taxcredit": "125.0000",
    "taxid2": 1,
    "taxcredit2": "125.0000"
}

Service order time →

Hours logged against a service order (an order with ordertype service). Hours are not order lines: they become lines only when billed, at which point status becomes billed and the record is frozen.

Jobs →

Construction jobs. Costs and revenue can be tracked against one.