Sign in
Exports

Add export

Creates a new pending export for all entities of the specified EntityType. If an export with status Pending or Processing already exists for the same entity type, the request will be rejected. Successfully created exports remain available for download until the expiration date specified in ExpiresUtc. This operation supports Portfolio Access Tokens.

post/api/connector/v1/exports/add

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EntityType'OrderItem' | 'Payment' | 'Reservation' | 'Customer' | 'Company' | 'Bill' | 'AvailabilityAdjustment' | 'AvailabilityBlock' | 'ResourceBlock' | 'LedgerEntry' required

Type of exported entities

OrderItem

Payment

Reservation

Customer

Company

Bill

AvailabilityAdjustment

AvailabilityBlock

ResourceBlock

LedgerEntry (Beta testing - subject to change. See Ledger entry type.)

Response

OK

Changes

No recorded changes to this endpoint across all 10 revisions of this API.