A code list to map

GET

/api/integration/v1/reference/{kind}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.slflo.com/api/integration/v1/reference/payment-methods"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.slflo.com/api/integration/v1/reference/payment-methods"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'https://api.slflo.com/api/integration/v1/reference/payment-methods';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.slflo.com/api/integration/v1/reference/payment-methods \
  --header 'Authorization: Bearer <token>'

Kind is payment-methods, return-reasons, order-statuses, return-statuses, cheque-statuses, tax-codes, currencies, units, warehouses or price-lists. Needs no scope.

Authorizations

bearer

Parameters

Path Parameters

kind

required

string

Which list: payment-methods, return-reasons, order-statuses, return-statuses, cheque-statuses, tax-codes, currencies, units, warehouses or price-lists.

Example

payment-methods

Responses

200

A code list to map

application/json

object

data

required

Array<object>

object

attributes

required

object

key

additional properties

string

code

required

string

external_ref

string

name

required

object

key

additional properties

string

meta

required

object

count

required

integer format: int32

kind

required

string

Example

{
  "data": [
    {
      "attributes": {
        "needs_reference": "false"
      },
      "code": "CASH",
      "external_ref": null,
      "id": null,
      "name": {
        "en": "Cash"
      }
    },
    {
      "attributes": {
        "needs_reference": "true"
      },
      "code": "CHEQUE",
      "external_ref": null,
      "id": null,
      "name": {
        "en": "Cheque"
      }
    }
  ],
  "meta": {
    "count": 2,
    "kind": "payment-methods"
  }
}

default

An error: the code says what, retryable whether to try again.

application/json

object

error

required

object

code

required

Stable code, e.g. SCOPE_MISSING, UNKNOWN_REFERENCE.

string

details

required

Field-level problems: {field, code}.

Array<object>

object

key

additional properties

string

message

required

What happened and how to fix it.

string

request_id

required

Quote it to support; it finds the server log.

string

retryable

required

Whether the same call may succeed later.

boolean

Example

{
  "error": {
    "code": "SCOPE_MISSING",
    "details": [],
    "message": "This client does not hold the invoices:read scope.",
    "request_id": "req_01J9X4Q7T2M8P3NRT6V5WZ",
    "retryable": false
  }
}