Create card transaction line

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

Request body

application/json;charset=UTF-8

• accountId string · uuid

  ID of the ledger account to book this line against.

• taxCodeId string · uuid

  ID of the tax code to apply to this line. The line's tax is calculated from it.

• costCenterId string · uuid

  ID of the cost center.

• amount integer · int64

  Gross line amount in minor units (e.g. cents), including tax. Positive; the line takes the card transaction's direction.

• description string

  Description of this line.

• customProperties array of object

  Custom properties to set on this line.

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

    Note

    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.

    Note

    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.

• amortizationTemplateId string · uuid

  ID of the amortization template to apply to this line.

• amortizationStartDate string · date

  Start date for amortization of this line.

• amortizationEndDate string · date

  End date for amortization of this line.

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