Lançamentos com analítica

As rotas aqui descritas permitem gerir a distribuição por centros de custos das linhas de lançamentos em exercícios com contabilidade analítica.

Para haver linhas de distribuição por centro de custos de uma linha de lançamento, é necessário que essa linha de lançamento esteja configurada com uma rubrica. Esta configuração aparece em duplicado no recurso "accounting_transaction_lines", podendo ser configurada ou consultada através do atributo "cost_dimension_id" ou da relação "cost_dimension". A distribuição do montante, a débito ou a crédito, de uma linha de lançamento associada a uma rubrica, é efetuada usando a rota /transaction_line_costs.

Consulta de linhas de centro de custos

A consulta de várias linhas, usando ou não filtros, pode ser efetuada com um pedido:

get

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /transaction_line_costs HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "data": []
}

Sendo a consulta de uma linha de custos específica efetuada de forma individual usando o identificador interno da linha de custos associada a uma linha de lançamento:

get

Path parameters

idintegerRequired

Identificador da linha de custos numa linha de lançamento

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /transaction_line_costs/{id} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "data": {
    "type": "transaction_line_costs",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 0,
      "cost_center_id": 11001,
      "percentage": 2,
      "amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cost_center": {
        "data": {
          "type": "ep_cost_centers",
          "id": "1"
        }
      }
    }
  }
}

Criação de linhas de custos

post

Body

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /transaction_line_costs HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "data": {
    "type": "transaction_line_costs",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 0,
      "cost_center_id": 11001,
      "percentage": 2,
      "amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cost_center": {
        "data": {
          "type": "ep_cost_centers",
          "id": "1"
        }
      }
    }
  }
}

200

OK

{
  "data": {
    "type": "transaction_line_costs",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 0,
      "cost_center_id": 11001,
      "percentage": 2,
      "amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cost_center": {
        "data": {
          "type": "ep_cost_centers",
          "id": "1"
        }
      }
    }
  }
}

Alteração de linhas de custos

patch

Path parameters

idintegerRequired

Identificador da linha de custos numa linha de lançamento a atualizar

Body

Responses

200

OK

application/json

patch

HTTPcURLJavaScriptPython

PATCH /transaction_line_costs/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "data": {
    "type": "transaction_line_costs",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 0,
      "cost_center_id": 11001,
      "percentage": 2,
      "amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cost_center": {
        "data": {
          "type": "ep_cost_centers",
          "id": "1"
        }
      }
    }
  }
}

200

OK

{
  "data": {
    "type": "transaction_line_costs",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 0,
      "cost_center_id": 11001,
      "percentage": 2,
      "amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cost_center": {
        "data": {
          "type": "ep_cost_centers",
          "id": "1"
        }
      }
    }
  }
}

Eliminação de linhas de custos

delete

Path parameters

idstringRequired

Identificador da linha de custos numa linha de lançamento a eliminar

Responses

200

OK

delete

HTTPcURLJavaScriptPython

DELETE /transaction_line_costs/{id} HTTP/1.1
Host: 
Accept: */*

200

OK

No content