Transactions

List transactions

OAuth: This endpoint requires one of the following scopes: transaction:manage, transaction:write or transaction:read.

List Transactions

get

🔐 This endpoint requires one of the following scopes:

• transaction:manage
• transaction:read
• transaction:write

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Available scopes:

• : Allow read & write access to My Authors
• : Allow read access to My Authors
• : Allow write access to My Authors

Query parameters

pageintegerOptional

Search results are limited to 100 items. Specify page number to read more than the first page.

Responses

200

Lists transactions

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/v1/clients/transactions

HTTPcURLJavaScriptPython

GET /v1/clients/transactions HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "transactions": [
    {
      "invoice_num": "20220102-XXXX-XXX",
      "money_value_in_currency": 175.32,
      "type": "Transaction::ProjectSpending::LaunchingAProject",
      "issued_at": {
        "day": 2,
        "month": 1,
        "year": 2022,
        "full": "2022-01-02 01:23:45 UTC"
      }
    },
    {
      "invoice_num": "20220101-XXXX-XXX",
      "money_value_in_currency": 8000,
      "invoice": {
        "bundle_base_price_in_author_currency": 8000,
        "bundle_price_in_author_currency": 8000,
        "currency": "€ 0.0",
        "currency_code": "EUR",
        "ordered_credits": 8000000,
        "extra_credits": 0,
        "promo_credits": 0,
        "total_credits": 8000000,
        "real_credit_price_in_ref_cur": 0.001,
        "vat_rate": 0,
        "address": "221B Baker Street",
        "legal_mention": "*VAT exemption under Article 283-2 of the General Tax Code",
        "payment_method": "wire",
        "locale": "en"
      },
      "bundle": [
        {},
        {}
      ],
      "promo_code": {},
      "billing_address": {
        "city": "Paris",
        "address": "55 Rue du Faubourg Saint-Honoré",
        "address2": "Palais de l’Élysée",
        "company": "Top Secret",
        "country": "FR",
        "zip_code": "76008",
        "state_region": "",
        "last_name": "Wallace",
        "first_name": "Marsellus"
      },
      "type": "Transaction::CreditPurchase::BuyingACreditBundle",
      "issued_at": {
        "day": 1,
        "month": 1,
        "year": 2022,
        "full": "2022-12-01 01:23:45 UTC"
      }
    }
  ]
}

Parameters

Name	Type	Description
types	array of strings	The transaction types to filter against. See list of supported types below.

Transaction types

You will find below the list of supported transaction types to filter against:

Transaction::CashWithdrawal::BundleCancellation
Transaction::CashWithdrawal::BundleRefund
Transaction::CreditExchange::GivenByManager
Transaction::CreditExchange::GivenToSubordinate
Transaction::CreditPayment::AdminLoan
Transaction::CreditPayment::AdminRefund
Transaction::CreditPayment::CompletingAJob
Transaction::CreditPayment::ExpiringWallet
Transaction::CreditPayment::FinancialCompensation
Transaction::CreditPurchase::AdminLevy
Transaction::CreditPurchase::BuyingACreditBundle
Transaction::CreditPurchase::EarningFromReferredClient
Transaction::CreditPurchase::ExpiringCredits
Transaction::CreditPurchase::FinancialCompensation
Transaction::CreditPurchase::RedeemingAPromoCode
Transaction::CreditPurchase::Rollback
Transaction::NonCreditPurchase::InHouseServiceFee
Transaction::NonCreditPurchase::SubscriptionPrepayment
Transaction::NonCreditSpending::SubscriptionInstallment
Transaction::ProjectSpending::AdminProjectLevy
Transaction::ProjectSpending::AdminProjectRefund
Transaction::ProjectSpending::CancelingAProject
Transaction::ProjectSpending::LaunchingAProject
Transaction::ProjectSpending::RepoDocWithCanceledProject

Code samples

curl -G "https://api.textmaster.com/v1/clients/transactions" \
  --data-urlencode "types[]=Transaction%3A%3AProjectSpending%3A%3ACancelingAProject" \
  --data-urlencode "types[]=Transaction%3A%3AProjectSpending%3A%3ALaunchingAProject" \
  -H "Authorization: Bearer 0c950ba36bc15a8a10a6d179ca3db112e0cd5e29dca1aa03f4d2b53f01c06db8"

List invoices

OAuth: This endpoint requires one of the following scopes: transaction:manage, transaction:write or transaction:read.

Parameters

Name	Type	Description
types	array of strings	The invoice transaction types to filter against. See list of supported types below.

Transaction types

You will find below the list of supported transaction types that include an invoice, to filter against:

Transaction::CashWithdrawal::BundleCancellation
Transaction::CashWithdrawal::BundleRefund
Transaction::CreditPurchase::BuyingACreditBundle
Transaction::NonCreditPurchase::InHouseServiceFee
Transaction::NonCreditPurchase::SubscriptionPrepayment

List Invoices

get

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Available scopes:

• : Allow read & write access to My Authors
• : Allow read access to My Authors
• : Allow write access to My Authors

Responses

200

Lists invoices

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/v1/clients/invoices

HTTPcURLJavaScriptPython

GET /v1/clients/invoices HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "invoices": [
    {
      "invoice_num": "20211015-A44D-FM5",
      "money_amount": 48,
      "type": "Transaction::CreditPurchase::BuyingACreditBundle",
      "url": "/clients/transactions/61698afd8b81926d91c0f685.pdf",
      "issued_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:06:53 UTC"
      }
    }
  ]
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/invoices" \
  --data-urlencode "types[]=Transaction%3A%3ACashWithdrawal%3A%3ABundleCancellation" \
  --data-urlencode "types[]=Transaction%3A%3ACashWithdrawal%3A%3ABundleRefund" \
  --data-urlencode "types[]=Transaction%3A%3ACreditPurchase%3A%3ABuyingACreditBundle" \
  --data-urlencode "types[]=Transaction%3A%3ANonCreditPurchase%3A%3ABuyingAInHouseServiceFee" \
  --data-urlencode "types[]=Transaction%3A%3ANonCreditPurchase%3A%3ABuyingASubscriptionPrepayment" \
  -H "Authorization: Bearer d8484b69ffe1f749ce720cb370bc65d9fa3e8c3b6e0d19144db676678b0988db"

List receipts

OAuth: This endpoint requires one of the following scopes: transaction:manage, transaction:write or transaction:read.

List Receipts

get

List available receipts.

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Available scopes:

• : Allow read & write access to My Authors
• : Allow read access to My Authors
• : Allow write access to My Authors

Responses

200

Lists receipts

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/v1/clients/receipts

HTTPcURLJavaScriptPython

GET /v1/clients/receipts HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "receipts": [
    {
      "receipt_num": "20211015-A44D-FM5",
      "money_amount": 48,
      "type": "Transaction::ProjectSpending::LaunchingAProject",
      "issued_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:06:53 UTC"
      }
    }
  ]
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/receipts" \
  -H "Authorization: Bearer 1c1a2c26e3f9a890bd232a987f6b538ded6f48f6a02796e54a7ce405eeeb9b19"