Contabilização

As rotas aqui descritas permitem gerir os lançamentos no módulo de contabilidade. Nota: para se poder usar rotas de contabilidade é necessário que esteja seleccionado um exercício fiscal como descrito no passo 2.2 da autenticação.

1. Consulta de lançamentos

A consulta de lançamentos, pode ser efetuada usando os parâmetros de filtragem e paginação da v0, que devolve uma coleção de lançamentos. Por omissão são devolvidas todas as relações incluindo não só as linhas de cada lançamento, mas também as outras relações, podendo-se definir qual a informação a incluir nos parâmetros.

get

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /accounting_transactions HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

Sendo a consulta de um lançamento específico efetuada de forma individual usando o identificador interno do lançamento:

get

Path parameters

idintegerRequired

Identificador do lançamento a obter

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /accounting_transactions/{id} HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": {
    "type": "accounting_transactions",
    "id": "1",
    "attributes": {
      "status": "draft",
      "transaction_date": "2024-01-01",
      "document_date": "2023-12-10",
      "description": "Lançamento novo via API",
      "external_reference": "D20236712",
      "currency_conversion_rate": 1.21,
      "third_party_control_id": "CLIENTE",
      "third_party_entity_id": 20,
      "created_at": "2024-01-01 10:20:30.123456",
      "finalized_at": null,
      "journal_entry": null,
      "document_no": null,
      "accounting_document_series_no": 1,
      "debit_total_fiscal_currency": 0,
      "credit_total_fiscal_currency": 0,
      "debit_total_document_currency": 0,
      "credit_total_document_currency": 0,
      "accountable_id": null,
      "accountable_document_type": null,
      "accountable_document_no": null
    },
    "relationships": {
      "accounting_document_series": {
        "data": null
      },
      "accounting_document_type": {
        "data": {
          "type": "accounting_document_types",
          "id": "DP"
        }
      },
      "currency": {
        "data": {
          "type": "currency",
          "id": "1"
        }
      },
      "journal": {
        "data": {
          "type": "journals",
          "id": "BNC"
        }
      },
      "lines": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ]
      },
      "user": {
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    }
  }
}

Também é possível consultar apenas linhas de lançamento, usando os critérios de filtragem e paginação referidos:

get

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /accounting_transaction_lines HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

Sendo também possível efetuar a consulta de uma linha de lançamento específica efetuada de forma individual usando o identificador interno da linha do lançamento:

get

Path parameters

idintegerRequired

Identificador do lançamento a obter

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /accounting_transaction_lines/{id} HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": {
    "type": "accounting_transaction_lines",
    "id": "1",
    "attributes": {
      "seqno": 1,
      "transaction_id": 1,
      "account_id": 11001,
      "description": "Linha de lançamento nova via API",
      "debit_amount": 10.5,
      "credit_amount": 20,
      "debit_expression": "9+1.5",
      "credit_expression": "10*2",
      "cost_dimension_id": 1
    },
    "relationships": {
      "account": {
        "data": {
          "type": "general_ledger",
          "id": "1"
        }
      },
      "transaction": {
        "data": {
          "type": "accounting_transactions",
          "id": "1"
        }
      },
      "vat_code": {
        "data": {
          "type": "vat_codes",
          "id": "1"
        }
      },
      "cost_dimension": {
        "data": {
          "type": "cost_dimensions",
          "id": "1"
        }
      },
      "transaction_line_cash_flows": [],
      "transaction_line_costs": []
    }
  }
}

2. Relação com outros recursos / rotas

2.1. Controlo de terceiros

Quando existe controlo de terceiros, ou seja, o "third_party_control_id" tem o valor "CLIENTE" ou "FORNECEDOR", o campo "third_party_entity_id" é o identificador interno de clientes ou fornecedores, que pode ser obtido através do NIF usando um dos pedidos seguintes:

GET /customers?filter[tax_registration_number]=999999990|<NIF do cliente>

ou

GET /suppliers?filter[tax_registration_number]=999999990|<NIF do fornecedor>

2.2. Moeda do lançamento

Por omissão, a moeda do lançamento, "currency", é o mesmo tipo de moeda usado no exercício fiscal, ou seja euros (EUR). No entanto, é possível definir que o lançamento é noutra moeda, usando o identificador interno de moeda no campo "currency", que pode ser obtido através do código ISO num pedido:

GET /currencies?filter[iso_code]=USD|<código ISO da moeda>

Quando se define uma moeda de lançamento distinta da do exercício deve ser definida a taxa de câmbio,"currency_conversion_rate", para converter os valores das linhas do lançamento em euros.

2.3. Rubricas

Nos exercícios fiscais que suportam rubricas, estas devem ser configuradas nas linhas do lançamento usando o seu identificador interno. A consulta dos identificadores internos das rubricas deve ser efectuada da seguinte forma:

get

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /cost_dimensions HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

2.4. Centros de custos

A consulta dos identificadores internos dos centros de custo deve ser efectuada da seguinte forma:

get

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /cost_centers HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

2.5. Fluxos de caixa

get

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /cash_flows HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

A consulta dos identificadores internos dos fluxos de caixa deve ser efectuada da seguinte forma:

3. Criação de lançamentos

Os lançamentos, semelhantes aos documentos comerciais, são constituídos por:

1. Um cabeçalho

2. Duas ou mais linhas

3.1. Criação do lançamento (cabeçalho)

De modo a criar um lançamento, deverá ser efetuado um pedido com informação do cabeçalho do mesmo. No momento de criação do lançamento é automaticamente adicionada uma linha, que se não for utilizada e estiver vazia quando o lançamento for finalizado, será automaticamente removida durante a finalização do lançamento. Para este efeito, deverá realizar o seguinte pedido:

curl -v -X POST \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <access_token>' \
-d '<payload JSON>' '<API_URL>/accounting_transaction'

No pedido acima, o <access_token> corresponde ao token de acesso válido devolvido pelo serviço de OAuth. O pedido de criação do lançamento deve ser feito de acordo com a seguinte especificação:

post

Body

dataobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /accounting_transactions HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 503

{
  "data": {
    "type": "accounting_transactions",
    "attributes": {
      "status": "draft",
      "transaction_date": "2024-01-01",
      "document_date": "2023-12-10",
      "description": "Lançamento novo via API",
      "external_reference": "D20236712",
      "currency_conversion_rate": 1.21,
      "third_party_control_id": "CLIENTE",
      "third_party_entity_id": 20
    },
    "relationships": {
      "accounting_document_type": {
        "data": {
          "type": "accounting_document_types",
          "id": "DP"
        }
      },
      "currency": {
        "data": {
          "type": "text",
          "id": "text"
        }
      },
      "journal": {
        "data": {
          "type": "journals",
          "id": "BNC"
        }
      }
    }
  }
}

200

OK

{
  "data": {
    "type": "accounting_transactions",
    "id": "1",
    "attributes": {
      "status": "draft",
      "transaction_date": "2024-01-01",
      "document_date": "2023-12-10",
      "description": "Lançamento novo via API",
      "external_reference": "D20236712",
      "currency_conversion_rate": 1.21,
      "third_party_control_id": "CLIENTE",
      "third_party_entity_id": 20,
      "created_at": "2024-01-01 10:20:30.123456",
      "finalized_at": null,
      "journal_entry": null,
      "document_no": null,
      "accounting_document_series_no": 1,
      "debit_total_fiscal_currency": 0,
      "credit_total_fiscal_currency": 0,
      "debit_total_document_currency": 0,
      "credit_total_document_currency": 0,
      "accountable_id": null,
      "accountable_document_type": null,
      "accountable_document_no": null
    },
    "relationships": {
      "accounting_document_series": {
        "data": null
      },
      "accounting_document_type": {
        "data": {
          "type": "accounting_document_types",
          "id": "DP"
        }
      },
      "currency": {
        "data": {
          "type": "currency",
          "id": "1"
        }
      },
      "journal": {
        "data": {
          "type": "journals",
          "id": "BNC"
        }
      },
      "lines": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ]
      },
      "user": {
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    }
  }
}

3.2. Criação de linha de lançamento

De modo a adicionar uma linha a um lançamento, deverá realizar o seguinte pedido:

curl -v -X POST \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <access_token>' \
-d '<payload JSON>' '<API_URL>/accounting_transaction_lines'

No pedido acima, o <access_token> corresponde ao token de acesso válido devolvido pelo serviço de OAuth. O pedido de criação de uma linha de lançamento deve ser feito de acordo com a seguinte especificação:

post

Body

dataobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /accounting_transaction_lines HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 588

{
  "data": {
    "type": "accounting_transaction_lines",
    "attributes": {
      "seqno": 1,
      "transaction_id": 1,
      "account_id": 11001,
      "description": "Linha de lançamento nova via API",
      "debit_amount": 10.5,
      "credit_amount": 20,
      "debit_expression": "9+1.5",
      "credit_expression": "10*2",
      "cost_dimension_id": 1
    },
    "relationships": {
      "account": {
        "data": {
          "type": "general_ledger",
          "id": "1"
        }
      },
      "transaction": {
        "data": {
          "type": "accounting_transactions",
          "id": "1"
        }
      },
      "vat_code": {
        "data": {
          "type": "vat_codes",
          "id": "1"
        }
      },
      "cost_dimension": {
        "data": {
          "type": "cost_dimensions",
          "id": "1"
        }
      },
      "transaction_line_cash_flows": [],
      "transaction_line_costs": []
    }
  }
}

200

OK

{
  "data": {
    "type": "accounting_transaction_lines",
    "id": "1",
    "attributes": {
      "seqno": 1,
      "transaction_id": 1,
      "account_id": 11001,
      "description": "Linha de lançamento nova via API",
      "debit_amount": 10.5,
      "credit_amount": 20,
      "debit_expression": "9+1.5",
      "credit_expression": "10*2",
      "cost_dimension_id": 1
    },
    "relationships": {
      "account": {
        "data": {
          "type": "general_ledger",
          "id": "1"
        }
      },
      "transaction": {
        "data": {
          "type": "accounting_transactions",
          "id": "1"
        }
      },
      "vat_code": {
        "data": {
          "type": "vat_codes",
          "id": "1"
        }
      },
      "cost_dimension": {
        "data": {
          "type": "cost_dimensions",
          "id": "1"
        }
      },
      "transaction_line_cash_flows": [],
      "transaction_line_costs": []
    }
  }
}

3.3. Criação de sugestão para documento comercial

Os documentos comerciais podem ter lançamentos de contabilidade associados através da funcionalidade de sugestão de lançamentos, disponível na rota /set_suggestions_for_document_on_fiscal_year. Para gerar uma sugestão de lançamento de um documento finalizado deve ser passada o parâmetro operation=create e para lançamentos anulados o parâmetro operation=destroy.

get

Query parameters

filter[document_id]stringRequired

Identificador do documento comercial

Example: 1

filter[document_type]stringRequired

Tipo de documento comercial

Example: FT

filter[document_no]stringRequired

Número do documento comercial

Example: FT 2024/1

filter[operation]string · enumRequired

Tipo de operação a realizar, create para criar a sugestão, e destroy para anular a sugestão existente.

Available options:

filter[finalize]booleanRequired

Tentar finalizar a sugestão gerada

Example: true

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /set_suggestions_for_document_on_fiscal_year?filter[document_id]=1&filter[document_type]=FT&filter[document_no]=FT+2024%2F1&filter[operation]=create&filter[finalize]=true HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

3.4. Duplicação de lançamento

Qualquer lançamento pode ser duplicado fazendo um pedido à rota /duplicate_transaction , que tem a seguinte especificação:

get

Query parameters

filter[transaction_id]stringRequired

Identificador do lançamento a duplicar

Example: 1

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /duplicate_transaction?filter[transaction_id]=1 HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

3.5. Criação de estorno

Se for necessário criar um estorno para um lançamento finalizado, é possível utilizar a API fazendo um pedido à rota /reverse_transaction que executa essa ação, tendo o pedido a seguinte especificação:

get

Query parameters

filter[transaction_id]stringRequired

Identificador do lançamento a estornar

Example: 1

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /reverse_transaction?filter[transaction_id]=1 HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

4. Alteração de lançamentos

4.1. Alteração do cabeçalho de um lançamento

Um determinado lançamento pode ser alterado da seguinte forma:

patch

Path parameters

idintegerRequired

Identificador do lançamento a actualizar

Body

dataobjectRequired

Responses

application/json

objectOptional

patch

HTTPcURLJavaScriptPython

PATCH /accounting_transactions/{id} HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 503

{
  "data": {
    "type": "accounting_transactions",
    "attributes": {
      "status": "draft",
      "transaction_date": "2024-01-01",
      "document_date": "2023-12-10",
      "description": "Lançamento novo via API",
      "external_reference": "D20236712",
      "currency_conversion_rate": 1.21,
      "third_party_control_id": "CLIENTE",
      "third_party_entity_id": 20
    },
    "relationships": {
      "accounting_document_type": {
        "data": {
          "type": "accounting_document_types",
          "id": "DP"
        }
      },
      "currency": {
        "data": {
          "type": "text",
          "id": "text"
        }
      },
      "journal": {
        "data": {
          "type": "journals",
          "id": "BNC"
        }
      }
    }
  }
}

200

OK

{
  "data": {
    "type": "accounting_transactions",
    "id": "1",
    "attributes": {
      "status": "draft",
      "transaction_date": "2024-01-01",
      "document_date": "2023-12-10",
      "description": "Lançamento novo via API",
      "external_reference": "D20236712",
      "currency_conversion_rate": 1.21,
      "third_party_control_id": "CLIENTE",
      "third_party_entity_id": 20,
      "created_at": "2024-01-01 10:20:30.123456",
      "finalized_at": null,
      "journal_entry": null,
      "document_no": null,
      "accounting_document_series_no": 1,
      "debit_total_fiscal_currency": 0,
      "credit_total_fiscal_currency": 0,
      "debit_total_document_currency": 0,
      "credit_total_document_currency": 0,
      "accountable_id": null,
      "accountable_document_type": null,
      "accountable_document_no": null
    },
    "relationships": {
      "accounting_document_series": {
        "data": null
      },
      "accounting_document_type": {
        "data": {
          "type": "accounting_document_types",
          "id": "DP"
        }
      },
      "currency": {
        "data": {
          "type": "currency",
          "id": "1"
        }
      },
      "journal": {
        "data": {
          "type": "journals",
          "id": "BNC"
        }
      },
      "lines": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ]
      },
      "user": {
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    }
  }
}

4.2. Alteração de uma linha de lançamento

Uma linha de lançamento pode ser alterada da seguinte forma:

patch

Path parameters

idintegerRequired

Identificador do lançamento a atualizar

Body

dataobjectRequired

Responses

application/json

objectOptional

patch

HTTPcURLJavaScriptPython

PATCH /accounting_transaction_lines/{id} HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 597

{
  "data": {
    "type": "accounting_transaction_lines",
    "id": "1",
    "attributes": {
      "seqno": 1,
      "transaction_id": 1,
      "account_id": 11001,
      "description": "Linha de lançamento nova via API",
      "debit_amount": 10.5,
      "credit_amount": 20,
      "debit_expression": "9+1.5",
      "credit_expression": "10*2",
      "cost_dimension_id": 1
    },
    "relationships": {
      "account": {
        "data": {
          "type": "general_ledger",
          "id": "1"
        }
      },
      "transaction": {
        "data": {
          "type": "accounting_transactions",
          "id": "1"
        }
      },
      "vat_code": {
        "data": {
          "type": "vat_codes",
          "id": "1"
        }
      },
      "cost_dimension": {
        "data": {
          "type": "cost_dimensions",
          "id": "1"
        }
      },
      "transaction_line_cash_flows": [],
      "transaction_line_costs": []
    }
  }
}

200

OK

{
  "data": {
    "type": "accounting_transaction_lines",
    "id": "1",
    "attributes": {
      "seqno": 1,
      "transaction_id": 1,
      "account_id": 11001,
      "description": "Linha de lançamento nova via API",
      "debit_amount": 10.5,
      "credit_amount": 20,
      "debit_expression": "9+1.5",
      "credit_expression": "10*2",
      "cost_dimension_id": 1
    },
    "relationships": {
      "account": {
        "data": {
          "type": "general_ledger",
          "id": "1"
        }
      },
      "transaction": {
        "data": {
          "type": "accounting_transactions",
          "id": "1"
        }
      },
      "vat_code": {
        "data": {
          "type": "vat_codes",
          "id": "1"
        }
      },
      "cost_dimension": {
        "data": {
          "type": "cost_dimensions",
          "id": "1"
        }
      },
      "transaction_line_cash_flows": [],
      "transaction_line_costs": []
    }
  }
}

4.3. Eliminar linha de lançamento

Uma linha de lançamento pode ser eliminada da seguinte forma:

delete

Path parameters

idstringRequired

Identificador do lançamento a eliminar

Responses

delete

HTTPcURLJavaScriptPython

DELETE /accounting_transaction_lines/{id} HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

No content

4.4. Finalizar ou reabrir lançamento

Para finalizar ou reabrir um lançamento, deverá ser efetuado um pedido de alteração, sendo indicado o "status" de deleted ou draft, respectivamente.

5. Eliminação de lançamentos

Um lançamento só pode ser realmente eliminado se nunca tiver sido finalizado, ou seja, se ainda não tiver sido atribuída a entrada no diário, nem um número de documento: Se for necessário eliminar um lançamento que já estiver numerado poderá ser alterado com estado de eliminado, ou ser criado um estorno.

delete

Path parameters

idstringRequired

Identificador do lançamento a eliminar

Responses

delete

HTTPcURLJavaScriptPython

DELETE /accounting_transactions/{id} HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

No content

6. 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.

6.1. 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

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /transaction_line_costs HTTP/1.1
Host: <API_URL>
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

application/json

objectOptional

get

HTTPcURLJavaScriptPython

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

200

OK

{
  "data": {
    "type": "transaction_line_costs",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "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"
        }
      }
    }
  }
}

6.2. Criação de linhas de custos

post

Body

dataobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

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

{
  "data": {
    "type": "transaction_line_costs",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "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": 1,
      "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"
        }
      }
    }
  }
}

6.3. Alteração de linhas de custos

patch

Path parameters

idintegerRequired

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

Body

dataobjectRequired

Responses

application/json

objectOptional

patch

HTTPcURLJavaScriptPython

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

{
  "data": {
    "type": "transaction_line_costs",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "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": 1,
      "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"
        }
      }
    }
  }
}

6.4. Eliminação de linhas de custos

delete

Path parameters

idstringRequired

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

Responses

delete

HTTPcURLJavaScriptPython

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

200

OK

No content

7. Lançamentos com fluxos de caixa

As rotas aqui descritas permitem gerir a distribuição por fluxos nos lançamentos em exercícios que usam fluxos de caixa.

7.1. Consulta de linhas de fluxos de caixa

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

get

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /transaction_line_cash_flows HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": []
}

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

get

Path parameters

idintegerRequired

Identificador da linha de custos numa linha de lançamento

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /transaction_line_cash_flows/{id} HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

{
  "data": {
    "type": "transaction_line_cash_flows",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "cash_flow_id": 11001,
      "debit_amount": 10.5,
      "credit_amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cash_flow": {
        "data": {
          "type": "cash_flows",
          "id": "1"
        }
      }
    }
  }
}

7.2. Criação de linhas de fluxos de caixa

post

Body

dataobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /transaction_line_cash_flows HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "data": {
    "type": "transaction_line_cash_flows",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "cash_flow_id": 11001,
      "debit_amount": 10.5,
      "credit_amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cash_flow": {
        "data": {
          "type": "cash_flows",
          "id": "1"
        }
      }
    }
  }
}

200

OK

{
  "data": {
    "type": "transaction_line_cash_flows",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "cash_flow_id": 11001,
      "debit_amount": 10.5,
      "credit_amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cash_flow": {
        "data": {
          "type": "cash_flows",
          "id": "1"
        }
      }
    }
  }
}

7.3. Alteração de linhas de fluxos de caixa

patch

Path parameters

idintegerRequired

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

Body

dataobjectRequired

Responses

application/json

objectOptional

patch

HTTPcURLJavaScriptPython

PATCH /transaction_line_cash_flows/{id} HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "data": {
    "type": "transaction_line_cash_flows",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "cash_flow_id": 11001,
      "debit_amount": 10.5,
      "credit_amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cash_flow": {
        "data": {
          "type": "cash_flows",
          "id": "1"
        }
      }
    }
  }
}

200

OK

{
  "data": {
    "type": "transaction_line_cash_flows",
    "id": "1",
    "attributes": {
      "transaction_line_id": 1,
      "seqno": 1,
      "cash_flow_id": 11001,
      "debit_amount": 10.5,
      "credit_amount": 20
    },
    "relationships": {
      "transaction_line": {
        "data": {
          "type": "accounting_transaction_lines",
          "id": "100"
        }
      },
      "cash_flow": {
        "data": {
          "type": "cash_flows",
          "id": "1"
        }
      }
    }
  }
}

7.4. Eliminação de linhas de fluxos de caixa

delete

Path parameters

idstringRequired

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

Responses

delete

HTTPcURLJavaScriptPython

DELETE /transaction_line_cash_flows/{id} HTTP/1.1
Host: <API_URL>
Accept: */*

200

OK

No content

8. Pedidos com várias operações

Relembramos que é possível utilizar a extensão JSON Patch para realizar num só pedido várias operações sobre lançamentos, de acordo com a nossa implementação da API v0.

Operações sobre linhas de lançamentos

patch

Body

opstringRequired

Tipo de operação suportada na extensão JSON Patch: add|replace|delete

Example: add

pathanyRequired

Endereço a adicionar ao caminho do recurso, sendo vazio: '/-'

Example: /-

valueobjectRequired

Responses

application/json

object[]Optional

patch

HTTPcURLJavaScriptPython

PATCH /accounting_transaction_lines HTTP/1.1
Host: <API_URL>
Content-Type: application/json
Accept: */*
Content-Length: 626

[
  {
    "op": "add",
    "path": "/-",
    "value": {
      "type": "accounting_transaction_lines",
      "id": "1",
      "attributes": {
        "seqno": 0,
        "transaction_id": 1,
        "account_id": 11001,
        "description": "Linha de lançamento nova via API",
        "debit_amount": 10.5,
        "credit_amount": 20,
        "debit_expression": "9+1.5",
        "credit_expression": "10*2",
        "cost_dimension_id": 1
      },
      "relationships": {
        "account": {
          "data": {
            "type": "general_ledger",
            "id": "1"
          }
        },
        "transaction": {
          "data": {
            "type": "accounting_transactions",
            "id": "1"
          }
        },
        "vat_code": {
          "data": {
            "type": "vat_codes",
            "id": "1"
          }
        },
        "cost_dimension": {
          "data": {
            "type": "cost_dimensions",
            "id": "0101"
          }
        },
        "transaction_line_cash_flows": [],
        "transaction_line_costs": []
      }
    }
  }
]

200

OK

[
  {
    "data": []
  }
]

Exemplo: adicionar 2 linhas no mesmo lançamento:

[
    {
        "op": "add",
        "path": "/-",
        "value": {
            "type": "accounting_transaction_lines",
            "attributes": {
                "transaction_id": 1,
                "seqno": 0,
                "account_id": "11001",
                "debit_amount": 10
            }
        }
    },
    {
        "op": "add",
        "path": "/-",
        "value": {
            "type": "accounting_transaction_lines",
            "attributes": {
                "transaction_id": 1,
                "seqno": 1,
                "account_id": "12001",
                "credit_amount": 10
            }
        }
    }
]

Operações sobre recursos distintos

Para efetuar pedidos sobre recursos distintos, deve-se fazer o pedido PATCH sobre o <API_URL>/ e especificar o path em cada operação.

Exemplo: adicionar linhas e finalizar lançamento

[
    {
        "op": "replace",
        "path": "/accounting_transaction_lines/23/account_id",
        "value": "11001"
    },
    {
        "op": "replace",
        "path": "/accounting_transaction_lines/23/debit_amount",
        "value": "10"
    },
    {
        "op": "add",
        "path": "/accounting_transaction_lines",
        "value": {
            "type": "accounting_transaction_lines",
            "attributes": {
                "transaction_id": 4,
                "account_id": "12001",
                "credit_amount": 10
            }
        }
    },
    {
        "op": "replace",
        "path": "/accounting_transactions/4/status",
        "value": "finalized"
    }
]