Light APIv1.0.0

API / Reference / Card Transactions

Update card transaction line

PATCH https://api.light.inc/v1/card-transactions/{transactionId}/lines/{transactionLineId}

Updates a specific card transaction line item

Rejected with CARD_TRANSACTION_NOT_EDITABLE once the transaction is POSTED, DECLINED or VOIDED. While it is still AUTHORIZED, every field except amount may change; sending a different amount fails with CARD_TRANSACTION_AMOUNT_NOT_EDITABLE until the capture arrives. amount is the gross line amount in minor units of the balance account's currency, unsigned. All fields follow the omit-to-keep, null-to-clear rule. There is no endpoint to add or remove lines.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Path parameters

  • transactionId string · uuidrequired

  • transactionLineId string · uuidrequired

Request body

application/json;charset=UTF-8

  • customProperties array of object

    • groupId string · uuid

      ID of the custom property group.

    • valueIds array of string · uuid

      IDs of the selected custom property values. It behaves as a PUT operation, so if empty the existing ones will be effectively deleted.

      Catalogue value ids for this group. Required; send [] (with an empty inlineValues) to clear the group. SINGLE_SELECT and MULTI_SELECT groups accept nothing else. See Custom properties on writes.

    • inlineValues array of string

      Inline custom property values (used for TEXT/NUMERIC/DATE/etc. groups). It behaves as a PUT operation, so if empty or null the existing ones will be effectively deleted.

      Literal values for TEXT, NUMERIC, BOOLEAN and DATE groups, as strings (yyyy-MM-dd for dates). Rejected on select groups with CUSTOM_PROPERTY_VALUE_TYPE_MISMATCH. See Custom properties on writes.

  • accountId string · uuid

  • taxCodeId string · uuid

  • costCenterId string · uuid

  • amount integer · int64

  • description string

  • amortizationTemplateId string · uuid

  • amortizationStartDate string · date

  • amortizationEndDate string · date

Response

  • id string · uuid

  • transactionId string · uuid

  • companyId string · uuid

  • accountId string · uuid

  • taxCodeId string · uuid

  • costCenterId string · uuid

  • amount integer · int64

  • netAmount integer · int64

  • taxAmount integer · int64

  • description string

  • createdAt string · date-time

  • updatedAt string · date-time

  • customProperties array of object

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • values array of object

      List of values. Note that this will be a single value unless the group input type supports multiple values

      • id string · uuid

        Unique identifier for the object

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • companyId string · uuid

        ID of the company

      • internalName string

        Internal name of the custom property value

      • label string

        Label of the custom property value

      • context string

        Context/description of the custom property value

      • createdAt string · date-time

        Timestamp when the custom property value was created

      • updatedAt string · date-time

        Timestamp when the custom property value was last updated

  • amortizationTemplateId string · uuid

  • amortizationStartDate string · date

  • amortizationEndDate string · date