Transaction Labels

Get a transaction's labels

get

This method returns the transaction's labels.

Authorizations
X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters
transaction_idintegerRequired

The transaction's ID

Responses
chevron-right
200

Transaction object

application/json
get
/transactions/{transaction_id}/labels

Add a Label to the Transaction matching the ID

post

This post endpoint set the Label matching the ID passed in the payload to the Transaction matching the ID passed in the url

Authorizations
X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters
transaction_idintegerRequired

The transaction's ID

Body
label_idintegerRequired

ID of the label to add to the resource

Example: 42
Responses
chevron-right
200

Whether or not the Label has been successfully attached

application/json
post
/transactions/{transaction_id}/labels

Remove a Label to the Transaction matching the ID

delete

This post endpoint remove the Label from the transaction matching the IDs passed in url

Authorizations
X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters
label_idintegerRequired

The label's ID

transaction_idintegerRequired

The transaction's ID

Responses
chevron-right
200

Whether or not the Label has been successfully removed

application/json
delete
/transactions/{transaction_id}/labels/{label_id}