Accounts API

create new entry

POST /api/rest/admin/accounts

Parameters

Name	Description
data[type]	Resource type (accounts)
data[attributes][name]	Name
data[attributes][min-balance]	Min balance
data[attributes][max-balance]	Max balance
data[attributes][vat]	Vat
data[attributes][origination-capacity]	Origination capacity
data[attributes][termination-capacity]	Termination capacity
data[attributes][total-capacity]	Total capacity
data[attributes][send-invoices-to]	Send invoices to
data[attributes][external-id]	External id
data[attributes][balance-low-threshold]	Balance low threshold
data[attributes][balance-high-threshold]	Balance high threshold
data[attributes][send-balance-notifications-to]	Send balance notifications to
data[attributes][invoice-period-id]	Invoice period id
data[attributes][timezone]	Timezone
data[attributes][invoice-period-id]	Invoice period id
data[relationships][contractor]	Contractor
data[relationships][invoice-template]	Invoice template

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5LCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzcyMjExOTk4fQ.qIXT1jr2K9RlEqxzeyLafr0ooJeRX1_zdk_xw8tqio8
Host: example.org
Cookie: 

Route

POST /api/rest/admin/accounts

Body

{"data":{"type":"accounts","attributes":{"name":"name","min-balance":1,"max-balance":10,"vat":11,"origination-capacity":100,"termination-capacity":110,"total-capacity":100,"balance-low-threshold":90,"balance-high-threshold":95,"send-balance-notifications-to":[1],"invoice-period-id":2,"timezone":"Europe/Kyiv"},"relationships":{"contractor":{"data":{"type":"contractors","id":4}}}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/admin/accounts/23
vary: Accept
etag: W/"c8f0b92edc1ba3a33aa870cdd0b28de7"
cache-control: max-age=0, private, must-revalidate
x-request-id: dc14f65a-e863-4f32-9976-c873b929895f
x-runtime: 0.020225
content-length: 1002

Status

201 Created

Body

{
  "data": {
    "id": "23",
    "type": "accounts",
    "links": {
      "self": "http://example.org/api/rest/admin/accounts/23"
    },
    "attributes": {
      "name": "name",
      "balance": "0.0",
      "min-balance": "1.0",
      "max-balance": "10.0",
      "vat": "11.0",
      "balance-low-threshold": "90.0",
      "balance-high-threshold": "95.0",
      "send-balance-notifications-to": [
        1
      ],
      "destination-rate-limit": null,
      "max-call-duration": null,
      "external-id": null,
      "uuid": "4869d3f8-13fd-11f1-94d1-cacc5eb17c13",
      "origination-capacity": 100,
      "termination-capacity": 110,
      "total-capacity": 100,
      "send-invoices-to": null,
      "invoice-period-id": 2,
      "timezone": "Europe/Kyiv"
    },
    "relationships": {
      "contractor": {
        "links": {
          "self": "http://example.org/api/rest/admin/accounts/23/relationships/contractor",
          "related": "http://example.org/api/rest/admin/accounts/23/contractor"
        },
        "data": {
          "type": "contractors",
          "id": "4"
        }
      },
      "invoice-template": {
        "links": {
          "self": "http://example.org/api/rest/admin/accounts/23/relationships/invoice-template",
          "related": "http://example.org/api/rest/admin/accounts/23/invoice-template"
        },
        "data": null
      }
    }
  }
}