POST
/
company_statements
curl --request POST \
  --url https://gate.chip-in.asia/api/v1/company_statements/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "format": "csv",
  "timezone": "UTC"
}'
{
  "format": "<string>",
  "timezone": "Europe/Oslo",
  "is_test": true,
  "company_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query_string": "<string>",
  "status": "<string>",
  "download_url": "<string>",
  "began_on": 1619740800,
  "finished_on": 1619740800,
  "created_on": 1619740800,
  "updated_on": 1619740800,
  "type": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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
header
required

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
required

Filter result set to only include specified currency(ies). The value must be in uppercase.

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

Response

201
application/json
OK

The response is of type object.