POST
/
company_statements
/

With this request, you can schedule a statement generation for a company.

In a response, you will get an object with the following structure. Main fields to look out for here are id, status and download_url.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from
integer

Filter result set to only include values older or equal to the provided Unix timestamp

to
integer

Filter result set to only include values younger than the provided Unix timestamp

paid_from
integer

Filter paid result set to only include values older or equal to the provided Unix timestamp

paid_to
integer

Filter paid result set to only include values younger than the provided Unix timestamp

updated_from
integer

Filter result set to only include values older or equal to the provided last modification time Unix timestamp

updated_to
integer

Filter result set to only include values younger than the provided last modification time Unix timestamp

brand_id
string

Filter result set to only include the specified brand UUID(s)

shop_id
string

Filter result set to only include the specified shop UUID(s)

q
string

Filter result set to only include results including a specified text (search over a ton of text fields)

products
string

Filter result set to only include results including a specified text in products

total
string

Filter result set to only include results with a total between min and max value. Must include 2 values, if any - (min, max).

currency
string

Filter result set to only include specified currency(ies)

payment_method
enum<string>

Filter result set to only include specified payment methods(s). See <a href="#model-PaymentMethod">PaymentMethod<a> fro more information.

Available options:
fpx,
fpx_b2b1,
maestro,
mastercard,
razer,
unknown,
visa
three_d_secure
string

Filter result set to only include results with a 3-D verification.

country
string

Filter result set to only include specified client country(ies) in ISO 3166-1 alpha-2 format

status
string

Filter result set to only include results with a specific status. See <a href="#model-Purchase">Purchase<a> and <a href="#model-Payout">Payout<a> for more information.

product
enum<string>

Filter result set to only include specified products(s). See <a href="#model-TransactionProduct">TransactionProduct<a> fro more information.

Available options:
bank_payment,
custom_payment,
invoice,
purchase,
refund,
subscription

Body

application/json
format
string

Statement format, available formats: csv, xlsx.

timezone
string

Timezone to localize statement-specific timestamps

Response

201 - application/json
format
string

Statement format, available formats: csv, xlsx.

timezone
string

Timezone to localize statement-specific timestamps

is_test
boolean

Indicates this is a test object, created using test API keys or using Billing section of UI while in test mode.

company_uid
string

ID of the Company.

query_string
string

Query parameters used to generate statement.

status
string

Status of statement generation e.g. pending, processing, success.

download_url
string

Download URL of a statement.

began_on
integer

Date and time for the beginning of statement generation process.

finished_on
integer

Date and time for finishing the statement generation process.

created_on
integer

Object creation time

updated_on
integer

Object last modification time

type
string

Statement request type

id
string

ID of a statement

Get company turnoverRetrieve a statement