v1

latestOpenAPI 3.0.12026-07-144840447.2 KB
Transactions

Update a transaction

This endpoint returns the updated transaction.

ℹ️ This endpoint requires the following scope: transactions:all

put/api/external/firm/v1/companies/{company_id}/transactions/{id}

Path parameters

company_idinteger required
Example:1

Existing company identifier (id)

idinteger required

Request body

OR

Example request

{
  "customer_id": 42
}

Response

Returns the updated transaction

idinteger required

Transaction identifier

labelstring nullable required
attachment_requiredboolean required

When true, the transaction need to be justified and matched with an invoice

datestring date required
outstanding_balancestring nullable required

This is the balance of the transaction after it has been processed.

created_atstring date-time required
updated_atstring date-time required
archived_atstring date-time nullable required
currency_amountstring required

Amount in the currency of the transaction.

amountstring required

Transaction amount in euros. If the currency is euro, currency_amount and amount are identical.

currency_feestring nullable required

Fee in the currency of the transaction.

feestring nullable required

Transaction fee in euros. If the currency is euro, currency_fee and fee are identical.

Example response

{
  "id": 42,
  "label": "VIR SEPA MY SUPPLIER SAS",
  "attachment_required": true,
  "date": "2023-08-30",
  "outstanding_balance": "49.3",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z",
  "archived_at": "2023-08-30T10:08:08.146343Z",
  "currency_amount": "120.00",
  "amount": "120.00",
  "currency_fee": "120.00",
  "fee": "120.00",
  "journal": {
    "id": 234,
    "url": "https://app.pennylane.com/api/firm/v1/journals/67"
  },
  "bank_account": {
    "id": 53,
    "url": "https://app.pennylane.com/api/firm/v1/bank_accounts/53"
  },
  "pro_account_expense": {
    "employee": {
      "id": 42,
      "first_name": "John",
      "last_name": "Doe"
    },
    "card_masked_number": "123456XXXXXX7890"
  },
  "customer": {
    "id": 42,
    "url": "https://app.pennylane.com/api/firm/v1/customers/42"
  },
  "supplier": {
    "id": 42,
    "url": "https://app.pennylane.com/api/firm/v1/supplier/42"
  },
  "categories": [
    {
      "id": 421,
      "label": "HR - Salaries",
      "weight": "0.25",
      "category_group": {
        "id": 229
      },
      "analytical_code": "CODE123",
      "created_at": "2023-08-30T10:08:08.146343Z",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    }
  ]
}