Invoice | Subrite

Invoice

Endpoints for Invoice

ReferenceUpdated October 13, 2026View as Markdown

Get filtered invoices of the tenant#

POST/api/v1/invoices/filter

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"

Request body

Required bodyapplication/json

Schema ExampleInvoiceFilter

11 top-level fieldsSelect an object to expand

invoiceStatusarray of INVOICE_STATUSOptional
Allowed values: "paid", "unpaid", "over-due", "over-paid", "partially-paid", "refunded", "credited", "partially-credited"
invoiceNumbernumberOptional
memberSearchstringOptional
maxLength: 120
memberIdstring

Responses

5 status codes

Responses 200

Status200 201 401 403 500application/json

Schema ExampleInvoiceResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of InvoiceResponseRequired23 fields
items
- idnumberRequired when parent is presentField path: items[].id

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/filter \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceStatus": [
    "paid"
  ],
  "invoiceNumber": 0,
  "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
  },
  "deliveryStatus": [
    "sent_via_einvoice"
  ],
  "types": [
    "payment"
  ],
  "memberPackageStatus": [
    "active"
  ]
}'

Try it

Create a credit note for a member#

POST/api/v1/invoices/credit-note

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateCreditNoteDto

6 top-level fieldsSelect an object to expand

memberIdstringRequired
referenceInvoiceNumbernumberOptional
orderLinesarray of CreditNoteOrderItem

Create a standalone invoice for a member#

POST/api/v1/invoices/create-invoice

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaCreateInvoiceDto

4 top-level fieldsSelect an object to expand

memberIdstringRequired
orderLinesarray of InvoiceOrderItemRequired3 required when the containing object is present3 fields
orderLines

GET/api/v1/invoices/{invoiceNumber}/member/{memberId}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

memberIdstringRequired
invoiceNumbernumberRequired

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Initiate a batch download of invoices#

POST/api/v1/invoices/batch-download/initiate

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleInvoiceBatchOperationDto

4 top-level fieldsSelect an object to expand

invoiceNumbersarray of numberOptional
filterInvoiceFilterOptional2 conditional requirements in nested objects11 fields
filter

GET/api/v1/invoices/batch-download/progress/{jobId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

jobIdstringRequired

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

GET/api/v1/invoices/batch-download/stream/{jobId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

jobIdstringRequired

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

PATCH/api/v1/invoices/{invoiceNumber}/due-date

Authentication: Bearer token (JWT)

Parameters

Path parameters1

invoiceNumbernumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateInvoiceDueDateDto

1 top-level field

dueDatestring (date-time)Required

1 documented field · Scroll to see more

PATCH/api/v1/invoices/batch-mark-as-sent

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleInvoiceBatchOperationDto

Same fields as Initiate a batch download of invoices (Request body).

Schema ExampleInvoiceBatchOperationDto

application/json

Create credit notes for a batch of invoices#

POST/api/v1/invoices/batch-create-credit-notes

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleInvoiceBatchOperationDto

Same fields as Initiate a batch download of invoices (Request body).

Schema ExampleInvoiceBatchOperationDto

application/json

Validate which invoices can be credited in a batch operation#

POST/api/v1/invoices/validate-batch-create-credit-notes

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleInvoiceBatchOperationDto

Same fields as Initiate a batch download of invoices (Request body).

Schema ExampleInvoiceBatchOperationDto

application/json

Validate which invoices can be marked as sent in a batch operation#

POST/api/v1/invoices/validate-batch-mark-as-sent

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleInvoiceBatchOperationDto

Same fields as Initiate a batch download of invoices (Request body).

Schema ExampleInvoiceBatchOperationDto

application/json

Get the summary of the invoice for over payment#

GET/api/v1/invoices/extension-summary-for-over-payment/{invoiceNumber}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

invoiceNumbernumberRequired

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Create an invoice for over payment and extend the subscription#

POST/api/v1/invoices/create-invoice-for-over-payment

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaCreateInvoiceForOverPaymentDto

6 top-level fieldsSelect an object to expand

orderLinesarray of CreditNoteOrderItemRequired2 required when the containing object is present4 fields
orderLines

Schema ExampleInvoiceFilter

application/json

{
  "invoiceStatus": [
    "paid"
  ],
  "invoiceNumber": 0,
  "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
  },
  "deliveryStatus": [
    "sent_via_einvoice"
  ],
  "types": [
    "payment"
  ],
  "memberPackageStatus": [
    "active"
  ]
}

Example · 25 linesShow full heightShow compact view

Schema ExampleInvoiceResponsePaginated

200 · application/json

{
  "items": [
    {
      "creditNoteNumbers": []
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 15 linesShow full heightShow compact view

Responses 403

Status200 201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleCreateCreditNoteDto

application/json

{
  "memberId": "string",
  "referenceInvoiceNumber": 0,
  "note": "string",
  "creditFullAmount": true,
  "accountingDate": "2019-08-24T14:15:22Z"
}

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 401 403 409 500application/json

Schema ExampleInvoice

45 top-level fieldsSelect an object to expand

statusINVOICE_STATUSRequired
Allowed values: "paid", "unpaid", "over-due", "over-paid", "partially-paid", "refunded", "credited", "partially-credited"
deliveryStatusINVOICE_DELIVERY_STATUSRequired
Allowed values: "sent_via_einvoice", "sent_via_email", "sent_via_sms", "sent_via_payment_gateway", "sent_manually", "in_progress", "not_sent"
remainingAmountnumberRequired
totalTaxAmountnumberRequired
taxExclusiveAmountnumberRequired
invoiceNumbernumberRequired
languagestringRequired
Allowed values: "en", "no", "sv", "da"
packNamestringRequired
planNamestringRequired
autoGeneratedbooleanRequired
periodStartDatestring (date-time)Required
periodEndDatestring (date-time)Required
memberInfoMemberInfoRequired6 fields
memberInfo
- fullNamestringRequiredField path: memberInfo.fullName
- emailstringRequiredField path: memberInfo.email
- phonestringRequiredField path: memberInfo.phone
- isCompanybooleanRequiredField path: memberInfo.isCompany
- companyNamestringRequiredField path: memberInfo.companyName
- organizationNo
addressInfoAddressInfoRequired13 fields
addressInfo
- line1stringRequiredField path: addressInfo.line1
- line2stringRequiredField path: addressInfo.line2
- citystringRequiredField path: addressInfo.city
- statestringRequiredField path: addressInfo.state
- postCodestringRequiredField path: addressInfo.postCode
- countrystringRequired
tenantInfoTenantInfoRequiredNested fields omitted: field limit.
orderNumbernumberRequired
orderItemInfoarray of OrderItemInfoRequired4 fields
orderItemInfo
- namestringRequired when parent is presentField path: orderItemInfo[].name
- pricenumberRequired when parent is presentField path: orderItemInfo[].price
- taxnumberRequired when parent is presentField path: orderItemInfo[].tax
- quantitynumberRequired when parent is presentField path: orderItemInfo[].quantity
taxGroupInfoarray of TaxGroupInfoRequired3 fields
taxGroupInfo
- taxRatenumberRequired when parent is presentField path: taxGroupInfo[].taxRate
- baseAmountnumberRequired when parent is presentField path: taxGroupInfo[].baseAmount
- taxAmountnumberRequired when parent is presentField path: taxGroupInfo[].taxAmount
paymentProviderstringRequired
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
paymentMethodstringRequired
Allowed values: "card", "vipps", "manual_registration", "efaktura", "ehf", "avtalegiro"
amountnumberRequired
paidAmountnumberRequired
dueDatestring (date-time)Required
paymentDatestring (date-time)Required
accountingDatestring (date-time)Required
currencystringRequired
tenantIdnumberRequired
orderOrderRequiredNested fields omitted: field limit.
eInvoicePaymentEInvoicePaymentRequiredNested fields omitted: field limit.
memberMemberRequiredNested fields omitted: field limit.
tenantTenantRequiredNested fields omitted: field limit.
refundsarray of RefundRequiredNested fields omitted: field limit.
isCreditNotebooleanRequired
notestringRequired
referencedInvoiceNumbernumberRequired
referencedInvoiceIdnumberRequired
referencedInvoiceInvoiceRequiredRecursive schema; nested fields are not repeated.
creditNotesarray of InvoiceRequiredRecursive schema; nested fields are not repeated.
paymentsarray of PaymentRequiredNested fields omitted: field limit.
transactionTransactionRequiredNested fields omitted: field limit.
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired

71 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleInvoice

201 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 409

Status201 401 403 409 500application/json

eventDateFallsInLockedPeriod

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Responses 500

Status201 401 403 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/credit-note \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "memberId": "string",
  "referenceInvoiceNumber": 0,
  "orderLines": [
    {}
  ],
  "note": "string",
  "creditFullAmount": true,
  "accountingDate": "2019-08-24T14:15:22Z"
}'

Responses

5 status codes

Responses 201

Status201 401 403 409 500application/json

Schema ExampleInvoice

Same fields as Create a credit note for a member (201).

Schema ExampleInvoice

201 · application/json

{
  "status": "paid",
  "deliveryStatus": "sent_via_einvoice",
  "remainingAmount": 0,
  "totalTaxAmount": 0,
  "taxExclusiveAmount": 0,
  "invoiceNumber": 0,
  "language": "en",
  "packName": "string",
  "planName": "string",
  "autoGenerated": true,
  "periodStartDate": "2019-08-24T14:15:22Z",
  "periodEndDate": "2019-08-24T14:15:22Z",
  "memberInfo": {
    "fullName": "<fullName>",
    "email": "string",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string"
  },
  "addressInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>"
  },
  "tenantInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>",
    "tenantName": "string",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "invoiceLogo": "string"
  },
  "orderNumber": 0,
  "orderItemInfo": [
    {}
  ],
  "taxGroupInfo": [
    {}
  ],
  "paymentProvider": "stripe",
  "paymentMethod": "card",
  "amount": 0,
  "paidAmount": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "paymentDate": "2019-08-24T14:15:22Z",
  "accountingDate": "2019-08-24T14:15:22Z",
  "currency": "string",
  "tenantId": 0,
  "order": {
    "orderNumber": 0,
    "memberPackageId": 0,
    "recurringPriceAtOrder": 0,
    "paymentId": 0,
    "paymentToken": "<paymentToken>",
    "type": "initial",
    "orderItems": [],
    "payment": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "invoice": {},
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "memberPackageChange": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "eInvoicePayment": {
    "kid": "string",
    "status": "PENDING",
    "channel": "Efaktura 2.0",
    "summary": "string",
    "xml": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "refunds": [
    {
      "metaData": {}
    }
  ],
  "isCreditNote": true,
  "note": "string",
  "referencedInvoiceNumber": 0,
  "referencedInvoiceId": 0,
  "referencedInvoice": {},
  "creditNotes": [
    {}
  ],
  "payments": [
    {
      "metaData": {}
    }
  ],
  "transaction": {
    "transactionGroupId": 0,
    "type": "payment",
    "memberPackageId": 0,
    "amount": 0,
    "reference": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "refundId": 0,
    "accountingDate": "2019-08-24T14:15:22Z",
    "status": "ignored",
    "tenantId": 0,
    "memberId": "string",
    "transactionGroup": {
      "transactions": [],
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "refund": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 356 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 409

Status201 401 403 409 500application/json

eventDateFallsInLockedPeriod

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Responses 500

Status201 401 403 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/create-invoice \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "memberId": "string",
  "orderLines": [
    {}
  ],
  "accountingDate": "2019-08-24T14:15:22Z",
  "note": "string"
}'

Invoice

Schema ExampleInvoice

200 · application/json

{
  "status": "paid",
  "deliveryStatus": "sent_via_einvoice",
  "remainingAmount": 0,
  "totalTaxAmount": 0,
  "taxExclusiveAmount": 0,
  "invoiceNumber": 0,
  "language": "en",
  "packName": "string",
  "planName": "string",
  "autoGenerated": true,
  "periodStartDate": "2019-08-24T14:15:22Z",
  "periodEndDate": "2019-08-24T14:15:22Z",
  "memberInfo": {
    "fullName": "<fullName>",
    "email": "string",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string"
  },
  "addressInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>"
  },
  "tenantInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>",
    "tenantName": "string",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "invoiceLogo": "string"
  },
  "orderNumber": 0,
  "orderItemInfo": [
    {}
  ],
  "taxGroupInfo": [
    {}
  ],
  "paymentProvider": "stripe",
  "paymentMethod": "card",
  "amount": 0,
  "paidAmount": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "paymentDate": "2019-08-24T14:15:22Z",
  "accountingDate": "2019-08-24T14:15:22Z",
  "currency": "string",
  "tenantId": 0,
  "order": {
    "orderNumber": 0,
    "memberPackageId": 0,
    "recurringPriceAtOrder": 0,
    "paymentId": 0,
    "paymentToken": "<paymentToken>",
    "type": "initial",
    "orderItems": [],
    "payment": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "invoice": {},
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "memberPackageChange": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "eInvoicePayment": {
    "kid": "string",
    "status": "PENDING",
    "channel": "Efaktura 2.0",
    "summary": "string",
    "xml": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "refunds": [
    {
      "metaData": {}
    }
  ],
  "isCreditNote": true,
  "note": "string",
  "referencedInvoiceNumber": 0,
  "referencedInvoiceId": 0,
  "referencedInvoice": {},
  "creditNotes": [
    {}
  ],
  "payments": [
    {
      "metaData": {}
    }
  ],
  "transaction": {
    "transactionGroupId": 0,
    "type": "payment",
    "memberPackageId": 0,
    "amount": 0,
    "reference": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "refundId": 0,
    "accountingDate": "2019-08-24T14:15:22Z",
    "status": "ignored",
    "tenantId": 0,
    "memberId": "string",
    "transactionGroup": {
      "transactions": [],
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "refund": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 356 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleInvoiceBatchOperationDto

application/json

{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}

Example · 21 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/batch-download/initiate \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "amountFilter": {},
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}'

InvoiceBatchDownloadProgressDto

Schema ExampleInvoiceBatchDownloadProgressDto

200 · application/json

{
  "progress": 0,
  "isDone": true,
  "isFailed": true,
  "errorMessage": "string"
}

Example · 6 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/invoices/{invoiceNumber}/due-date' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "dueDate": "2019-08-24T14:15:22Z"
}'

{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/batch-mark-as-sent \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "amountFilter": {},
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}'

{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/batch-create-credit-notes \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "amountFilter": {},
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}'

{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Schema ExampleValidatedBatchInvoiceOperationResponse

2 top-level fields

validInvoiceNumbersarray of stringRequired
invalidInvoiceNumbersarray of stringRequired

2 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleValidatedBatchInvoiceOperationResponse

201 · application/json

{
  "validInvoiceNumbers": [
    "string"
  ],
  "invalidInvoiceNumbers": [
    "string"
  ]
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/validate-batch-create-credit-notes \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "amountFilter": {},
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}'

{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Schema ExampleValidatedBatchInvoiceOperationResponse

Same fields as Validate which invoices can be credited in a batch operation (201).

Schema ExampleValidatedBatchInvoiceOperationResponse

201 · application/json

{
  "validInvoiceNumbers": [
    "string"
  ],
  "invalidInvoiceNumbers": [
    "string"
  ]
}

Example · 8 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/validate-batch-mark-as-sent \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceNumbers": [
    0
  ],
  "filter": {
    "invoiceStatus": [],
    "invoiceNumber": 0,
    "memberSearch": "string",
    "memberId": "string",
    "memberEmail": "string",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z",
    "amountFilter": {},
    "deliveryStatus": [],
    "types": [],
    "memberPackageStatus": []
  },
  "selectAll": true,
  "invoiceNumbersToUpdate": [
    0
  ]
}'

Invoice

Schema ExampleInvoice

200 · application/json

{
  "status": "paid",
  "deliveryStatus": "sent_via_einvoice",
  "remainingAmount": 0,
  "totalTaxAmount": 0,
  "taxExclusiveAmount": 0,
  "invoiceNumber": 0,
  "language": "en",
  "packName": "string",
  "planName": "string",
  "autoGenerated": true,
  "periodStartDate": "2019-08-24T14:15:22Z",
  "periodEndDate": "2019-08-24T14:15:22Z",
  "memberInfo": {
    "fullName": "<fullName>",
    "email": "string",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string"
  },
  "addressInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>"
  },
  "tenantInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>",
    "tenantName": "string",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "invoiceLogo": "string"
  },
  "orderNumber": 0,
  "orderItemInfo": [
    {}
  ],
  "taxGroupInfo": [
    {}
  ],
  "paymentProvider": "stripe",
  "paymentMethod": "card",
  "amount": 0,
  "paidAmount": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "paymentDate": "2019-08-24T14:15:22Z",
  "accountingDate": "2019-08-24T14:15:22Z",
  "currency": "string",
  "tenantId": 0,
  "order": {
    "orderNumber": 0,
    "memberPackageId": 0,
    "recurringPriceAtOrder": 0,
    "paymentId": 0,
    "paymentToken": "<paymentToken>",
    "type": "initial",
    "orderItems": [],
    "payment": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "invoice": {},
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "memberPackageChange": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "eInvoicePayment": {
    "kid": "string",
    "status": "PENDING",
    "channel": "Efaktura 2.0",
    "summary": "string",
    "xml": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "refunds": [
    {
      "metaData": {}
    }
  ],
  "isCreditNote": true,
  "note": "string",
  "referencedInvoiceNumber": 0,
  "referencedInvoiceId": 0,
  "referencedInvoice": {},
  "creditNotes": [
    {}
  ],
  "payments": [
    {
      "metaData": {}
    }
  ],
  "transaction": {
    "transactionGroupId": 0,
    "type": "payment",
    "memberPackageId": 0,
    "amount": 0,
    "reference": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "refundId": 0,
    "accountingDate": "2019-08-24T14:15:22Z",
    "status": "ignored",
    "tenantId": 0,
    "memberId": "string",
    "transactionGroup": {
      "transactions": [],
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "refund": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 356 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

productId

number

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Schema ExampleInvoice

Same fields as Create a credit note for a member (201).

Schema ExampleInvoice

201 · application/json

{
  "status": "paid",
  "deliveryStatus": "sent_via_einvoice",
  "remainingAmount": 0,
  "totalTaxAmount": 0,
  "taxExclusiveAmount": 0,
  "invoiceNumber": 0,
  "language": "en",
  "packName": "string",
  "planName": "string",
  "autoGenerated": true,
  "periodStartDate": "2019-08-24T14:15:22Z",
  "periodEndDate": "2019-08-24T14:15:22Z",
  "memberInfo": {
    "fullName": "<fullName>",
    "email": "string",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string"
  },
  "addressInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>"
  },
  "tenantInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>",
    "tenantName": "string",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "invoiceLogo": "string"
  },
  "orderNumber": 0,
  "orderItemInfo": [
    {}
  ],
  "taxGroupInfo": [
    {}
  ],
  "paymentProvider": "stripe",
  "paymentMethod": "card",
  "amount": 0,
  "paidAmount": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "paymentDate": "2019-08-24T14:15:22Z",
  "accountingDate": "2019-08-24T14:15:22Z",
  "currency": "string",
  "tenantId": 0,
  "order": {
    "orderNumber": 0,
    "memberPackageId": 0,
    "recurringPriceAtOrder": 0,
    "paymentId": 0,
    "paymentToken": "<paymentToken>",
    "type": "initial",
    "orderItems": [],
    "payment": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "invoice": {},
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "memberPackageChange": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "eInvoicePayment": {
    "kid": "string",
    "status": "PENDING",
    "channel": "Efaktura 2.0",
    "summary": "string",
    "xml": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "refunds": [
    {
      "metaData": {}
    }
  ],
  "isCreditNote": true,
  "note": "string",
  "referencedInvoiceNumber": 0,
  "referencedInvoiceId": 0,
  "referencedInvoice": {},
  "creditNotes": [
    {}
  ],
  "payments": [
    {
      "metaData": {}
    }
  ],
  "transaction": {
    "transactionGroupId": 0,
    "type": "payment",
    "memberPackageId": 0,
    "amount": 0,
    "reference": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "refundId": 0,
    "accountingDate": "2019-08-24T14:15:22Z",
    "status": "ignored",
    "tenantId": 0,
    "memberId": "string",
    "transactionGroup": {
      "transactions": [],
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "refund": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 356 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

Responses 500

Status201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get filtered invoices of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/invoices/create-invoice-for-over-payment \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "orderLines": [
    {}
  ],
  "referenceInvoiceNumber": 0,
  "periodStartDate": "2019-08-24T14:15:22Z",
  "periodEndDate": "2019-08-24T14:15:22Z",
  "amount": 0,
  "note": "string"
}'

string

{
  "status": "paid",
  "deliveryStatus": "sent_via_einvoice",
  "remainingAmount": 0,
  "totalTaxAmount": 0,
  "taxExclusiveAmount": 0,
  "invoiceNumber": 0,
  "language": "en",
  "packName": "string",
  "planName": "string",
  "autoGenerated": true,
  "periodStartDate": "2019-08-24T14:15:22Z",
  "periodEndDate": "2019-08-24T14:15:22Z",
  "memberInfo": {
    "fullName": "<fullName>",
    "email": "string",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string"
  },
  "addressInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>"
  },
  "tenantInfo": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "addressType": "primary",
    "invoiceReference": "string",
    "companyName": "string",
    "organizationNo": "string",
    "email": "string",
    "phone": "<phone>",
    "tenantName": "string",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "invoiceLogo": "string"
  },
  "orderNumber": 0,
  "orderItemInfo": [
    {}
  ],
  "taxGroupInfo": [
    {}
  ],
  "paymentProvider": "stripe",
  "paymentMethod": "card",
  "amount": 0,
  "paidAmount": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "paymentDate": "2019-08-24T14:15:22Z",
  "accountingDate": "2019-08-24T14:15:22Z",
  "currency": "string",
  "tenantId": 0,
  "order": {
    "orderNumber": 0,
    "memberPackageId": 0,
    "recurringPriceAtOrder": 0,
    "paymentId": 0,
    "paymentToken": "<paymentToken>",
    "type": "initial",
    "orderItems": [],
    "payment": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "invoice": {},
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "memberPackageChange": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "eInvoicePayment": {
    "kid": "string",
    "status": "PENDING",
    "channel": "Efaktura 2.0",
    "summary": "string",
    "xml": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "refunds": [
    {
      "metaData": {}
    }
  ],
  "isCreditNote": true,
  "note": "string",
  "referencedInvoiceNumber": 0,
  "referencedInvoiceId": 0,
  "referencedInvoice": {},
  "creditNotes": [
    {}
  ],
  "payments": [
    {
      "metaData": {}
    }
  ],
  "transaction": {
    "transactionGroupId": 0,
    "type": "payment",
    "memberPackageId": 0,
    "amount": 0,
    "reference": "string",
    "invoiceId": 0,
    "paymentId": 0,
    "refundId": 0,
    "accountingDate": "2019-08-24T14:15:22Z",
    "status": "ignored",
    "tenantId": 0,
    "memberId": "string",
    "transactionGroup": {
      "transactions": [],
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "invoice": {},
    "payment": {
      "metaData": {}
    },
    "refund": {
      "metaData": {}
    },
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Get filtered invoices of the tenant#

Parameters

Request body

Responses

Responses 200

Create a credit note for a member#

Request body

Create a standalone invoice for a member#

Request body

Get an invoice of a member by invoiceNumber#

Parameters

Responses

Responses 200

Initiate a batch download of invoices#

Request body

Get the progress of a batch download of invoices#

Parameters

Responses

Responses 200

Redirect to a temporary download link from S3#

Parameters

Responses

Responses 200

Responses 401

InvoiceController_updateDueDate_v1#

Parameters

Request body

InvoiceController_batchMarkAsSent_v1#

Request body

Create credit notes for a batch of invoices#

Request body

Validate which invoices can be credited in a batch operation#

Request body

Validate which invoices can be marked as sent in a batch operation#

Request body

Get the summary of the invoice for over payment#

Parameters

Responses

Responses 200

Create an invoice for over payment and extend the subscription#

Request body

Get filtered invoices of the tenant#

Parameters

Request body

Responses

Responses 200

Create a credit note for a member#

Request body

Create a standalone invoice for a member#

Request body

Get an invoice of a member by invoiceNumber#

Parameters

Responses

Responses 200

Initiate a batch download of invoices#

Request body

Get the progress of a batch download of invoices#

Parameters

Responses

Responses 200

Redirect to a temporary download link from S3#

Parameters

Responses

Responses 200

Responses 401

InvoiceController_updateDueDate_v1#

Parameters

Request body

InvoiceController_batchMarkAsSent_v1#

Request body

Create credit notes for a batch of invoices#

Request body

Validate which invoices can be credited in a batch operation#

Request body

Validate which invoices can be marked as sent in a batch operation#

Request body

Get the summary of the invoice for over payment#

Parameters

Responses

Responses 200