Centros de Custo

Esta é uma API de cadastro de centros de custo.

Esta API é autenticada usando OAuth2, ver documentação de autenticação

Listagem de centros de custo

GET /api/v1/cdm/billing/groups

API para listagem de centros de custo

Exemplo requisição

GET /api/v1/cdm/billing/groups HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "cursor": {
    "previous": "",
    "current": "0",
    "next": "",
    "count": 1
  },
  "groups": [
    {
      "id": "Az2yHHgVNpCYaEoFMSvxu",
      "name": "CentroCusto01",
      "accountcode": null,
      "server_id": "AxUBbTFhJA6cPZH56YQMG"
    },
    {
      "id": "IrAyHHgVNpCYaEoFMSvxu",
      "name": "CentroCusto03",
      "accountcode": null,
      "server_id": "AxUBbTFhJA6cPZH56YQMG"
    },
  ]
}

Buscar um centro de custo

GET /api/v1/cdm/billing/groups/id

API para buscar um centro de custo

Exemplo requisição

GET /api/v1/cdm/billing/groups/Az2g33hnCce1mLEcPRhEF HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "Az2g33hnCce1mLEcPRhEF",
  "name": "CentroCusto03",
  "accountcode": null,
  "server_id": "AxUBbTFhJA6cPZH56YQMG"
}

Criar um centro de custo

POST /api/v1/cdm/billing/groups

API para criação de um centro de custo

Exemplo requisição

POST /api/v1/cdm/billing/groups HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "CentroCusto09",
  "server_id": "AxUBbTFhJA6cPZH56YQMG"
}

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "Az2g33hnCce1mLEcPRhEF",
  "name": "CentroCusto09",
  "accountcode": null,
  "server_id": "AxUBbTFhJA6cPZH56YQMG"
}

Atualizar um centro de custo

PUT /api/v1/cdm/billing/groups/id

API para atualização de um centro de custo

Exemplo requisição

PUT /api/v1/cdm/billing/groups/Az2g33hnCce1mLEcPRhEF HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "CentroCusto01"
}

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "Az2g33hnCce1mLEcPRhEF",
  "name": "CentroCusto01",
  "accountcode": null,
  "server_id": "AxUBbTFhJA6cPZH56YQMG"
}

Apagar um centro de custo

DELETE /api/v1/cdm/billing/groups/id

API para remoção de um centro de custo

Exemplo requisição

DELETE /api/v1/cdm/billing/groups/Az2g33hnCce1mLEcPRhEF HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

Formato dos dados

Parâmetros da url

idstring Identificador do centro de custo

Requisição

namestringrequerido único Nome do centro de custo
server_idstringrequerido ID do servidor que será utilizado pelo centro de custo

Resposta

idstring Identificador do centro de custo
namestring Nome do centro de custo
server_idstring ID do servidor utilizado pelo centro de custo
accountcodeint ID do centro de custo no servidor utilizado