Faselis Myra logo
Documentation Powered by ReDoc

Myra API Documentation (v0.0.4)

Download OpenAPI specification:Download

API Support: software@faselis.com

This is the API documentation for Myra - an internal project covering full account management (accounts, brands, users) and transaction tracking with some management/reporting functionality.

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Myra Parameters

Myra environment parameters

Fetches Myra environment parameters for use in general mutliple selects

This call returns the general parameters to use as multiple select options like packages, regions, accountManagers etc.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "accountManagers": [
    ],
  • "packages": [
    ]
}

Profile

Authentication and basic profile api calls for the Myra user

Login to Myra

Initial login call to get accessToken

Authorizations:
bearerAuth
Request Body schema: application/json

All requests to this call have to include a username and password property in the request body object.

username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "aydin.sun@faselis.com",
  • "password": "test12"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "login": true,
  • "Cookie": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjEyMzQ1IiwibmFtZSI6IkVsdmlzIFByZXNsZXkiLCJpYXQiOjE1MTYyMzkwMjJ9.QtUKYTdPEkkD3azc5CzgeVGgdjjPkFO5obWSAQ0Laho"
}

Logout from Myra.

To notify the Myra server when the user is logging out. This call should be called whenever you delete the accessToken from the local storage, i.e. on logout event.

Authorizations:
bearerAuth

Responses

To get a new password

Requests a new password when the user forgots.

Authorizations:
bearerAuth
Request Body schema: application/json

Username is required for new password request.

This call returns 200 even if there is no such user.

username
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "ozer.subasi@faselis.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "username": "ozer.subasi@faselis.com",
  • "isSend": true
}

Gets the current Myra user's profile

This call fetches the logged-in Myra user's profile details.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Updates password for the logged in Myra user.

This call updates the password of current Myra user.

Authorizations:
bearerAuth
Request Body schema: application/json

The current password, a new password (newPassword) and the new password duplication (newPasswordControl) are required in the request body.

If the given current password is invalid, a 403 forbidden response is returned.

email
required
string
password
required
string
newPassword
required
string
newPasswordControl
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "ozer.subasi@faselis.com",
  • "password": "currentxxxxpassword",
  • "newPassword": "strongxxxxpassword",
  • "newPasswordControl": "strongxxxxxpassword"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Account

Account api calls - top level functions

Retrieves accounts by filtering them

Accounts can be listed by filtering according to their Account Name, Company Name, Brand Name, User Name, User E-mail, Account Manager, Type, Package, Status, Payment Type and Contract End Date.

In addition, if balance parameter is set to be true, then the return object includes the balance value.

Authorizations:
bearerAuth
Request Body schema: application/json

The filtering parameters should be sent. None is required. Missing parameters will not be used in filtering algorithm. If an ampty request body is sent, all the accounts will be returned. Try to set some defaults to prevent overload on the servers.

page
integer
numberOfItems
integer
name
string
companyName
string
brandName
string
userName
string
email
string
object
type
string
Default: "Corporate"
Enum: "Agency" "Corporate" "Sponsored"
packageCode
string
onlyActive
boolean
showBalance
boolean
paymentTypes
Array of strings
contractEndDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "numberOfItems": 10,
  • "name": "Bersay",
  • "companyName": "Bersay İletişim Danışmanlığı",
  • "brandName": "Gravital",
  • "userName": "Demir",
  • "email": "a.demir@bersay.com.tr",
  • "accountManager": {
    },
  • "type": "Corporate",
  • "packageCode": "as",
  • "onlyActive": true,
  • "showBalance": false,
  • "paymentTypes": [
    ],
  • "contractEndDate": "2021-12-31"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Creates new account

Creates account and returns an accountId

Authorizations:
bearerAuth
Request Body schema: application/json

Account data including accountName, manager, accountType and contact

accountName
string
accountManagerId
string
status
boolean
accountType
string
userName
string
title
string
mobilePhone
string
email
string
webSite
string
address
string
officePhone
string
postalCode
string
state
string
country
string
package
string
paymentType
string
sendOnlyTest
boolean
currency
string
invoicing
string
agreementFileName
string
agreementExpireDate
string
companyFullName
string
taxPerson
string
taxPersonPosition
string
taxPersonPhone
string
taxPersonEmail
string
taxOffice
string
taxNo
string
invoiceAddress
string
accountingCode
string
note
string

Responses

Request samples

Content type
application/json
{
  • "accountName": "Faselis Development",
  • "accountManagerId": "245",
  • "status": 1,
  • "accountType": "1",
  • "userName": "Ozer SUBASI",
  • "title": "Software Engineer",
  • "mobilePhone": null,
  • "email": "development.test@faselis.com",
  • "webSite": "",
  • "address": "",
  • "officePhone": "",
  • "postalCode": "",
  • "state": "",
  • "country": "",
  • "package": "ax",
  • "paymentType": "",
  • "sendOnlyTest": 0,
  • "currency": "",
  • "invoicing": "",
  • "agreementFileName": "cdn/test",
  • "agreementExpireDate": "2020-09-09",
  • "companyFullName": "Faselis Development A.Ş.",
  • "taxPerson": "Emek Tuzun",
  • "taxPersonPosition": "CTO",
  • "taxPersonPhone": "0000000000",
  • "taxPersonEmail": "emek.tuzun@faselis.com",
  • "taxOffice": "Beyoğlu V.D.",
  • "taxNo": "32525235",
  • "invoiceAddress": "Hacımimi",
  • "accountingCode": "007",
  • "note": "Bu bir test notudur."
}

Response samples

Content type
application/json
{}

Specific account's details

This call returns the details of a specified account with path parameter accoundId

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e

Responses

Response samples

Content type
application/json
{}

Updates basic account account info

In Details page, updates account info

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
Request Body schema: application/json

Account data including accountName, manager, accountType and contact

accountName
string
accountId
string
accountManagerId
string
status
boolean
accountType
string
userName
string
title
string
mobilePhone
string
email
string
webSite
string
address
string
officePhone
string
postalCode
string
state
string
country
string
package
string
paymentType
string
sendOnlyTest
boolean
currency
string
invoicing
string
agreementFileName
string
agreementExpireDate
string
companyFullName
string
taxPerson
string
taxPersonPosition
string
taxPersonPhone
string
taxPersonEmail
string
taxOffice
string
taxNo
string
invoiceAddress
string
accountingCode
string
note
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "accountName": "Faselis Development",
  • "accountManagerId": "245",
  • "status": 1,
  • "accountType": "1",
  • "userName": "Ozer SUBASI",
  • "title": "Software Engineer",
  • "mobilePhone": null,
  • "email": "development.test@faselis.com",
  • "webSite": "",
  • "address": "",
  • "officePhone": "",
  • "postalCode": "",
  • "state": "",
  • "country": "",
  • "package": "ax",
  • "paymentType": "",
  • "sendOnlyTest": 0,
  • "currency": "",
  • "invoicing": "",
  • "agreementFileName": "cdn/test",
  • "agreementExpireDate": "2020-09-09",
  • "companyFullName": "Faselis Development A.Ş.",
  • "taxPerson": "Emek Tuzun",
  • "taxPersonPosition": "CTO",
  • "taxPersonPhone": "0000000000",
  • "taxPersonEmail": "emek.tuzun@faselis.com",
  • "taxOffice": "Beyoğlu V.D.",
  • "taxNo": "32525235",
  • "invoiceAddress": "Hacımimi",
  • "accountingCode": "007",
  • "note": "Bu bir test notudur."
}

Response samples

Content type
application/json
{}

Uploads new local agreement

Uploads account's new local agreement PDF file

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
Request Body schema: application/pdf
string <binary> (LocalAgreementFile)

Local Agreement File Body

Responses

Gets current status and activation history of an account

Returns activation history array

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e

Responses

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "status": true,
  • "isHold": false,
  • "activationHistory": [
    ]
}

Saves new action/status and returns activation history

Adds new action and returns action history

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
Request Body schema: application/json
action
string
holdAction
string
actionBy
string
reason
string
note
string

Responses

Request samples

Content type
application/json
{
  • "action": "Open",
  • "holdAction": "Unhold",
  • "actionBy": "Person name",
  • "reason": "Finance",
  • "Note": "No active brand"
}

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "status": true,
  • "isHold": false,
  • "activationHistory": [
    ]
}

User

Account --> User management api calls

Get list of account users

Get list of users associated to account. Optionally, add onlyActive and/or onlyAdmin params to filter the list if you want only active and/or admin/owner users.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
query Parameters
numberOfItems
required
string
Example: numberOfItems=20

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

onlyActive
string
Example: onlyActive=true

Set 'true' to get only active users. Any other input will get both active and inactive users.

onlyAdmin
string
Example: onlyAdmin=true

Set 'true', to get only admin users. Any other input will get users of all type.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Creates new user

Creates new account user. Returns full list of account users.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
query Parameters
numberOfItems
required
string
Example: numberOfItems=20

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

Request Body schema: application/json
firstName
string
lastName
string
email
string
role
string
status
boolean

Responses

Request samples

Content type
application/json
{
  • "firstName": "Ahmet",
  • "lastName": "Mehmetoğlu",
  • "email": "ahmet@mehmetoglu.com",
  • "role": "Owner",
  • "status": true
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Gets user profile details

User info is returned (Id, First Name, Last Name, E-mail, Role, Status).

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
userId
required
string
Example: 32784324

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Updates user profile

Updates user's first name, last name, email, role and status. Updated user's info is returned as response.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
userId
required
string
Example: 32784324
Request Body schema: application/json
id
string
firstName
string
lastName
string
email
string
role
string
status
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "32784324",
  • "firstName": "Ahmet",
  • "lastName": "Mehmetoğlu",
  • "email": "ahmet@mehmetoglu.com",
  • "role": "User",
  • "status": true
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Gets user's brand permissions with brand list

Returns list of brands associated to user's account and user's permissions for those brands.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
userId
required
string
Example: 32784324
query Parameters
numberOfItems
required
string
Example: numberOfItems=10

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Updates brand permission

Updates user's specific brand permission. Returns updated list of user's brand permissions.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
userId
required
string
Example: 32784324
query Parameters
numberOfItems
required
string
Example: numberOfItems=20

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

Request Body schema: application/json
brandId
integer
permission
string

Responses

Request samples

Content type
application/json
{
  • "brandId": 93634753,
  • "permission": true
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Creates new brand permission for user

Creates new brand permission for user. Returns updated list of user's brand permissions.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
userId
required
string
Example: 32784324
query Parameters
numberOfItems
required
string
Example: numberOfItems=20

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

Request Body schema: application/json
brandId
integer

Responses

Request samples

Content type
application/json
{
  • "brandId": 7366235
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Brand

Account --> Brand management api calls

Gets list of brands in Brands Query

Queries the brands according to filter in Brands Query page.

Authorizations:
bearerAuth
query Parameters
numberOfItems
required
string
Example: numberOfItems=20

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

Request Body schema: application/json

Body of Brands Query

brandName
string
closeDateStart
string <date>
closeDateEnd
string <date>
onlyActiveAccount
boolean
onlyActiveBrands
boolean
onlyPassiveBrands
boolean

Responses

Request samples

Content type
application/json
{
  • "brandName": "Blabla İletişim",
  • "closeDateStart": "2018-12-01",
  • "closeDateEnd": "2018-10-31",
  • "onlyActiveAccount": true,
  • "onlyActiveBrands": true,
  • "onlyPassiveBrands": false
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Gets list of brands associated with account

Brands under specified account are retrieved. Optional status query param can be set to get only active or inactive brands. If status is not set, all account brands are retrieved.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
query Parameters
status
string
Example: status=true

Activity status of brands. Set to true to list active brands. Set to false to list inactive brands.

numberOfItems
required
string
Example: numberOfItems=20

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Gets Brand Details and Brand Action History

Gets Brand Details in updatable form and Brand Action History.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
brandId
required
integer <int64>
Example: 327433

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Updates Brand Details

Updates Brand Details (Brand Name, Status, Brand Type, Master Brand, Expire Date, Auto Renewal). None is required, however if type is set as 'Sub-brand', masterBrandId is required.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
brandId
required
integer <int64>
Example: 327433
Request Body schema: application/json

Brand's Type, Master Brand, Expired Date, Renewal information

brandName
required
string
status
required
boolean
type
required
string
agencyOwned
required
boolean
masterBrandId
integer
expireDate
required
string <date>
autoRenewal
required
integer

Responses

Request samples

Content type
application/json
{
  • "brandName": "Vestel",
  • "status": true,
  • "type": "Sub-brand",
  • "agencyOwned": false,
  • "masterBrandId": 12365234,
  • "expireDate": "2021-12-31",
  • "autoRenewal": true
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Creates new brand for account

New Brand is created under account. For Sub-brand set type as 'Sub-brand' and and make sure set masterBrandId, for Master brand set type as 'Master'.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
Request Body schema: application/json

Brand's Type, Master Brand, Expired Date, Renewal information

brandName
string
status
boolean
masterBrandId
integer
expireDate
string <date>
autoRenewal
boolean

Responses

Request samples

Content type
application/json
{
  • "brandName": "Zorlu",
  • "type": "Sub-brand",
  • "status": true,
  • "masterBrandId": 324628,
  • "expireDate": "2021-12-31",
  • "autoRenewal": true
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Gets users and their permissions for brand

Gets list of account users and their permissions for specified brand.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
brandId
required
integer <int64>
Example: 327433
query Parameters
numberOfItems
required
string
Example: numberOfItems=20

Number of items to be displayed on page.

page
required
string
Example: page=1

Page number.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "body": {
    }
}

Gets Periods for Brand Distributions

Gets Brand Name, Brand Type, Master Brand and List of distribution periods.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
brandId
required
integer <int64>
Example: 327433

Responses

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "brandDetails": {
    },
  • "distributionPeriods": [
    ]
}

Get Brand Distribution Details By Period

List of Distributions for selected period. Brand Name to be retrieved as well?

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
brandId
required
integer <int64>
Example: 327433
Request Body schema: application/json

Period for Distributions

accountId
string
year
required
integer [ 2000 .. 2050 ]
month
required
integer [ 1 .. 12 ]

Responses

Request samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "year": 2021,
  • "month": 1
}

Response samples

Content type
application/json
{
  • "brandDetails": {
    },
  • "pressReleases": [
    ]
}

Transactions

Transaction management and reporting api calls

Lists invoices

Get the invoice list of account

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e

Responses

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "invoices": [
    ]
}

Create new invoice document

Create new invoice document

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
Request Body schema: application/json
date
string <date>
type
string
documentNo
string
amount
string
currency
string
status
string
note
string

Responses

Request samples

Content type
application/json
{
  • "date": "2021-01-31",
  • "type": "INV",
  • "documentNo": "32136546",
  • "amount": "300",
  • "currency": "try",
  • "status": "paid",
  • "note": "will be paid by CC"
}

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "invoices": [
    ]
}

Gets incoming invoice details

Get incoming invoice details, look payment periods, amounts and payment status

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e

Responses

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "invoiceNo": 1221312,
  • "invoiceDate": "2021-12-12",
  • "periods": [
    ]
}

Gets credits list of account

Get credits list of account, look definitions of documents

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e

Responses

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "creditsList": [
    ]
}

Update credits of account

Update credits of account

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "credits": {
    }
}

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "credits": {
    }
}

Gets transactions according to filter

Transactions can be listed by default Region and Currency filter.

Also filter can be expanded by adding Company details, Region, Currency, Transaction type, Payment Zones, Payment Type, Refund, Date Range and Amount.

Authorizations:
bearerAuth
Request Body schema: application/json
name
string
accountManager
string
Default: "Vildan"
Enum: "Seçkin" "Oğuzhan" "Vildan"
type
string
Default: "Corporate"
Enum: "Agency" "Corporate" "Sponsored"
package
string
Enum: "Standart" "Pro" "Trial" "Silver" "Gold" "Full"
regions
Array of strings
currencies
Array of strings
transactions
Array of strings
paymentZones
Array of strings
paymentTypes
Array of strings
refunds
Array of strings
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "Blabla",
  • "type": "Agency",
  • "package": "Pro",
  • "accountManager": "Seçkin",
  • "regions": [
    ],
  • "currencies": [
    ],
  • "transactions": [
    ],
  • "paymentZones": [
    ],
  • "paymentTypes": [
    ],
  • "refunds": [
    ],
  • "dateRange": {
    },
  • "amountRange": {
    }
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Creates new transaction

RESERVED FOR FUTURE USE: New transaction is added. Note to add api call to search by accountName and when selected found account, fill other account related fields (accountId, accountType) with its data.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
Request Body schema: application/json
required
object (payment)
type
required
string
Enum: "OB" "INV"

Responses

Request samples

Content type
application/json
{
  • "payment": {
    },
  • "type": "OB"
}

Response samples

Content type
application/json
{
  • "accountId": "5b4ecea1-be90-4b7d-81e6-27d7cb579d4e",
  • "payment": {
    },
  • "type": "OB"
}

Uploads transaction file

Transaction file is uploaded, or previously uploaded one can be replaced by reuploading the file.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
transactionId
required
string
Example: 1AB23456C7890123D
Request Body schema: application/pdf
string <binary>

Responses

Deletes transaction file.

Transaction file is deleted.

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: 5b4ecea1-be90-4b7d-81e6-27d7cb579d4e
transactionId
required
string
Example: 1AB23456C7890123D

Responses

Response samples

Content type
application/json
{ }

Gets all disbursements

Lists all disbursements.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Gets disbursements by filter

Disbursements are filtered according to Company Name, Currency, Payment Zone, Transaction Date and Amount.

Authorizations:
bearerAuth
Request Body schema: application/json
accountName
string
currencies
Array of strings
paymentZones
Array of strings
object
object

Responses

Request samples

Content type
application/json
{
  • "accountName": "Ducky",
  • "currencies": [
    ],
  • "paymentZones": [
    ],
  • "dateRange": {
    },
  • "amountRange": {
    }
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Reports

Displays list of reports

Reports can be filtered by specifying Account Name, Region, Product, Invoicing Zone, Amount range, Currency and Date range.

Authorizations:
bearerAuth
Request Body schema: application/json
accountName
string
region
Array of strings
product
Array of strings
invoicing
Array of strings
object
currencies
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "accountName": "Bersay",
  • "region": [
    ],
  • "product": [
    ],
  • "invoicing": [
    ],
  • "amountRange": {
    },
  • "currencies": [
    ],
  • "dateRange": {
    }
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]