Export
Endpoints for Export
ReferenceView as Markdown
Endpoints for Export
GET/api/v1/exports
Authentication: Bearer token (JWT)
pagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptional"createdAt"Allowed values: "createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"itemsarray of ExportHistoryResponseRequired16 fieldsitemsfileLinkstringRequired when parent is presentField path: items[].fileLinkcurlcurl https://api.subrite.no/api/v1/exports \
--header 'Authorization: Bearer <token>'GET/api/v1/exports/list-export-fields
Authentication: Bearer token (JWT)
GET/api/v1/exports/{id}
Authentication: Bearer token (JWT)
idnumberRequiredformatstringRequired"csv", "xlsx"POST/api/v1/exports/member-package
Authentication: Bearer token (JWT)
nextRenewalDateFromstring (date-time)OptionalnextRenewalDateTostring (date-time)Optionalstatusarray of stringOptional"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"paymentProviderarray of stringOptional"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf"POST/api/v1/exports/member-package-products
Authentication: Bearer token (JWT)
nextRenewalDateFromstring (date-time)OptionalnextRenewalDateTostring (date-time)Optionalstatusarray of stringOptional"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"paymentProviderarray of stringOptional"stripe", "vipps", "external"POST/api/v1/exports/payments
Authentication: Bearer token (JWT)
dateFromstring (date-time)OptionaldateTostring (date-time)OptionaltransactionTypePaymentAndRefundTypeOptional"payment", "refund", "rounding_adjustment"POST/api/v1/exports/invoices
Authentication: Bearer token (JWT)
dateFromstring (date-time)OptionaldateTostring (date-time)OptionalinvoiceTypeInvoiceTypeOptional"invoice", "creditNote"accountingDatestring (date-time)OptionalPOST/api/v1/exports/member-package-users
Authentication: Bearer token (JWT)
nextRenewalDateFromstring (date-time)OptionalnextRenewalDateTostring (date-time)Optionalstatusarray of stringOptional"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"paymentProviderarray of stringOptional"stripe", POST/api/v1/exports/delivery-address
Authentication: Bearer token (JWT)
nextRenewalDateFromstring (date-time)OptionalnextRenewalDateTostring (date-time)Optionalstatusarray of stringOptional"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"shippingProviderarray of stringOptional"Helthjem", "Bring - Posten", "Distribution Innovation"POST/api/v1/exports/members
Authentication: Bearer token (JWT)
joinedDateFromstring (date-time)OptionaljoinedDateTostring (date-time)OptionalincludeRevenuebooleanOptionalincludeActiveDaysbooleanOptionalPOST/api/v1/exports/segments
Authentication: Bearer token (JWT)
application/jsonsegmentIdnumberRequiredminimum: 1fileNamestringRequiredmaxLength: 255POST/api/v1/exports/ledger
Authentication: Bearer token (JWT)
application/jsonstatusstringOptional"open", "matched", "ignored"typesarray of TransactionResponseTypeOptional"payment", "refund", "invoice", "credit_note", POST/api/v1/exports/survey-responses
Authentication: Bearer token (JWT)
surveyIdstring (uuid)RequiredfileNamestringRequired when parent is presentstatusstringRequired when parent is presentField path: items[].status"started", "completed", "failed", "queued"exportTypestringRequired when parent is presentField path: items[].exportType"subscriptions", "subscription_products", "subscription_users", "payments", "invoices", "all_members", "segments", "ledger", "delivery_address", "ar_invoice_report", "ar_invoice_summary_report", "survey_responses"systemGeneratedbooleanRequired when parent is presentField path: items[].systemGeneratedadminUserIdnumberRequired when parent is presentField path: items[].adminUserIdtenantIdnumberRequired when parent is presentField path: items[].tenantIdadminUserUserRequired when parent is presentField path: items[].adminUser24 fieldsitems[].adminUseruserTypestringRequired when parent is presentField path: items[].adminUser.userType"system_admin", "tenant_admin", "member", "not_set"tenantIdnumberRequired when parent is presentField path: items[].adminUser.tenantIdemailstringRequired when parent is presentField path: items[].adminUser.emailfullNamestringRequired when parent is presentField path: items[].adminUser.fullNamephonestringRequired when parent is presentField path: items[].adminUser.phoneemailVerifiedstringRequired when parent is presentField path: items[].adminUser.emailVerifiedphoneVerifiedbooleanRequired when parent is presentField path: items[].adminUser.phoneVerifiedisOwnerbooleanRequired when parent is presentField path: items[].adminUser.isOwnerisTestUserbooleanRequired when parent is presentField path: items[].adminUser.isTestUserimagestringRequired when parent is presentField path: items[].adminUser.imagecreatedInCheckoutUuidstringRequired when parent is presentField path: items[].adminUser.createdInCheckoutUuiduserRolesarray of UserRoleField path: items[].adminUser.userRolesNested fields omitted: depth limit.notesarray of NoteRequired when parent is presentField path: items[].adminUser.notesNested fields omitted: depth limit.exportHistoryarray of ExportHistoryRequired when parent is presentField path: items[].adminUser.exportHistoryNested fields omitted: depth limit.userSettingsUserSettingsField path: items[].adminUser.userSettingsNested fields omitted: depth limit.memberMemberField path: items[].adminUser.memberNested fields omitted: depth limit.tenantTenantRequired when parent is presentField path: items[].adminUser.tenantNested fields omitted: depth limit.userAccountsarray of UserAccountRequired when parent is presentField path: items[].adminUser.userAccountsNested fields omitted: depth limit.userSessionsarray of UserSessionRequired when parent is presentField path: items[].adminUser.userSessionsNested fields omitted: depth limit.idnumberRequired when parent is presentField path: items[].adminUser.idcreatedAtstring (date-time)Required when parent is presentField path: items[].adminUser.createdAtupdatedAtstring (date-time)Required when parent is presentField path: items[].adminUser.updatedAtdeletedAtstring (date-time)Required when parent is presentField path: items[].adminUser.deletedAtmetaDataobjectRequired when parent is presentField path: items[].adminUser.metaDatatenantTenantRequired when parent is presentField path: items[].tenantNested fields omitted: field limit.idnumberRequired when parent is presentField path: items[].idcreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: items[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: items[].deletedAtmetaDataobjectRequired when parent is presentField path: items[].metaDatacreatedBystringRequired when parent is presentField path: items[].createdByrefreshStatusbooleanRequired when parent is presentField path: items[].refreshStatusmetaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{
"metaData": {}
}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}badRequest
messageCodestringRequired"badRequest"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
messageCodestringRequiredmessagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}customPropertiesarray of ListExportFieldDtoRequired2 fieldscustomPropertieskeystringRequired when parent is presentField path: customProperties[].keylabelstringRequired when parent is presentField path: customProperties[].labelconsentsarray of ListExportFieldDtoRequired2 fieldsconsentskeystringRequired when parent is presentField path: consents[].keylabelstringRequired when parent is presentField path: consents[].label{
"customProperties": [
{}
],
"consents": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/exports/list-export-fields \
--header 'Authorization: Bearer <token>'This response has no body.
badRequest, exportFormatUnsupported
messageCodestringRequired"badRequest", "exportFormatUnsupported"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessage{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}exportNotFound
messageCodestringRequired"exportNotFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "exportNotFound",
"message": "string",
"errors": [
{}
]
}exportNotCompleted, exportFileUnavailable
messageCodestringRequired"exportNotCompleted", "exportFileUnavailable"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessage{
"messageCode": "exportNotCompleted",
"message": "string",
"errors": [
{}
]
}exportFileDownloadFailed
messageCodestringRequired"exportFileDownloadFailed"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "exportFileDownloadFailed",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/exports/{id}?format=csv' \
--header 'Authorization: Bearer <token>'"swedbankpay"subscriptionPlanIdarray of numberOptionalproductIdarray of numberOptionalmessagestringRequiredexportHistoryIdnumberRequired{
"message": "string",
"exportHistoryId": 0
}badRequest
Same fields as Get all exports of the tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}exportQueueFailed
messageCodestringRequired"exportQueueFailed"messagestringcurlcurl https://api.subrite.no/api/v1/exports/member-package \
--request POST \
--header 'Authorization: Bearer <token>'"nets""efaktura-avtalegiro-ehf""swedbankpay"subscriptionPlanIdarray of numberOptionalproductIdarray of numberOptionalSame fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
curlcurl https://api.subrite.no/api/v1/exports/member-package-products \
--request POST \
--header 'Authorization: Bearer <token>'application/jsonSame fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}badRequest
Same fields as Get all exports of the tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/exports/payments \
--request POST \
--header 'Authorization: Bearer <token>'application/jsonSame fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}badRequest
Same fields as Get all exports of the tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/exports/invoices \
--request POST \
--header 'Authorization: Bearer <token>'"vipps""external""nets""efaktura-avtalegiro-ehf""swedbankpay"subscriptionPlanIdarray of numberOptionalproductIdarray of numberOptionalSame fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
curlcurl https://api.subrite.no/api/v1/exports/member-package-users \
--request POST \
--header 'Authorization: Bearer <token>'productIdarray of numberOptionalSame fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
curlcurl https://api.subrite.no/api/v1/exports/delivery-address \
--request POST \
--header 'Authorization: Bearer <token>'application/jsonSame fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}badRequest
Same fields as Get all exports of the tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/exports/members \
--request POST \
--header 'Authorization: Bearer <token>'fieldsarray of stringminItems: 1{
"segmentId": 1,
"fileName": "string",
"fields": [
"string"
]
}Same fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}badRequest
Same fields as Get all exports of the tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
segmentNotFound
messageCodestringRequired"segmentNotFound"messagestringexportQueueFailed
Same fields as Generate subscription report as a csv file (503).
curlcurl https://api.subrite.no/api/v1/exports/segments \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"segmentId": 1,
"fileName": "string",
"fields": [
"string"
]
}'"rounding_adjustment"invoiceStatusarray of INVOICE_STATUSOptional"paid", "unpaid", "over-due", "over-paid", "partially-paid", "refunded", "credited", "partially-credited"invoiceNumbernumberOptionalreferencestringOptionalmemberSearchstringOptionalmaxLength: 120memberIdstringOptionalmemberEmailstringOptionalmaxLength: 120dateFromstring (date-time)OptionaldateTostring (date-time)OptionalamountFilterAmountFilterOptional2 required when the containing object is present3 fieldsamountFilteroperatorComparisonOperatorRequired when parent is presentField path: amountFilter.operator"EQUALS", "BETWEEN", "GREATER_THAN", "LESS_THAN"amountnumberRequired when parent is presentField path: amountFilter.amountsecondAmountnumberOptionalField path: amountFilter.secondAmount{
"status": "open",
"types": [
"payment"
],
"invoiceStatus": [
"paid"
],
"invoiceNumber": 0,
"reference": "string",
"memberSearch": "string",
"memberId": "string",
"memberEmail": "string",
"dateFrom": "2019-08-24T14:15:22Z",
"dateTo": "2019-08-24T14:15:22Z",
"amountFilter": {
"operator": "EQUALS",
"amount": 0,
"secondAmount": 0
}
}Same fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}badRequest
Same fields as Get all exports of the tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/exports/ledger \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"status": "open",
"types": [
"payment"
],
"invoiceStatus": [
"paid"
],
"invoiceNumber": 0,
"reference": "string",
"memberSearch": "string",
"memberId": "string",
"memberEmail": "string",
"dateFrom": "2019-08-24T14:15:22Z",
"dateTo": "2019-08-24T14:15:22Z",
"amountFilter": {
"operator": "EQUALS",
"amount": 0,
"secondAmount": 0
}
}'Same fields as Generate subscription report as a csv file (201).
{
"message": "string",
"exportHistoryId": 0
}badRequest
Same fields as Get all exports of the tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all exports of the tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}surveyNotFound
messageCodestringRequired"surveyNotFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessage{
"messageCode": "surveyNotFound",
"message": "string",
"errors": [
{}
]
}exportQueueFailed
Same fields as Generate subscription report as a csv file (503).
{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/exports/survey-responses?surveyId=%3CsurveyId%3E' \
--request POST \
--header 'Authorization: Bearer <token>'stringerrorTypestringRequired when parent is presentField path: errors[].errorTypestringerrorTypestringRequired when parent is presentField path: errors[].errorTypeerrorsarray of FieldErrorRequirederrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}errorsarray of FieldErrorRequirederrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "segmentNotFound",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "exportQueueFailed",
"message": "string",
"errors": [
{}
]
}stringerrorTypestringRequired when parent is presentField path: errors[].errorType