{
"openapi": "3.1.1",
"info": {
"title": "Accounting API",
"description": "Unified API for reading and writing accounting data across multiple accounting systems. All endpoints require a valid consent ID representing an authorized connection to a specific accounting system. Authenticate using an API key passed in the `x-api-key` header.\n\nSystem support is documented per endpoint in each operation description under **System support**.",
"termsOfService": "https://www.zwapgrid.com/terms-and-conditions",
"contact": {
"name": "Zwapgrid",
"url": "https://www.zwapgrid.com",
"email": "hello@zwapgrid.com"
},
"version": "v1"
},
"servers": [
{
"url": "https://apione.zwapgrid.com/accounting"
}
],
"paths": {
"/api/v1/consents/{consentId}/accountingaccounts": {
"get": {
"tags": [
"Accounting Accounts"
],
"summary": "List accounting accounts",
"description": "Retrieves a paginated list of accounting accounts for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| ![\"Fortnox\"](\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\")
Fortnox | ✅ Supported |\n| ![\"Bjorn](\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\")
Bjorn Lunden | 📞 Not supported / contact us |\n| ![\"Spiris\"](\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\")
Spiris | ✅ Supported |\n| ![\"Tripletex\"](\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\")
Tripletex | 📞 Not supported / contact us |\n| ![\"Visma](\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\")
Visma e-conomic | ✅ Supported |\n| ![\"Billy\"](\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\")
Billy | 📞 Not supported / contact us |\n| ![\"Visma](\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\")
Visma Dinero | 📞 Not supported / contact us |\n| ![\"Procountor\"](\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\")
Procountor | 📞 Not supported / contact us |\n| ![\"Visma](\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\")
Visma Netvisor | 📞 Not supported / contact us |\n| ![\"Microsoft](\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\")
Microsoft Business Central | ✅ Supported |\n| ![\"Exact](\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\")
Exact Online | 📞 Not supported / contact us |\n| ![\"QuickBooks\"](\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\")
QuickBooks | 📞 Not supported / contact us |\n| ![\"Xero\"](\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\")
Xero | ✅ Supported |\n| ![\"Bokio\"](\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\")
Bokio | 📞 Not supported / contact us |",
"operationId": "ListAccountingAccounts",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Count",
"in": "query",
"description": "Number of records to return per page. Range: 1-100.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "CurrentPage",
"in": "query",
"description": "Page number to return. Must be 1 or greater.",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of accounting accounts for the specified consent.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountingAccountDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountingAccountDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "6900",
"accountingAccountId": "6900",
"reference": "6900",
"standardAccountingAccountId": "6900",
"name": "VAT and duties",
"active": true,
"postable": true,
"description": {
"languageId": "ENG",
"text": "VAT and other duties"
},
"descriptions": [
{
"languageId": "ENG",
"text": "VAT and other duties"
}
],
"accountingAccountTypeCode": {
"code": "EXP",
"listId": null
},
"financialDimensions": []
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountingAccountDtoPagedResultDto"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/accountingperiods": {
"get": {
"tags": [
"Accounting Periods"
],
"summary": "List accounting periods",
"description": "Retrieves a paginated list of accounting periods for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListAccountingPeriods",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of accounting periods for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountingPeriodDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "2024",
"reference": "2024",
"accountingMethod": null,
"startDate": "2024-01-01",
"endDate": "2024-12-31",
"isOpen": true
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested accounting periods were not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/balancesheet": {
"get": {
"tags": [
"Balance Sheet"
],
"summary": "Get balance sheet",
"description": "Retrieves the balance sheet report for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | 📞 Not supported / contact us |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetBalanceSheet",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "EndDate",
"in": "query",
"description": "End date for the balance sheet period. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T00:00:00Z"
},
"example": "2025-12-31T00:00:00Z"
},
{
"name": "Level",
"in": "query",
"description": "Heading level depth for the balance sheet. Range: 1-5.",
"schema": {
"maximum": 5,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested balance sheet.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceSheetDto"
},
"example": {
"accountBalancePeriod": {
"startDate": "2024-01-01",
"endDate": "2024-06-30"
},
"financialReport": {
"categories": [
{
"descriptions": [
{
"languageId": "ENG",
"text": "Asset"
}
],
"balance": {
"baseCurrencies": [
{
"currencyId": "SEK",
"baseAmount": 1000
}
]
},
"subCategories": []
}
]
}
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested balance sheet was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/companyinformation": {
"get": {
"tags": [
"Company Information"
],
"summary": "Get company information",
"description": "Retrieves company information for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetCompanyInformation",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested company information.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyInformationDto"
},
"example": {
"id": "550e8400-e29b-41d4-a716-446655440005",
"reference": "COMP-001",
"partyIdentification": [
{
"id": "SE123456789001",
"schemeId": "SE:ORGNR"
}
],
"partyName": {
"name": "Northwind Trading Ltd",
"languageId": "ENG"
},
"postalAddress": {
"buildingNumber": null,
"streetName": "Main Street 1",
"additionalStreetName": null,
"cityName": "Stockholm",
"postalZone": "111 22",
"country": {
"identificationCode": "SE",
"name": "Sweden"
}
},
"phone": "+46-8-123456",
"email": "info@northwind.example.com",
"fax": null,
"website": "https://northwind.example.com",
"partyLegalEntity": null,
"contacts": [],
"paymentMeans": []
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/customers": {
"get": {
"tags": [
"Customers"
],
"summary": "List customers",
"description": "Retrieves a paginated list of customers for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListCustomers",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Count",
"in": "query",
"description": "Number of records to return per page. Range: 1-100.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "CurrentPage",
"in": "query",
"description": "Page number to return. Must be 1 or greater.",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of customers for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440002",
"supplierAssignedAccountId": {
"id": "CUST-001",
"schemeId": "customerId"
},
"type": null,
"party": {
"partyIdentification": [],
"partyName": {
"name": "Acme Corp",
"languageId": "ENG"
},
"postalAddress": null,
"partyLegalEntity": null,
"contact": null,
"endpointId": null
},
"deliveryAddresses": [],
"description": null,
"financialDimensions": [],
"active": true,
"currency": "SEK",
"paymentMeans": []
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/customers/{customerId}": {
"get": {
"tags": [
"Customers"
],
"summary": "Get a customer by ID",
"description": "Retrieves a single customer by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetCustomer",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "customerId",
"in": "path",
"description": "The id of the customer you wish to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested customer.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
},
"example": {
"id": "550e8400-e29b-41d4-a716-446655440002",
"supplierAssignedAccountId": {
"id": "CUST-001",
"schemeId": "customerId"
},
"type": null,
"party": {
"partyIdentification": [],
"partyName": {
"name": "Acme Corp",
"languageId": "ENG"
},
"postalAddress": null,
"partyLegalEntity": null,
"contact": null,
"endpointId": null
},
"deliveryAddresses": [],
"description": null,
"financialDimensions": [],
"active": true,
"currency": "SEK",
"paymentMeans": []
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested customer was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/financialdimensions": {
"get": {
"tags": [
"Financial Dimensions"
],
"summary": "List financial dimensions",
"description": "Retrieves a paginated list of financial dimensions for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListFinancialDimensions",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Count",
"in": "query",
"description": "Number of records to return per page. Range: 1-100.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "CurrentPage",
"in": "query",
"description": "Page number to return. Must be 1 or greater.",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of financial dimensions for the specified consent.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FinancialDimensionDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialDimensionDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "66136193-425d-4ae4-b9f0-252cab5e822d",
"reference": "CC-001",
"type": "costCode",
"name": "CC1",
"description": "Cost center 1",
"isActive": true
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FinancialDimensionDtoPagedResultDto"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/incomestatement": {
"get": {
"tags": [
"Income Statement"
],
"summary": "Get income statement",
"description": "Retrieves the income statement for the specified consent and date range.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | 📞 Not supported / contact us |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetIncomeStatement",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "StartDate",
"in": "query",
"description": "Start date for the income statement period. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).\nIf omitted, defaults to the start of the current fiscal year.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-01-01T00:00:00Z"
},
"example": "2025-01-01T00:00:00Z"
},
{
"name": "EndDate",
"in": "query",
"description": "End date for the income statement period. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T00:00:00Z"
},
"example": "2025-12-31T00:00:00Z"
},
{
"name": "Level",
"in": "query",
"description": "Heading level depth for the income statement. Range: 1-5.",
"schema": {
"maximum": 5,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested income statement.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncomeStatementDto"
},
"example": {
"accountBalancePeriod": {
"startDate": "2024-03-01",
"endDate": "2024-06-30"
},
"financialReport": {
"categories": [
{
"descriptions": [
{
"languageId": "ENG",
"text": "Operating income"
}
],
"balance": {
"baseCurrencies": [
{
"currencyId": "SEK",
"baseAmount": 1000
}
]
},
"subCategories": []
}
]
},
"profitLossBalance": {
"baseCurrencies": [
{
"currencyId": "SEK",
"baseAmount": 1000
}
]
}
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested income statement was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/journals": {
"get": {
"tags": [
"Journals"
],
"summary": "List journals",
"description": "Retrieves a paginated list of journals for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListJournals",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Count",
"in": "query",
"description": "Number of records to return per page. Range: 1-100.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "CurrentPage",
"in": "query",
"description": "Page number to return. Must be 1 or greater.",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDate",
"in": "query",
"description": "Start date for the journal filter. Format: yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2025-01-01"
},
"example": "2025-01-01"
},
{
"name": "EndDate",
"in": "query",
"description": "End date for the journal filter. Format: yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2025-12-31"
},
"example": "2025-12-31"
},
{
"name": "OrderBy",
"in": "query",
"description": "Sort order for the results.",
"schema": {
"enum": [
"DateDescending",
"DateAscending"
],
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of journals for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440004",
"reference": "J-001",
"transactionDate": "2024-01-01",
"accountingSeries": {
"id": "series-1",
"accountingSeriesId": "GJ"
},
"description": {
"text": "January revenue entry",
"languageId": "ENG"
},
"financialDimensions": [
{
"id": "97c88337-ef68-46d1-a66d-60276dc31016",
"reference": "CC-1",
"type": "costCode",
"name": null,
"description": null,
"isActive": null
}
],
"accountingEntries": [
{
"description": {
"text": "Sales revenue",
"languageId": "ENG"
},
"accountingAccount": {
"id": "3001",
"accountingAccountId": "3001",
"reference": "3001",
"standardAccountingAccountId": null,
"name": "Sales",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Sales revenue"
},
"descriptions": [],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"debitAmount": {
"amount": 1000,
"currencyId": "SEK"
},
"creditAmount": {
"amount": 0,
"currencyId": "SEK"
},
"financialDimensions": []
},
{
"description": {
"text": "Bank",
"languageId": "ENG"
},
"accountingAccount": {
"id": "1920",
"accountingAccountId": "1920",
"reference": "1920",
"standardAccountingAccountId": null,
"name": "Bank",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Main bank account"
},
"descriptions": [],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"debitAmount": {
"amount": 0,
"currencyId": "SEK"
},
"creditAmount": {
"amount": 1000,
"currencyId": "SEK"
},
"financialDimensions": []
}
]
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
},
"post": {
"tags": [
"Journals"
],
"summary": "Create a journal",
"description": "Creates a new journal entry for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateJournal",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Journal entity.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateJournalDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateJournalDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateJournalDto"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The journal was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
}
},
"400": {
"description": "The request body or parameters are invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"errors": {
"fieldName": [
"Validation error message."
]
}
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/journals/{journalId}": {
"get": {
"tags": [
"Journals"
],
"summary": "Get a journal by ID",
"description": "Retrieves a single journal by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | ✅ Supported |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetJournal",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "journalId",
"in": "path",
"description": "The id of the journal you wish to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested journal.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalDto"
},
"example": {
"id": "550e8400-e29b-41d4-a716-446655440004",
"reference": "J-001",
"transactionDate": "2024-01-01",
"accountingSeries": {
"id": "series-1",
"accountingSeriesId": "GJ"
},
"description": {
"text": "January revenue entry",
"languageId": "ENG"
},
"financialDimensions": [
{
"id": "97c88337-ef68-46d1-a66d-60276dc31016",
"reference": "CC-1",
"type": "costCode",
"name": null,
"description": null,
"isActive": null
}
],
"accountingEntries": [
{
"description": {
"text": "Sales revenue",
"languageId": "ENG"
},
"accountingAccount": {
"id": "3001",
"accountingAccountId": "3001",
"reference": "3001",
"standardAccountingAccountId": null,
"name": "Sales",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Sales revenue"
},
"descriptions": [],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"debitAmount": {
"amount": 1000,
"currencyId": "SEK"
},
"creditAmount": {
"amount": 0,
"currencyId": "SEK"
},
"financialDimensions": []
},
{
"description": {
"text": "Bank",
"languageId": "ENG"
},
"accountingAccount": {
"id": "1920",
"accountingAccountId": "1920",
"reference": "1920",
"standardAccountingAccountId": null,
"name": "Bank",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Main bank account"
},
"descriptions": [],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"debitAmount": {
"amount": 0,
"currencyId": "SEK"
},
"creditAmount": {
"amount": 1000,
"currencyId": "SEK"
},
"financialDimensions": []
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested journal was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/journals/{journalId}/attachments/{attachmentId}": {
"get": {
"tags": [
"Journals - Attachments"
],
"summary": "Get a journal attachment by ID",
"description": "Retrieves a single journal attachment by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetJournalAttachment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "journalId",
"in": "path",
"description": "The id of the journal you wish to retrieve attachment for.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "The id of the attachment you wish to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"description": "File content (e.g. PDF or image). Actual Content-Type is in the response headers.",
"format": "binary"
}
},
"application/pdf": {
"schema": {
"type": "string",
"description": "PDF file content when the attachment is a PDF.",
"format": "binary"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "The requested journal attachment was not found.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/journals/{journalId}/attachments": {
"post": {
"tags": [
"Journals - Attachments"
],
"summary": "Create a journal attachment",
"description": "Creates a new attachment for the specified journal.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateJournalAttachment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "journalId",
"in": "path",
"description": "The journal for which you wish to create an attachment.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"attachment": {
"type": "string",
"description": "Attachment file.",
"format": "binary"
}
}
},
"encoding": {
"attachment": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "The journal attachment was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
}
},
"400": {
"description": "The request body or parameters are invalid.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"errors": {
"fieldName": [
"Validation error message."
]
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/proxy/{*systemUrl}": {
"get": {
"tags": [
"Proxy.1"
],
"summary": "Proxy request to accounting system",
"description": "Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "ProxyRequest_GET",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "*systemUrl",
"in": "path",
"description": "The URL of the accounting system endpoint to proxy the request to.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"post": {
"tags": [
"Proxy.1"
],
"summary": "Proxy request to accounting system",
"description": "Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "ProxyRequest_POST",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "*systemUrl",
"in": "path",
"description": "The URL of the accounting system endpoint to proxy the request to.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"Proxy.1"
],
"summary": "Proxy request to accounting system",
"description": "Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "ProxyRequest_PUT",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "*systemUrl",
"in": "path",
"description": "The URL of the accounting system endpoint to proxy the request to.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"patch": {
"tags": [
"Proxy.1"
],
"summary": "Proxy request to accounting system",
"description": "Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "ProxyRequest_PATCH",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "*systemUrl",
"in": "path",
"description": "The URL of the accounting system endpoint to proxy the request to.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"Proxy.1"
],
"summary": "Proxy request to accounting system",
"description": "Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | ✅ Supported |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "ProxyRequest_DELETE",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "*systemUrl",
"in": "path",
"description": "The URL of the accounting system endpoint to proxy the request to.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices": {
"get": {
"tags": [
"Sales Invoices"
],
"summary": "List sales invoices",
"description": "Retrieves a paginated list of sales invoices for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "ListSalesInvoices",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Count",
"in": "query",
"description": "Number of records to return per page. Range: 1-100.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "CurrentPage",
"in": "query",
"description": "Page number to return. Must be 1 or greater.",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "FromInvoiceDate",
"in": "query",
"description": "Start invoice issue date filter. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-01-01T00:00:00Z"
},
"example": "2025-01-01T00:00:00Z"
},
{
"name": "ToInvoiceDate",
"in": "query",
"description": "End invoice issue date filter. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T00:00:00Z"
},
"example": "2025-12-31T00:00:00Z"
},
{
"name": "CreatedDateTime",
"in": "query",
"description": "Return invoices created on or after this date and time. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-01-01T00:00:00Z"
},
"example": "2025-01-01T00:00:00Z"
},
{
"name": "ModifiedDateTime",
"in": "query",
"description": "Return invoices modified on or after this date and time. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-01-01T00:00:00Z"
},
"example": "2025-01-01T00:00:00Z"
},
{
"name": "OrderBy",
"in": "query",
"description": "Sort order for the results.",
"schema": {
"enum": [
"DateDescending",
"DateAscending"
],
"type": "string"
}
},
{
"name": "Status",
"in": "query",
"description": "The status to filter invoices by.\n \nLegend:\n- ✅ = Supported\n- ⛔ = Not supported\n \n| System | Paid | Unpaid | Overdue | Cancelled | Unbooked | Unsent | Draft |\n|-|-|-|-|-|-|-|-|\n| Fortnox | ✅ | ✅ | ✅ | ✅ | ✅ | ⛔ | ✅ |\n| Bjorn Lunden | ✅ | ✅ | ✅ | ✅ | ⛔ | ⛔ | ⛔ |\n| Spiris | ✅ | ✅ | ✅ | ⛔ | ⛔ | ⛔ | ✅ |\n| Tripletex | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Visma e-conomic | ✅ | ✅ | ✅ | ⛔ | ⛔ | ⛔ | ✅ |\n| Billy | ✅ | ✅ | ⛔ | ⛔ | ⛔ | ⛔ | ✅ |\n| Visma Dinero | ✅ | ⛔ | ✅ | ⛔ | ⛔ | ⛔ | ✅ |\n| Procountor | ✅ | ⛔ | ⛔ | ⛔ | ⛔ | ✅ | ✅ |\n| Visma Netvisor | ✅ | ✅ | ✅ | ✅ | ⛔ | ✅ | ⛔ |\n| Microsoft Business Central | ✅ | ✅ | ⛔ | ✅ | ⛔ | ⛔ | ✅ |\n| Bokio | ✅ | ✅ | ✅ | ⛔ | ⛔ | ⛔ | ✅ |\n| FileOne | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |",
"schema": {
"enum": [
"Paid",
"Unpaid",
"Overdue",
"Cancelled",
"Unbooked",
"Unsent",
"Draft"
],
"type": "string"
}
},
{
"name": "Include",
"in": "query",
"description": "Comma-separated list of optional data to include in the response.\n \nAvailable values:\n1. `paymentStatus` — Include the payment status.\n2. `paymentTerms` — Include the payment terms.",
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of sales invoices for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SalesInvoiceSummaryDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "INV-001",
"reference": "INV-001",
"dueDate": "2024-04-15",
"issueDate": "2024-03-15",
"createdDateTime": "2024-03-15T09:00:00Z",
"modifiedDateTime": "2024-03-15T09:00:00Z",
"isSent": false,
"accountingCustomerParty": {
"supplierAssignedAccountId": {
"id": "CUST-001",
"schemeId": "customerId"
},
"party": {
"partyIdentification": [],
"partyName": {
"name": "Acme Corp",
"languageId": "ENG"
},
"partyLegalEntity": null
}
},
"paymentTerms": {
"paymentTermsId": {
"id": "30",
"schemeId": null
},
"notes": [
{
"text": "Net 30 days",
"languageId": "ENG"
}
]
},
"notes": [
{
"text": "Thank you for your business",
"languageId": "ENG"
}
],
"totalBalanceAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"legalMonetaryTotal": {
"taxInclusiveAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"prepaidAmount": {
"amount": 0,
"currencyId": "SEK"
},
"payableRoundingAmount": {
"amount": 0,
"currencyId": "SEK"
},
"payableAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"taxExclusiveAmount": {
"amount": 1000,
"currencyId": "SEK"
},
"lineExtensionAmount": {
"amount": 1000,
"currencyId": "SEK"
}
},
"paymentStatus": {
"status": "UNPAID"
}
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
},
"post": {
"tags": [
"Sales Invoices"
],
"summary": "Post a sales invoice",
"description": "Creates a new sales invoice for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | 📞 Not supported / contact us |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateSalesInvoice",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The sales invoice to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SalesInvoiceInputDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SalesInvoiceInputDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SalesInvoiceInputDto"
}
}
}
},
"responses": {
"201": {
"description": "The sales invoice was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SalesInvoiceDto"
},
"example": {
"id": "550e8400-e29b-41d4-a716-446655440006",
"reference": "INV-001",
"buyerReference": "PO-2024-001",
"bookedInvoiceIndicator": true,
"cancelledInvoiceIndicator": false,
"issueDate": "2024-03-15",
"issueTime": "09:00:00",
"dueDate": "2024-04-15",
"creditInvoice": {
"creditInvoiceIndicator": false,
"creditInvoiceDocumentReferences": []
},
"financialDimensions": [],
"notes": [
{
"text": "Thank you for your business",
"languageId": "ENG"
}
],
"orderReference": {
"buyerOrderId": "PO-2024-001",
"sellerOrderId": "ORD-2024-001"
},
"documentCurrencyCode": {
"currency": "SEK",
"currencyId": "SEK",
"currencyRate": 1.0
},
"accountingSupplierParty": null,
"accountingCustomerParty": {
"supplierAssignedAccountId": {
"id": "CUST-001",
"schemeId": "customerId"
},
"party": {
"partyIdentification": [],
"partyName": {
"name": "Acme Corp",
"languageId": "ENG"
},
"postalAddress": null,
"partyLegalEntity": null,
"contact": null,
"endpointId": null
},
"type": null
},
"invoicePeriod": {
"startDate": "2024-03-01",
"endDate": "2024-03-31"
},
"delivery": null,
"deliveryTerms": null,
"paymentTerms": null,
"paymentMeans": [],
"allowanceCharges": [],
"taxTotals": [
{
"taxAmount": {
"amount": 250,
"currencyId": "SEK"
},
"taxIncludedIndicator": true
}
],
"withholdingTaxTotals": [],
"totalBalanceAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"additionalDocumentReferences": [],
"legalMonetaryTotal": {
"taxInclusiveAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"prepaidAmount": {
"amount": 0,
"currencyId": "SEK"
},
"payableRoundingAmount": {
"amount": 0,
"currencyId": "SEK"
},
"payableAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"lineExtensionAmount": {
"amount": 1000,
"currencyId": "SEK"
},
"taxExclusiveAmount": {
"amount": 1000,
"currencyId": "SEK"
}
},
"paymentStatus": {
"status": "UNPAID",
"settlementDate": "2024-04-15"
},
"isSent": false,
"sellerReference": "INV-001",
"isSold": false,
"reminder": null,
"invoiceLines": []
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}": {
"get": {
"tags": [
"Sales Invoices"
],
"summary": "Get a sales invoice by ID",
"description": "Retrieves a single sales invoice by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "GetSalesInvoice",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Include",
"in": "query",
"description": "Comma-separated list of optional data to include in the response.\n \nAvailable values:\n1. `paymentStatus` — Include the payment status.",
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested sales invoice.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SalesInvoiceDto"
},
"example": {
"id": "550e8400-e29b-41d4-a716-446655440006",
"reference": "INV-001",
"buyerReference": "PO-2024-001",
"bookedInvoiceIndicator": true,
"cancelledInvoiceIndicator": false,
"issueDate": "2024-03-15",
"issueTime": "09:00:00",
"dueDate": "2024-04-15",
"creditInvoice": {
"creditInvoiceIndicator": false,
"creditInvoiceDocumentReferences": []
},
"financialDimensions": [],
"notes": [
{
"text": "Thank you for your business",
"languageId": "ENG"
}
],
"orderReference": {
"buyerOrderId": "PO-2024-001",
"sellerOrderId": "ORD-2024-001"
},
"documentCurrencyCode": {
"currency": "SEK",
"currencyId": "SEK",
"currencyRate": 1.0
},
"accountingSupplierParty": null,
"accountingCustomerParty": {
"supplierAssignedAccountId": {
"id": "CUST-001",
"schemeId": "customerId"
},
"party": {
"partyIdentification": [],
"partyName": {
"name": "Acme Corp",
"languageId": "ENG"
},
"postalAddress": null,
"partyLegalEntity": null,
"contact": null,
"endpointId": null
},
"type": null
},
"invoicePeriod": {
"startDate": "2024-03-01",
"endDate": "2024-03-31"
},
"delivery": null,
"deliveryTerms": null,
"paymentTerms": null,
"paymentMeans": [],
"allowanceCharges": [],
"taxTotals": [
{
"taxAmount": {
"amount": 250,
"currencyId": "SEK"
},
"taxIncludedIndicator": true
}
],
"withholdingTaxTotals": [],
"totalBalanceAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"additionalDocumentReferences": [],
"legalMonetaryTotal": {
"taxInclusiveAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"prepaidAmount": {
"amount": 0,
"currencyId": "SEK"
},
"payableRoundingAmount": {
"amount": 0,
"currencyId": "SEK"
},
"payableAmount": {
"amount": 1250,
"currencyId": "SEK"
},
"lineExtensionAmount": {
"amount": 1000,
"currencyId": "SEK"
},
"taxExclusiveAmount": {
"amount": 1000,
"currencyId": "SEK"
}
},
"paymentStatus": {
"status": "UNPAID",
"settlementDate": "2024-04-15"
},
"isSent": false,
"sellerReference": "INV-001",
"isSold": false,
"reminder": null,
"invoiceLines": []
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested sales invoice was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/attachments": {
"get": {
"tags": [
"Sales Invoices - Attachments"
],
"summary": "List attachments for a sales invoice",
"description": "Retrieves a paginated list of attachments for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "ListSalesInvoiceAttachments",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of sales invoice attachments for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceAttachmentDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440003",
"invoiceId": "INV-001",
"type": "Attachment",
"fileName": "invoice.pdf"
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested sales invoice was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
},
"post": {
"tags": [
"Sales Invoices - Attachments"
],
"summary": "Create an attachment for a sales invoice",
"description": "Creates a new attachment for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateSalesInvoiceAttachment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"attachment"
],
"type": "object",
"properties": {
"attachment": {
"type": "string",
"description": "Attachment file entity.",
"format": "binary"
}
}
},
"encoding": {
"attachment": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "The sales invoice attachment was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
}
},
"400": {
"description": "The request body or parameters are invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"errors": {
"fieldName": [
"Validation error message."
]
}
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/attachments/{attachmentId}": {
"get": {
"tags": [
"Sales Invoices - Attachments"
],
"summary": "Get an attachment for a sales invoice by attachment ID",
"description": "Retrieves a specific attachment file for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | ✅ Supported |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "GetSalesInvoiceAttachment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "Identifier of the attachment.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"description": "File content (e.g. PDF or image). Actual Content-Type is in the response headers.",
"format": "binary"
}
},
"application/pdf": {
"schema": {
"type": "string",
"description": "PDF file content when the attachment is a PDF.",
"format": "binary"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested sales invoice attachment was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/attachments/printable": {
"get": {
"tags": [
"Sales Invoices - Attachments"
],
"summary": "Get a printable sales invoice",
"description": "Retrieves a printable version of the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | ✅ Supported |\n| QuickBooks | ✅ Supported |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |",
"operationId": "GetPrintableSalesInvoice",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"description": "File content (e.g. PDF or image). Actual Content-Type is in the response headers.",
"format": "binary"
}
},
"application/pdf": {
"schema": {
"type": "string",
"description": "PDF file content when the attachment is a PDF.",
"format": "binary"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested sales invoice was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/notes": {
"post": {
"tags": [
"Sales Invoices - Notes"
],
"summary": "Add a note to a sales invoice",
"description": "Adds a note to the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | 📞 Not supported / contact us |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | 📞 Not supported / contact us |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateSalesInvoiceNote",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The note to add to the sales invoice.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSalesInvoiceNoteDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateSalesInvoiceNoteDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateSalesInvoiceNoteDto"
}
}
}
},
"responses": {
"201": {
"description": "The sales invoice note was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested sales invoice was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices/payments": {
"get": {
"tags": [
"Sales Invoices - Payments"
],
"summary": "List sales invoices payments",
"description": "Retrieves a paginated list of all sales invoice payments for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ⛔ Can't be supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListSalesInvoicePayments",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of sales invoice payments for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicePaymentDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "59",
"paymentId": "59",
"reference": "PAY-59",
"receivedDate": "2022-06-01",
"paidDate": "2022-06-01",
"bookedIndicator": true,
"bookedDate": "2022-06-02",
"accountingAccount": {
"id": "5233",
"accountingAccountId": "5233",
"reference": "5233",
"standardAccountingAccountId": null,
"name": "Bank account",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Main bank"
},
"descriptions": [
{
"languageId": "ENG",
"text": "Main bank"
}
],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"status": null,
"billingReferences": [
{
"invoiceDocumentReferences": [
{
"id": "INV-001",
"schemeId": "invoiceId"
}
]
}
],
"documentCurrencyCode": {
"currency": "DKK",
"currencyId": "DKK",
"currencyRate": 1.0
},
"amount": 500,
"creditAmount": {
"amount": 500,
"currencyId": "DKK"
},
"debitAmount": {
"amount": 0,
"currencyId": "DKK"
}
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/payments": {
"post": {
"tags": [
"Sales Invoices - Payments"
],
"summary": "Create a sales invoice payment",
"description": "Creates a new payment for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | ✅ Supported |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateSalesInvoicePayment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The sales invoice payment to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSalesInvoicePaymentDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateSalesInvoicePaymentDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateSalesInvoicePaymentDto"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The sales invoice payment was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
}
},
"400": {
"description": "The request body or parameters are invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"errors": {
"fieldName": [
"Validation error message."
]
}
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
},
"get": {
"tags": [
"Sales Invoices - Payments"
],
"summary": "List payments from a single sales invoice",
"description": "Retrieves a paginated list of payments for a specific sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListSalesInvoicePaymentsByInvoice",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "salesInvoiceId",
"in": "path",
"description": "Identifier of the sales invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of sales invoice payments for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicePaymentDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "59",
"paymentId": "59",
"reference": "PAY-59",
"receivedDate": "2022-06-01",
"paidDate": "2022-06-01",
"bookedIndicator": true,
"bookedDate": "2022-06-02",
"accountingAccount": {
"id": "5233",
"accountingAccountId": "5233",
"reference": "5233",
"standardAccountingAccountId": null,
"name": "Bank account",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Main bank"
},
"descriptions": [
{
"languageId": "ENG",
"text": "Main bank"
}
],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"status": null,
"billingReferences": [
{
"invoiceDocumentReferences": [
{
"id": "INV-001",
"schemeId": "invoiceId"
}
]
}
],
"documentCurrencyCode": {
"currency": "DKK",
"currencyId": "DKK",
"currencyRate": 1.0
},
"amount": 500,
"creditAmount": {
"amount": 500,
"currencyId": "DKK"
},
"debitAmount": {
"amount": 0,
"currencyId": "DKK"
}
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/supplierinvoices": {
"get": {
"tags": [
"Supplier Invoices"
],
"summary": "List supplier invoices",
"description": "Retrieves a paginated list of supplier invoices for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListSupplierInvoices",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Count",
"in": "query",
"description": "Number of records to return per page. Range: 1-100.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "CurrentPage",
"in": "query",
"description": "Page number to return. Must be 1 or greater.",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "FromInvoiceDate",
"in": "query",
"description": "Start invoice issue date filter. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-01-01T00:00:00Z"
},
"example": "2025-01-01T00:00:00Z"
},
{
"name": "ToInvoiceDate",
"in": "query",
"description": "End invoice issue date filter. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-12-31T00:00:00Z"
},
"example": "2025-12-31T00:00:00Z"
},
{
"name": "ModifiedDateTime",
"in": "query",
"description": "Return invoices modified on or after this date and time. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).",
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-01-01T00:00:00Z"
},
"example": "2025-01-01T00:00:00Z"
},
{
"name": "OrderBy",
"in": "query",
"description": "Sort order for the results.",
"schema": {
"enum": [
"DateDescending",
"DateAscending"
],
"type": "string"
}
},
{
"name": "Status",
"in": "query",
"description": "The status to filter invoices by.\n \nStatus filtering support per system is shown below.\n \nLegend:\n- ✅ = Supported\n- ⛔ = Not supported\n \n| System | IsSold | Paid | Unpaid | Overdue | Cancelled | Unsent |\n|-|-|-|-|-|-|-|\n| Fortnox | ⛔ | ✅ | ✅ | ✅ | ✅ | ⛔ |\n| Bjorn Lunden | ⛔ | ⛔ | ✅ | ✅ | ⛔ | ⛔ |\n| Spiris | ⛔ | ✅ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Tripletex | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Visma e-conomic | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Billy | ⛔ | ✅ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Visma Dinero | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Procountor | ⛔ | ✅ | ⛔ | ⛔ | ✅ | ✅ |\n| Visma Netvisor | ⛔ | ✅ | ✅ | ⛔ | ⛔ | ⛔ |\n| Microsoft Business Central | ⛔ | ✅ | ✅ | ⛔ | ✅ | ⛔ |\n| FileOne | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |",
"schema": {
"enum": [
"IsSold",
"Paid",
"Unpaid",
"Overdue",
"Cancelled",
"Unsent"
],
"type": "string"
}
},
{
"name": "Include",
"in": "query",
"description": "Comma-separated list of optional data to include in the response.\n \nAvailable values:\n1. `paymentStatus` — Include the payment status.",
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of supplier invoices for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceSummaryDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "SINV-001",
"reference": "SINV-001",
"dueDate": "2024-04-15",
"issueDate": "2024-03-15",
"createdDateTime": "2024-03-15T10:00:00Z",
"modifiedDateTime": "2024-03-16T14:30:00Z",
"accountingSupplierParty": {
"customerAssignedAccountId": {
"id": "SUP-10001",
"schemeId": "supplierId"
},
"party": {
"partyName": {
"name": "Office Supplies Ltd",
"languageId": "ENG"
}
}
},
"notes": [
{
"text": "Office supplies order #4521",
"languageId": "ENG"
}
],
"totalBalanceAmount": {
"amount": 1000,
"currencyId": "DKK"
},
"legalMonetaryTotal": {
"taxInclusiveAmount": {
"amount": 1000,
"currencyId": "DKK"
},
"prepaidAmount": {
"amount": 0,
"currencyId": "DKK"
},
"payableRoundingAmount": {
"amount": 0,
"currencyId": "DKK"
},
"payableAmount": {
"amount": 1000,
"currencyId": "DKK"
},
"taxExclusiveAmount": {
"amount": 800,
"currencyId": "DKK"
},
"lineExtensionAmount": {
"amount": 800,
"currencyId": "DKK"
}
},
"paymentStatus": {
"status": "UNPAID"
}
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
},
"post": {
"tags": [
"Supplier Invoices"
],
"summary": "Create a supplier invoice",
"description": "Creates a new supplier invoice in the connected accounting system.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | 📞 Not supported / contact us |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateSupplierInvoice",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Supplier invoice entity.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceInputDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceInputDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceInputDto"
}
}
}
},
"responses": {
"201": {
"description": "The supplier invoice was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceDto"
},
"example": {
"id": "550e8400-e29b-41d4-a716-446655440007",
"reference": "SINV-001",
"buyerReference": "PO-4521",
"bookedInvoiceIndicator": false,
"cancelledInvoiceIndicator": false,
"issueDate": "2024-03-05",
"issueTime": "10:30:00",
"dueDate": "2024-04-05",
"creditInvoice": {
"creditInvoiceIndicator": false,
"creditInvoiceDocumentReferences": []
},
"financialDimensions": [],
"notes": [
{
"text": "Office supplies order #4521",
"languageId": "ENG"
}
],
"orderReference": {
"buyerOrderId": "PO-4521",
"sellerOrderId": null
},
"documentCurrencyCode": {
"currency": "USD",
"currencyId": "USD",
"currencyRate": 1.0
},
"accountingSupplierParty": {
"customerAssignedAccountId": {
"id": "SUP1",
"schemeId": "supplierId"
},
"party": {
"partyIdentification": [],
"partyName": {
"name": "Supplier Inc",
"languageId": "ENG"
},
"postalAddress": {
"buildingNumber": null,
"streetName": "Supplier Street 1",
"additionalStreetName": null,
"cityName": "New York",
"postalZone": "10001",
"country": {
"identificationCode": "US",
"name": "United States"
}
},
"partyLegalEntity": null,
"contact": null,
"endpointId": null
}
},
"accountingCustomerParty": null,
"invoicePeriod": {
"startDate": "2024-03-01",
"endDate": "2024-03-31"
},
"delivery": {
"actualDeliveryDate": "2024-03-04"
},
"deliveryTerms": null,
"paymentTerms": null,
"paymentMeans": [],
"allowanceCharges": [],
"taxTotals": [
{
"taxAmount": {
"amount": 200,
"currencyId": "USD"
},
"taxIncludedIndicator": true
}
],
"withholdingTaxTotals": [],
"legalMonetaryTotal": {
"taxInclusiveAmount": {
"amount": 1000,
"currencyId": "USD"
},
"prepaidAmount": {
"amount": 0,
"currencyId": "USD"
},
"payableRoundingAmount": {
"amount": 0,
"currencyId": "USD"
},
"payableAmount": {
"amount": 1000,
"currencyId": "USD"
},
"lineExtensionAmount": {
"amount": 800,
"currencyId": "USD"
},
"taxExclusiveAmount": {
"amount": 800,
"currencyId": "USD"
}
},
"totalBalanceAmount": {
"amount": 1000,
"currencyId": "USD"
},
"additionalDocumentReferences": [],
"paymentStatus": {
"status": "UNPAID",
"settlementDate": "2024-04-15"
},
"invoiceLines": [],
"sellerReference": "SINV-001"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/supplierinvoices/{supplierInvoiceId}": {
"get": {
"tags": [
"Supplier Invoices"
],
"summary": "Get a supplier invoice by ID",
"description": "Retrieves a single supplier invoice by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | ✅ Supported |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetSupplierInvoice",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Include",
"in": "query",
"description": "Comma-separated list of optional data to include in the response.\n \nAvailable values:\n1. `paymentStatus` — Include the payment status.",
"schema": {
"type": "string"
}
},
{
"name": "supplierInvoiceId",
"in": "path",
"description": "Identifier of the supplier invoice.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested supplier invoice.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierInvoiceDto"
},
"example": {
"id": "550e8400-e29b-41d4-a716-446655440007",
"reference": "SINV-001",
"buyerReference": "PO-4521",
"bookedInvoiceIndicator": false,
"cancelledInvoiceIndicator": false,
"issueDate": "2024-03-05",
"issueTime": "10:30:00",
"dueDate": "2024-04-05",
"creditInvoice": {
"creditInvoiceIndicator": false,
"creditInvoiceDocumentReferences": []
},
"financialDimensions": [],
"notes": [
{
"text": "Office supplies order #4521",
"languageId": "ENG"
}
],
"orderReference": {
"buyerOrderId": "PO-4521",
"sellerOrderId": null
},
"documentCurrencyCode": {
"currency": "USD",
"currencyId": "USD",
"currencyRate": 1.0
},
"accountingSupplierParty": {
"customerAssignedAccountId": {
"id": "SUP1",
"schemeId": "supplierId"
},
"party": {
"partyIdentification": [],
"partyName": {
"name": "Supplier Inc",
"languageId": "ENG"
},
"postalAddress": {
"buildingNumber": null,
"streetName": "Supplier Street 1",
"additionalStreetName": null,
"cityName": "New York",
"postalZone": "10001",
"country": {
"identificationCode": "US",
"name": "United States"
}
},
"partyLegalEntity": null,
"contact": null,
"endpointId": null
}
},
"accountingCustomerParty": null,
"invoicePeriod": {
"startDate": "2024-03-01",
"endDate": "2024-03-31"
},
"delivery": {
"actualDeliveryDate": "2024-03-04"
},
"deliveryTerms": null,
"paymentTerms": null,
"paymentMeans": [],
"allowanceCharges": [],
"taxTotals": [
{
"taxAmount": {
"amount": 200,
"currencyId": "USD"
},
"taxIncludedIndicator": true
}
],
"withholdingTaxTotals": [],
"legalMonetaryTotal": {
"taxInclusiveAmount": {
"amount": 1000,
"currencyId": "USD"
},
"prepaidAmount": {
"amount": 0,
"currencyId": "USD"
},
"payableRoundingAmount": {
"amount": 0,
"currencyId": "USD"
},
"payableAmount": {
"amount": 1000,
"currencyId": "USD"
},
"lineExtensionAmount": {
"amount": 800,
"currencyId": "USD"
},
"taxExclusiveAmount": {
"amount": 800,
"currencyId": "USD"
}
},
"totalBalanceAmount": {
"amount": 1000,
"currencyId": "USD"
},
"additionalDocumentReferences": [],
"paymentStatus": {
"status": "UNPAID",
"settlementDate": "2024-04-15"
},
"invoiceLines": [],
"sellerReference": "SINV-001"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested supplier invoice was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/supplierinvoices/{supplierInvoiceId}/attachments/{attachmentId}": {
"get": {
"tags": [
"Supplier Invoices - Attachments"
],
"summary": "Get a supplier invoice attachment",
"description": "Downloads a supplier invoice attachment file by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | 📞 Not supported / contact us |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetSupplierInvoiceAttachment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "supplierInvoiceId",
"in": "path",
"description": "Identifier of the supplier invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attachmentId",
"in": "path",
"description": "Identifier of the attachment.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"description": "File content (e.g. PDF or image). Actual Content-Type is in the response headers.",
"format": "binary"
}
},
"application/pdf": {
"schema": {
"type": "string",
"description": "PDF file content when the attachment is a PDF.",
"format": "binary"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested supplier invoice attachment was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/supplierinvoices/{supplierInvoiceId}/attachments/printable": {
"get": {
"tags": [
"Supplier Invoices - Attachments"
],
"summary": "Get a printable supplier invoice attachment",
"description": "Retrieves a printable attachment for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | 📞 Not supported / contact us |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetPrintableSupplierInvoiceAttachment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "supplierInvoiceId",
"in": "path",
"description": "Identifier of the supplier invoice.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"description": "File content (e.g. PDF or image). Actual Content-Type is in the response headers.",
"format": "binary"
}
},
"application/pdf": {
"schema": {
"type": "string",
"description": "PDF file content when the attachment is a PDF.",
"format": "binary"
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested supplier invoice was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/supplierinvoices/{supplierInvoiceId}/attachments": {
"post": {
"tags": [
"Supplier Invoices - Attachments"
],
"summary": "Create a supplier invoice attachment",
"description": "Uploads and creates a new attachment for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateSupplierInvoiceAttachment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "supplierInvoiceId",
"in": "path",
"description": "Identifier of the supplier invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"attachment"
],
"type": "object",
"properties": {
"attachment": {
"type": "string",
"description": "Attachment file entity.",
"format": "binary"
}
}
},
"encoding": {
"attachment": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "The supplier invoice attachment was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
}
},
"400": {
"description": "The request body or parameters are invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"errors": {
"fieldName": [
"Validation error message."
]
}
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
},
"get": {
"tags": [
"Supplier Invoices - Attachments"
],
"summary": "List supplier invoice attachments",
"description": "Retrieves a paginated list of attachments for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | 📞 Not supported / contact us |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListSupplierInvoiceAttachments",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "supplierInvoiceId",
"in": "path",
"description": "Identifier of the supplier invoice.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of supplier invoice attachments for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceAttachmentDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440003",
"invoiceId": "INV-001",
"type": "Attachment",
"fileName": "invoice.pdf"
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested supplier invoice attachment was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/supplierinvoices/payments": {
"get": {
"tags": [
"Supplier Invoices - Payments"
],
"summary": "List payments from supplier invoices",
"description": "Retrieves a paginated list of payments across all supplier invoices for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListSupplierInvoicePayments",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of supplier invoice payments for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicePaymentDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "59",
"paymentId": "59",
"reference": "PAY-59",
"receivedDate": "2022-06-01",
"paidDate": "2022-06-01",
"bookedIndicator": true,
"bookedDate": "2022-06-02",
"accountingAccount": {
"id": "5233",
"accountingAccountId": "5233",
"reference": "5233",
"standardAccountingAccountId": null,
"name": "Bank account",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Main bank"
},
"descriptions": [
{
"languageId": "ENG",
"text": "Main bank"
}
],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"status": null,
"billingReferences": [
{
"invoiceDocumentReferences": [
{
"id": "INV-001",
"schemeId": "invoiceId"
}
]
}
],
"documentCurrencyCode": {
"currency": "DKK",
"currencyId": "DKK",
"currencyRate": 1.0
},
"amount": 500,
"creditAmount": {
"amount": 500,
"currencyId": "DKK"
},
"debitAmount": {
"amount": 0,
"currencyId": "DKK"
}
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/supplierinvoices/{supplierInvoiceId}/payments": {
"get": {
"tags": [
"Supplier Invoices - Payments"
],
"summary": "List payments from a single supplier invoice",
"description": "Retrieves a paginated list of payments for a specific supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListSupplierInvoicePaymentsByInvoice",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "supplierInvoiceId",
"in": "path",
"description": "Identifier of the supplier invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of supplier invoice payments for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicePaymentDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "59",
"paymentId": "59",
"reference": "PAY-59",
"receivedDate": "2022-06-01",
"paidDate": "2022-06-01",
"bookedIndicator": true,
"bookedDate": "2022-06-02",
"accountingAccount": {
"id": "5233",
"accountingAccountId": "5233",
"reference": "5233",
"standardAccountingAccountId": null,
"name": "Bank account",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Main bank"
},
"descriptions": [
{
"languageId": "ENG",
"text": "Main bank"
}
],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"status": null,
"billingReferences": [
{
"invoiceDocumentReferences": [
{
"id": "INV-001",
"schemeId": "invoiceId"
}
]
}
],
"documentCurrencyCode": {
"currency": "DKK",
"currencyId": "DKK",
"currencyRate": 1.0
},
"amount": 500,
"creditAmount": {
"amount": 500,
"currencyId": "DKK"
},
"debitAmount": {
"amount": 0,
"currencyId": "DKK"
}
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
},
"post": {
"tags": [
"Supplier Invoices - Payments"
],
"summary": "Create a supplier invoice payment",
"description": "Creates a new payment for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "CreateSupplierInvoicePayment",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "supplierInvoiceId",
"in": "path",
"description": "Identifier of the supplier invoice.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Supplier invoice payment entity.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSupplierInvoicePaymentDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateSupplierInvoicePaymentDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateSupplierInvoicePaymentDto"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The supplier invoice payment was created. Response includes a Location header with the URL of the created resource.",
"headers": {
"Location": {
"description": "URL of the created resource.",
"schema": {
"type": "string",
"format": "uri-reference"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicePaymentDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "59",
"paymentId": "59",
"reference": "PAY-59",
"receivedDate": "2022-06-01",
"paidDate": "2022-06-01",
"bookedIndicator": true,
"bookedDate": "2022-06-02",
"accountingAccount": {
"id": "5233",
"accountingAccountId": "5233",
"reference": "5233",
"standardAccountingAccountId": null,
"name": "Bank account",
"active": null,
"postable": null,
"description": {
"languageId": "ENG",
"text": "Main bank"
},
"descriptions": [
{
"languageId": "ENG",
"text": "Main bank"
}
],
"accountingAccountTypeCode": null,
"financialDimensions": []
},
"status": null,
"billingReferences": [
{
"invoiceDocumentReferences": [
{
"id": "INV-001",
"schemeId": "invoiceId"
}
]
}
],
"documentCurrencyCode": {
"currency": "DKK",
"currencyId": "DKK",
"currencyRate": 1.0
},
"amount": 500,
"creditAmount": {
"amount": 500,
"currencyId": "DKK"
},
"debitAmount": {
"amount": 0,
"currencyId": "DKK"
}
}
]
}
}
}
},
"400": {
"description": "The request body or parameters are invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"errors": {
"fieldName": [
"Validation error message."
]
}
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/suppliers": {
"get": {
"tags": [
"Suppliers"
],
"summary": "List suppliers",
"description": "Retrieves a paginated list of suppliers for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListSuppliers",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Count",
"in": "query",
"description": "Number of records to return per page. Range: 1-100.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "CurrentPage",
"in": "query",
"description": "Page number to return. Must be 1 or greater.",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns a paginated list of suppliers for the specified consent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierDtoPagedResultDto"
},
"example": {
"meta": {
"totalResources": 10,
"totalPages": 1,
"currentPage": 1
},
"data": [
{
"id": "SUP-001",
"customerAssignedAccountId": {
"id": "SUP-001",
"schemeId": "supplierId"
},
"party": {
"partyIdentification": [],
"partyName": {
"name": "Acme Supplies",
"languageId": "ENG"
},
"postalAddress": null,
"partyLegalEntity": null,
"contact": null,
"endpointId": null
},
"deliveryAddresses": [],
"description": null,
"financialDimensions": [],
"active": true,
"currency": "SEK",
"paymentMeans": []
}
]
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v1/consents/{consentId}/suppliers/{supplierId}": {
"get": {
"tags": [
"Suppliers"
],
"summary": "Get a supplier by ID",
"description": "Retrieves a single supplier by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | 📞 Not supported / contact us |\n| Bjorn Lunden | 📞 Not supported / contact us |\n| Spiris | 📞 Not supported / contact us |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "GetSupplier",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "supplierId",
"in": "path",
"description": "Identifier of the supplier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested supplier.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierDto"
},
"example": {
"id": "SUP-001",
"customerAssignedAccountId": {
"id": "SUP-001",
"schemeId": "supplierId"
},
"party": {
"partyIdentification": [],
"partyName": {
"name": "Acme Supplies",
"languageId": "ENG"
},
"postalAddress": null,
"partyLegalEntity": null,
"contact": null,
"endpointId": null
},
"deliveryAddresses": [],
"description": null,
"financialDimensions": [],
"active": true,
"currency": "SEK",
"paymentMeans": []
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested supplier was not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
},
"/api/v2/consents/{consentId}/trialbalances": {
"get": {
"tags": [
"Trial Balances"
],
"summary": "Get trial balances",
"description": "Retrieves trial balances for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | ✅ Supported |\n| Billy | ✅ Supported |\n| Visma Dinero | ✅ Supported |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | 📞 Not supported / contact us |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | 📞 Not supported / contact us |\n| Bokio | 📞 Not supported / contact us |",
"operationId": "ListTrialBalances",
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Identifier of the consent representing the connection to the accounting system.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "StartDate",
"in": "query",
"description": "Start date for the trial balance period. Format: yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2025-01-01"
},
"example": "2025-01-01"
},
{
"name": "EndDate",
"in": "query",
"description": "End date for the trial balance period. Format: yyyy-MM-dd.",
"schema": {
"type": "string",
"format": "date",
"example": "2025-12-31"
},
"example": "2025-12-31"
},
{
"name": "Level",
"in": "query",
"description": "Heading level depth for the trial balance. Range: 1-5.",
"schema": {
"maximum": 5,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "x-correlation-id",
"in": "header",
"description": "Unique identifier used to correlate and trace this request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested trial balances.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrialBalancesDto"
},
"example": {
"trialBalancePeriod": {
"startDate": "2024-02-01",
"endDate": "2024-03-31"
},
"financialReport": {
"accounts": [
{
"accountingAccount": {
"id": "1010",
"accountingAccountId": "1010",
"reference": "1010",
"standardAccountingAccountId": "1010",
"name": "Sales",
"active": null,
"postable": null,
"description": null,
"descriptions": [
{
"languageId": "ENG",
"text": "Sales revenue"
}
],
"accountingAccountTypeCode": {
"code": "REV",
"listId": null
},
"financialDimensions": []
},
"endingBalance": {
"baseCurrencies": [
{
"currencyId": "SEK",
"baseAmount": -230.00
}
]
},
"accountMovement": {
"baseCurrencies": [
{
"currencyId": "SEK",
"baseAmount": -30.00
}
]
}
}
],
"categories": []
}
}
}
}
},
"401": {
"description": "Missing or invalid authentication credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Missing or invalid authentication credentials."
}
}
}
},
"403": {
"description": "Not authorized to access this resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"detail": "Not authorized to access this resource."
}
}
}
},
"404": {
"description": "The requested trial balances were not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found."
}
}
}
},
"501": {
"description": "This operation is not supported by the connected accounting system.",
"content": {
"application/json": {
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.6.2",
"title": "Not Implemented",
"status": 501,
"detail": "This operation is not supported by the connected accounting system."
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AccountTrialBalanceDto": {
"type": "object",
"properties": {
"accountingAccount": {
"$ref": "#/components/schemas/AccountingAccountDto"
},
"endingBalance": {
"$ref": "#/components/schemas/FinancialReportBalanceDto"
},
"accountMovement": {
"$ref": "#/components/schemas/FinancialReportBalanceDto"
}
},
"additionalProperties": false,
"description": "Represents a trial balance entry for a specific accounting account."
},
"AccountingAccountDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"accountingAccountId": {
"type": [
"null",
"string"
],
"description": "Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.AccountingAccountDto.Reference instead. (Deprecated: Use Reference instead.)",
"deprecated": true
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the account."
},
"standardAccountingAccountId": {
"type": [
"null",
"string"
],
"description": "Standard accounting account identifier used for classification."
},
"name": {
"type": [
"null",
"string"
],
"description": "Display name of the accounting account."
},
"active": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the account is active."
},
"postable": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether transactions can be posted to the account."
},
"description": {
"description": "Deprecated: Use Descriptions instead.",
"deprecated": true,
"$ref": "#/components/schemas/DescriptionDto"
},
"descriptions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/DescriptionDto"
},
"description": "Collection of descriptions for the accounting account."
},
"accountingAccountTypeCode": {
"$ref": "#/components/schemas/PriceTypeCodeDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions associated with the account."
}
},
"additionalProperties": false,
"description": "Represents an accounting account in the chart of accounts."
},
"AccountingAccountDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AccountingAccountDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"AccountingAccountInputDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the accounting account."
},
"accountingAccountId": {
"type": [
"null",
"string"
],
"description": "Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Input.AccountingAccountInputDto.Reference instead. (Deprecated: Use Reference instead.)",
"deprecated": true
},
"reference": {
"type": [
"null",
"string"
],
"description": "Reference code for the accounting account."
},
"standardAccountingAccountId": {
"type": [
"null",
"string"
],
"description": "Standard accounting account identifier (e.g. BAS account number)."
},
"name": {
"type": [
"null",
"string"
],
"description": "Display name of the accounting account."
},
"active": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the accounting account is active."
},
"postable": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether entries can be posted to this account."
},
"description": {
"description": "Deprecated: Use Descriptions instead.",
"deprecated": true,
"$ref": "#/components/schemas/DescriptionDto"
},
"descriptions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/DescriptionDto"
},
"description": "Collection of descriptions for the accounting account."
},
"accountingAccountTypeCode": {
"$ref": "#/components/schemas/PriceTypeCodeDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions for the account."
}
},
"additionalProperties": false,
"description": "Represents input data for an accounting account."
},
"AccountingEntryAmountInputDto": {
"type": "object",
"properties": {
"amount": {
"type": [
"null",
"number"
],
"description": "Monetary amount for the entry. Must be non-negative.",
"format": "double"
},
"currencyId": {
"type": [
"null",
"string"
],
"description": "Currency code for the amount (e.g. SEK)."
}
},
"additionalProperties": false,
"description": "Represents the monetary amount of an accounting entry."
},
"AccountingEntryDto": {
"type": "object",
"properties": {
"description": {
"$ref": "#/components/schemas/DescriptionDto"
},
"accountingAccount": {
"$ref": "#/components/schemas/AccountingAccountDto"
},
"debitAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"creditAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions associated with the entry."
}
},
"additionalProperties": false,
"description": "Represents an accounting entry line within a journal."
},
"AccountingEntryInputDto": {
"type": "object",
"properties": {
"description": {
"$ref": "#/components/schemas/NoteDto"
},
"accountingAccount": {
"$ref": "#/components/schemas/AccountingAccountInputDto"
},
"debitAmount": {
"$ref": "#/components/schemas/AccountingEntryAmountInputDto"
},
"creditAmount": {
"$ref": "#/components/schemas/AccountingEntryAmountInputDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions for the entry."
}
},
"additionalProperties": false,
"description": "Represents a single accounting entry within a journal."
},
"AccountingPeriodDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the accounting period."
},
"accountingMethod": {
"type": [
"null",
"string"
],
"description": "Accounting method used during the period (null if not available)."
},
"startDate": {
"type": [
"null",
"string"
],
"description": "Date when the accounting period starts. Format: yyyy-MM-dd."
},
"endDate": {
"type": [
"null",
"string"
],
"description": "Date when the accounting period ends. Format: yyyy-MM-dd."
},
"isOpen": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the accounting period is currently open for transactions."
}
},
"additionalProperties": false,
"description": "Represents an accounting period (fiscal year or sub-period)."
},
"AccountingPeriodDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AccountingPeriodDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"AccountingSeriesDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the accounting series."
},
"accountingSeriesId": {
"type": [
"null",
"string"
],
"description": "Accounting-system-specific identifier for the series."
}
},
"additionalProperties": false,
"description": "Represents an accounting series used to categorize journal entries."
},
"AccountingSeriesInputDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the accounting series."
},
"accountingSeriesId": {
"type": [
"null",
"string"
],
"description": "External identifier for the accounting series."
}
},
"additionalProperties": false,
"description": "Represents an accounting series used to group journal entries."
},
"AdditionalDocumentReferenceDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the document reference."
},
"reference": {
"type": [
"null",
"string"
],
"description": "Reference value of the additional document."
}
},
"additionalProperties": false,
"description": "Represents an additional document reference associated with an invoice."
},
"AddressDto": {
"type": "object",
"properties": {
"buildingNumber": {
"type": [
"null",
"string"
],
"description": "Building number of the address."
},
"streetName": {
"type": [
"null",
"string"
],
"description": "Primary street name."
},
"additionalStreetName": {
"type": [
"null",
"string"
],
"description": "Secondary street name or additional address line."
},
"cityName": {
"type": [
"null",
"string"
],
"description": "City or locality name."
},
"postalZone": {
"type": [
"null",
"string"
],
"description": "Postal or ZIP code."
},
"country": {
"$ref": "#/components/schemas/CountryDto"
}
},
"additionalProperties": false,
"description": "Represents a postal address."
},
"AllowanceChargeDto": {
"type": "object",
"properties": {
"allowanceChargeId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"chargeIndicator": {
"type": "boolean",
"description": "Indicates whether this entry is a charge (true) or an allowance (false)."
},
"allowanceChargeReason": {
"type": [
"null",
"string"
],
"description": "Reason for the allowance or charge."
},
"allowanceChargeAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxTotal": {
"$ref": "#/components/schemas/TaxTotalDto"
},
"taxCategory": {
"$ref": "#/components/schemas/TaxCategoryDto"
},
"allowanceChargeBaseAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"multiplierFactorNumeric": {
"type": [
"null",
"number"
],
"description": "Multiplier factor used to calculate the allowance or charge.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Represents an allowance or charge applied to an invoice or line item."
},
"AllowanceChargeInputDto": {
"type": "object",
"properties": {
"allowanceChargeId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"chargeIndicator": {
"type": "boolean",
"description": "Indicates whether this is a charge (true) or an allowance (false)."
},
"allowanceChargeReason": {
"type": [
"null",
"string"
],
"description": "Reason for the allowance or charge."
},
"allowanceChargeAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxTotal": {
"$ref": "#/components/schemas/TaxTotalInputDto"
},
"taxCategory": {
"$ref": "#/components/schemas/TaxCategoryDto"
},
"allowanceChargeBaseAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"multiplierFactorNumeric": {
"type": [
"null",
"number"
],
"description": "Multiplier factor used to calculate the allowance or charge.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Represents an allowance or charge applied to an invoice or invoice line."
},
"AmountTypeDto": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The balance amount.",
"format": "double"
},
"currencyId": {
"type": [
"null",
"string"
],
"description": "The currency code (e.g. SEK)."
}
},
"additionalProperties": false,
"description": "Represents a monetary amount with an associated currency."
},
"BalanceSheetDto": {
"type": "object",
"properties": {
"accountBalancePeriod": {
"$ref": "#/components/schemas/PeriodDto"
},
"financialReport": {
"$ref": "#/components/schemas/FinancialReportDto"
}
},
"additionalProperties": false,
"description": "Represents a balance sheet financial statement."
},
"BaseCurrencyDto": {
"type": "object",
"properties": {
"currencyId": {
"type": [
"null",
"string"
],
"description": "Currency code identifier (e.g. SEK, EUR)."
},
"baseAmount": {
"type": "number",
"description": "Monetary amount in the base currency.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Represents a monetary amount in a specific base currency."
},
"BillingReferenceDto": {
"type": "object",
"properties": {
"invoiceDocumentReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/IdentifierDto"
},
"description": "Collection of invoice document reference identifiers."
}
},
"additionalProperties": false,
"description": "Represents a billing reference containing invoice document references."
},
"CompanyInformationDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the company."
},
"reference": {
"type": [
"null",
"string"
],
"description": "Reference code for the company."
},
"partyIdentification": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/IdentifierDto"
},
"description": "Collection of party identification entries."
},
"partyName": {
"$ref": "#/components/schemas/PartyNameDto"
},
"postalAddress": {
"$ref": "#/components/schemas/AddressDto"
},
"phone": {
"type": [
"null",
"string"
],
"description": "Phone number of the company."
},
"email": {
"type": [
"null",
"string"
],
"description": "Email address of the company."
},
"fax": {
"type": [
"null",
"string"
],
"description": "Fax number of the company."
},
"website": {
"type": [
"null",
"string"
],
"description": "Website URL of the company."
},
"partyLegalEntity": {
"$ref": "#/components/schemas/PartyLegalEntityDto"
},
"contacts": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/ContactDto"
},
"description": "Collection of contact persons for the company."
},
"paymentMeans": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/PaymentMeansNewDto"
},
"description": "Collection of payment means for the company."
}
},
"additionalProperties": false,
"description": "Represents company information details in the accounting system."
},
"ContactDto": {
"type": "object",
"properties": {
"name": {
"type": [
"null",
"string"
],
"description": "Contact person name."
},
"telephone": {
"type": [
"null",
"string"
],
"description": "Primary telephone number."
},
"email": {
"type": [
"null",
"string"
],
"description": "Primary email address."
},
"secondaryEmail": {
"type": [
"null",
"string"
],
"description": "Secondary email address."
}
},
"additionalProperties": false,
"description": "Represents contact information for a party."
},
"CountryDto": {
"type": "object",
"properties": {
"identificationCode": {
"type": [
"null",
"string"
],
"description": "ISO 3166-1 alpha-2 country code."
},
"name": {
"type": [
"null",
"string"
],
"description": "Country name."
}
},
"additionalProperties": false,
"description": "Represents a country with its identification code and name."
},
"CreateJournalDto": {
"type": "object",
"properties": {
"reference": {
"type": [
"null",
"string"
],
"description": "Reference identifier for the journal."
},
"transactionDate": {
"type": [
"null",
"string"
],
"description": "Date of the journal transaction.",
"format": "date-time"
},
"accountingSeries": {
"$ref": "#/components/schemas/AccountingSeriesInputDto"
},
"description": {
"$ref": "#/components/schemas/DescriptionDto"
},
"bookedJournalIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the journal should be booked immediately."
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions for the journal."
},
"accountingEntries": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AccountingEntryInputDto"
},
"description": "Collection of accounting entries in the journal."
}
},
"additionalProperties": false,
"description": "Represents input data for creating a journal entry."
},
"CreateSalesInvoiceNoteDto": {
"type": "object",
"properties": {
"note": {
"type": [
"null",
"string"
],
"description": "The note text to attach to the sales invoice."
}
},
"additionalProperties": false,
"description": "Represents the data required to create a note on a sales invoice."
},
"CreateSalesInvoicePaymentDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the payment."
},
"reference": {
"type": [
"null",
"string"
],
"description": "Reference identifier for the payment."
},
"receivedDate": {
"type": [
"null",
"string"
],
"description": "Date when the payment was received.",
"format": "date-time"
},
"paidDate": {
"type": [
"null",
"string"
],
"description": "Date when the payment was made.",
"format": "date-time"
},
"bookedIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the payment is booked."
},
"bookedDate": {
"type": [
"null",
"string"
],
"description": "Date when the payment was booked.",
"format": "date-time"
},
"accountingAccount": {
"$ref": "#/components/schemas/AccountingAccountInputDto"
},
"documentCurrencyCode": {
"$ref": "#/components/schemas/DocumentCurrencyCodeDto"
},
"amount": {
"type": [
"null",
"number"
],
"description": "Monetary amount for the payment.",
"format": "double"
},
"creditAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"debitAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"paymentId": {
"type": [
"null",
"string"
],
"description": "Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Input.CreateInvoicePaymentDtoBase.Reference instead. External payment identifier. (Deprecated: Use Reference instead)",
"deprecated": true
}
},
"additionalProperties": false,
"description": "Represents input data for creating a sales invoice payment."
},
"CreateSupplierInvoicePaymentDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the payment."
},
"reference": {
"type": [
"null",
"string"
],
"description": "Reference identifier for the payment."
},
"receivedDate": {
"type": [
"null",
"string"
],
"description": "Date when the payment was received.",
"format": "date-time"
},
"paidDate": {
"type": [
"null",
"string"
],
"description": "Date when the payment was made.",
"format": "date-time"
},
"bookedIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the payment is booked."
},
"bookedDate": {
"type": [
"null",
"string"
],
"description": "Date when the payment was booked.",
"format": "date-time"
},
"accountingAccount": {
"$ref": "#/components/schemas/AccountingAccountInputDto"
},
"documentCurrencyCode": {
"$ref": "#/components/schemas/DocumentCurrencyCodeDto"
},
"amount": {
"type": [
"null",
"number"
],
"description": "Monetary amount for the payment.",
"format": "double"
},
"creditAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"debitAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"status": {
"$ref": "#/components/schemas/PaymentConditionDto"
},
"billingReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/BillingReferenceDto"
},
"description": "Collection of billing references for the payment."
}
},
"additionalProperties": false,
"description": "Represents input data for creating a supplier invoice payment."
},
"CreditInvoiceDocumentReferenceDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the document reference."
},
"reference": {
"type": [
"null",
"string"
],
"description": "Reference number of the credited invoice."
},
"documentType": {
"enum": [
"Invoice",
"CreditInvoice"
],
"type": [
"null",
"string"
],
"description": "Type of the referenced document."
}
},
"additionalProperties": false,
"description": "Represents a reference to a credited invoice document."
},
"CreditInvoiceDto": {
"type": "object",
"properties": {
"creditInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is a credit invoice or credit note."
},
"creditInvoiceDocumentReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/CreditInvoiceDocumentReferenceDto"
},
"description": "Collection of document references to credited or credit invoices."
}
},
"additionalProperties": false,
"description": "Represents credit invoice details associated with an invoice."
},
"CreditInvoiceInputDto": {
"type": "object",
"properties": {
"creditInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is a credit invoice / credit note."
},
"reference": {
"type": [
"null",
"string"
],
"description": "Invoice number of the credited invoice, if this is a credit invoice."
},
"creditInvoiceDocumentReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/CreditInvoiceDocumentReferenceDto"
},
"description": "Collection of references to the credited invoices or credit invoices."
}
},
"additionalProperties": false,
"description": "Represents credit invoice details associated with an invoice."
},
"CustomerDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the customer."
},
"supplierAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"type": {
"enum": [
"PrivatePerson",
"Company"
],
"type": [
"null",
"string"
],
"description": "Customer type classification (e.g. PrivatePerson, Company)."
},
"party": {
"$ref": "#/components/schemas/PartyDto"
},
"deliveryAddresses": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AddressDto"
},
"description": "Collection of delivery addresses for the customer."
},
"description": {
"$ref": "#/components/schemas/NoteDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions assigned to the customer."
},
"active": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the customer is active."
},
"currency": {
"type": [
"null",
"string"
],
"description": "Currency code associated with the customer."
},
"paymentMeans": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/PaymentMeansNewDto"
},
"description": "Collection of payment means for the customer."
}
},
"additionalProperties": false,
"description": "Represents a customer entity in the accounting system."
},
"CustomerDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/CustomerDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"CustomerPartyDto": {
"type": "object",
"properties": {
"supplierAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"party": {
"$ref": "#/components/schemas/PartyDto"
},
"type": {
"enum": [
"PrivatePerson",
"Company"
],
"type": [
"null",
"string"
],
"description": "Customer type classification."
}
},
"additionalProperties": false,
"description": "Represents the customer party on an invoice."
},
"CustomerPartyInputDto": {
"type": "object",
"properties": {
"supplierAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"party": {
"$ref": "#/components/schemas/PartyInputDto"
}
},
"additionalProperties": false,
"description": "Represents the customer party on an invoice."
},
"CustomerPartySummaryDto": {
"type": "object",
"properties": {
"supplierAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"party": {
"$ref": "#/components/schemas/SalesInvoicePartySummaryDto"
}
},
"additionalProperties": false,
"description": "Represents a summarized customer party view for sales invoice listings."
},
"DeliveryDto": {
"type": "object",
"properties": {
"deliveryParty": {
"$ref": "#/components/schemas/DeliveryPartyDto"
},
"carrierParty": {
"$ref": "#/components/schemas/DeliveryPartyDto"
},
"actualDeliveryDate": {
"type": [
"null",
"string"
],
"description": "Actual date of delivery."
},
"trackingId": {
"type": [
"null",
"string"
],
"description": "Tracking identifier for the delivery shipment."
},
"deliveryAddress": {
"$ref": "#/components/schemas/AddressDto"
}
},
"additionalProperties": false,
"description": "Represents delivery information for an invoice."
},
"DeliveryPartyDto": {
"type": "object",
"properties": {
"partyIdentification": {
"$ref": "#/components/schemas/IdentifierDto"
},
"partyName": {
"$ref": "#/components/schemas/PartyNameDto"
}
},
"additionalProperties": false,
"description": "Represents a party involved in a delivery."
},
"DeliveryTermsDto": {
"type": "object",
"properties": {
"deliveryTermsId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"specialTerms": {
"$ref": "#/components/schemas/NoteDto"
}
},
"additionalProperties": false,
"description": "Represents delivery terms associated with an invoice."
},
"DescriptionDto": {
"type": "object",
"properties": {
"text": {
"type": [
"null",
"string"
],
"description": "Content of the description."
},
"languageId": {
"type": [
"null",
"string"
],
"description": "ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."
}
},
"additionalProperties": false,
"description": "Represents a description with an optional language identifier."
},
"DocumentCurrencyCodeDto": {
"type": "object",
"properties": {
"currency": {
"type": [
"null",
"string"
],
"description": "Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Common.DocumentCurrencyCodeDto.CurrencyId instead. Currency code of the document (e.g. SEK, EUR). (Deprecated: Use CurrencyId instead)",
"deprecated": true
},
"currencyId": {
"type": [
"null",
"string"
],
"description": "Currency code of the document (e.g. SEK, EUR)."
},
"currencyRate": {
"type": [
"null",
"number"
],
"description": "Exchange rate applied to the document currency.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Represents the document currency and its exchange rate."
},
"FinancialAccountDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the financial account."
},
"financialInstitution": {
"type": [
"null",
"string"
],
"description": "Name or identifier of the financial institution."
}
},
"additionalProperties": false,
"description": "Represents a financial account used for payments."
},
"FinancialDimensionDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the financial dimension."
},
"reference": {
"type": [
"null",
"string"
],
"description": "Reference code for the financial dimension."
},
"type": {
"type": [
"null",
"string"
],
"description": "Type or code of the financial dimension as exposed by the connected accounting system.\n\nKnown values currently emitted by supported connectors include:\n\n- businessGroup\n- campaign\n- costBearer\n- costCode\n- costUnit\n- customerGroup\n- department\n- employee\n- product\n- project\n- purchaser\n- salesPerson\n- salesRegion\n- supplierGroup\n\nSome connectors can also return additional system-specific dimension codes (for example custom Business Central dimension codes)."
},
"name": {
"type": [
"null",
"string"
],
"description": "Display name of the financial dimension."
},
"description": {
"type": [
"null",
"string"
],
"description": "Description of the financial dimension."
},
"isActive": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the financial dimension is active."
}
},
"additionalProperties": false,
"description": "Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project)."
},
"FinancialDimensionDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"FinancialReportAccountBalanceSummaryDto": {
"type": "object",
"properties": {
"accountingAccount": {
"$ref": "#/components/schemas/AccountingAccountDto"
},
"balance": {
"$ref": "#/components/schemas/FinancialReportBalanceDto"
}
},
"additionalProperties": false,
"description": "Represents an account balance summary within a financial report."
},
"FinancialReportBalanceDto": {
"type": "object",
"properties": {
"baseCurrencies": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/BaseCurrencyDto"
},
"description": "Collection of base currency amounts for the balance."
}
},
"additionalProperties": false,
"description": "Represents a balance in a financial report expressed in one or more currencies."
},
"FinancialReportCategoryDto": {
"type": "object",
"properties": {
"descriptions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/DescriptionDto"
},
"description": "Collection of descriptions for the category."
},
"balance": {
"$ref": "#/components/schemas/FinancialReportBalanceDto"
},
"subCategories": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialReportCategoryDto"
},
"description": "Collection of child categories within this category."
},
"accounts": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialReportAccountBalanceSummaryDto"
},
"description": "Collection of account balance summaries within this category."
}
},
"additionalProperties": false,
"description": "Represents a category within a financial report, supporting hierarchical sub-categories."
},
"FinancialReportDto": {
"type": "object",
"properties": {
"categories": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialReportCategoryDto"
},
"description": "Collection of financial report categories."
}
},
"additionalProperties": false,
"description": "Represents a financial report composed of categorized account data."
},
"IdentifierDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Legal identifier."
},
"schemeId": {
"type": [
"null",
"string"
],
"description": "Legal identifier scheme (e.g. SE:ORGNR)."
}
},
"additionalProperties": false,
"description": "Represents a legal identifier with an associated scheme."
},
"IncomeStatementDto": {
"type": "object",
"properties": {
"accountBalancePeriod": {
"$ref": "#/components/schemas/PeriodDto"
},
"financialReport": {
"$ref": "#/components/schemas/FinancialReportDto"
},
"profitLossBalance": {
"$ref": "#/components/schemas/FinancialReportBalanceDto"
}
},
"additionalProperties": false,
"description": "Represents an income statement (profit and loss) financial report."
},
"InvoiceAttachmentDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the attachment."
},
"invoiceId": {
"type": [
"null",
"string"
],
"description": "Identifier of the invoice this attachment belongs to."
},
"type": {
"enum": [
"Attachment",
"Invoice"
],
"type": "string",
"description": "Type of the attachment (e.g. Attachment or Invoice)."
},
"fileName": {
"type": [
"null",
"string"
],
"description": "Original file name of the attachment."
}
},
"additionalProperties": false,
"description": "Represents an attachment associated with an invoice."
},
"InvoiceAttachmentDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/InvoiceAttachmentDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"InvoiceLineDeliveryDto": {
"type": "object",
"properties": {
"actualDeliveryDate": {
"type": [
"null",
"string"
],
"description": "Actual date of delivery for the invoice line."
}
},
"additionalProperties": false,
"description": "Represents delivery information at the invoice line level."
},
"InvoiceLineDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the invoice line."
},
"invoicedQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
},
"lineExtensionAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"item": {
"$ref": "#/components/schemas/ItemDto"
},
"price": {
"$ref": "#/components/schemas/PriceDto"
},
"delivery": {
"$ref": "#/components/schemas/InvoiceLineDeliveryDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions for the line."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeDto"
},
"description": "Collection of allowances or charges applied to the line."
},
"subInvoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SubInvoiceLineDto"
},
"description": "Collection of sub-lines within this invoice line."
}
},
"additionalProperties": false,
"description": "Represents a single line item on an invoice."
},
"InvoicePaymentDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the invoice payment."
},
"paymentId": {
"type": [
"null",
"string"
],
"description": "Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)",
"deprecated": true
},
"reference": {
"type": [
"null",
"string"
],
"description": "Payment reference string."
},
"receivedDate": {
"type": [
"null",
"string"
],
"description": "Date the payment was received."
},
"paidDate": {
"type": [
"null",
"string"
],
"description": "Date the payment was made."
},
"bookedIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the payment has been booked."
},
"bookedDate": {
"type": [
"null",
"string"
],
"description": "Date the payment was booked."
},
"accountingAccount": {
"$ref": "#/components/schemas/AccountingAccountDto"
},
"status": {
"$ref": "#/components/schemas/PaymentConditionDto"
},
"billingReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/BillingReferenceDto"
},
"description": "Collection of billing references linked to the payment."
},
"documentCurrencyCode": {
"$ref": "#/components/schemas/DocumentCurrencyCodeDto"
},
"amount": {
"type": [
"null",
"number"
],
"description": "Monetary amount.",
"format": "double"
},
"creditAmount": {
"description": "Deprecated: Use Amount instead",
"deprecated": true,
"$ref": "#/components/schemas/AmountTypeDto"
},
"debitAmount": {
"description": "Deprecated: Use Amount instead",
"deprecated": true,
"$ref": "#/components/schemas/AmountTypeDto"
}
},
"additionalProperties": false,
"description": "Represents a payment associated with an invoice."
},
"InvoicePaymentDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/InvoicePaymentDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"InvoicedQuantityDto": {
"type": "object",
"properties": {
"quantity": {
"type": [
"null",
"number"
],
"description": "Number of units invoiced.",
"format": "double"
},
"unitCode": {
"type": [
"null",
"string"
],
"description": "Unit of measure code (e.g. EA, KG)."
}
},
"additionalProperties": false,
"description": "Represents an invoiced quantity with its unit of measure."
},
"ItemDto": {
"type": "object",
"properties": {
"name": {
"type": [
"null",
"string"
],
"description": "Name of the item."
},
"description": {
"type": [
"null",
"string"
],
"description": "Textual description of the item."
},
"sellersItemIdentification": {
"$ref": "#/components/schemas/SellersItemIdentificationDto"
},
"classifiedTaxCategories": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxCategoryDto"
},
"description": "Collection of tax categories classified for the item."
}
},
"additionalProperties": false,
"description": "Represents an item referenced in an invoice line."
},
"ItemInputDto": {
"type": "object",
"properties": {
"name": {
"type": [
"null",
"string"
],
"description": "Name of the item."
},
"description": {
"type": [
"null",
"string"
],
"description": "Description of the item."
},
"sellersItemIdentification": {
"$ref": "#/components/schemas/SellersItemIdentificationDto"
},
"classifiedTaxCategories": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxCategoryDto"
},
"description": "Collection of tax categories classified for the item."
}
},
"additionalProperties": false,
"description": "Represents an item on an invoice line."
},
"JournalDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the journal."
},
"transactionDate": {
"type": [
"null",
"string"
],
"description": "Date when the transaction occurred. Format: yyyy-MM-dd."
},
"accountingSeries": {
"$ref": "#/components/schemas/AccountingSeriesDto"
},
"description": {
"$ref": "#/components/schemas/DescriptionDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions associated with the journal."
},
"accountingEntries": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AccountingEntryDto"
},
"description": "Collection of accounting entries within the journal."
}
},
"additionalProperties": false,
"description": "Represents a journal entry with its accounting entries."
},
"JournalDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/JournalDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"LegalMonetaryTotalDto": {
"type": "object",
"properties": {
"taxInclusiveAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"prepaidAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"payableRoundingAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"payableAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"lineExtensionAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxExclusiveAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
}
},
"additionalProperties": false,
"description": "Represents the legal monetary totals of an invoice."
},
"NoteDto": {
"type": "object",
"properties": {
"text": {
"type": [
"null",
"string"
],
"description": "Content of the note."
},
"languageId": {
"type": [
"null",
"string"
],
"description": "ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."
}
},
"additionalProperties": false,
"description": "Represents a textual note with an optional language identifier."
},
"OrderReferenceDto": {
"type": "object",
"properties": {
"buyerOrderId": {
"type": [
"null",
"string"
],
"description": "Order number of the buyer (generated by the customer's system)."
},
"sellerOrderId": {
"type": [
"null",
"string"
],
"description": "Order number of the seller (generated by the seller's system)."
}
},
"additionalProperties": false,
"description": "Represents a reference to the order from which the invoice originates."
},
"PagedResultMetadataDto": {
"type": "object",
"properties": {
"totalResources": {
"type": [
"null",
"integer"
],
"description": "Total number of resources across all pages.",
"format": "int32"
},
"totalPages": {
"type": [
"null",
"integer"
],
"description": "Total number of pages available.",
"format": "int32"
},
"currentPage": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Represents pagination metadata for a paged result set."
},
"PartyDto": {
"type": "object",
"properties": {
"partyIdentification": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/IdentifierDto"
},
"description": "Collection of identifiers for the party."
},
"partyName": {
"$ref": "#/components/schemas/PartyNameDto"
},
"postalAddress": {
"$ref": "#/components/schemas/AddressDto"
},
"partyLegalEntity": {
"$ref": "#/components/schemas/PartyLegalEntityDto"
},
"contact": {
"$ref": "#/components/schemas/ContactDto"
},
"endpointId": {
"$ref": "#/components/schemas/IdentifierDto"
}
},
"additionalProperties": false,
"description": "Represents a party (organization or individual) involved in a transaction."
},
"PartyInputDto": {
"type": "object",
"properties": {
"partyName": {
"$ref": "#/components/schemas/PartyNameDto"
},
"postalAddress": {
"$ref": "#/components/schemas/AddressDto"
},
"partyLegalEntity": {
"$ref": "#/components/schemas/PartyLegalEntityDto"
},
"contact": {
"$ref": "#/components/schemas/ContactDto"
},
"endpointId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"partyIdentification": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/IdentifierDto"
},
"description": "Collection of identifiers for the party."
}
},
"additionalProperties": false,
"description": "Represents a party (business entity) involved in an invoice."
},
"PartyLegalEntityDto": {
"type": "object",
"properties": {
"registrationName": {
"type": [
"null",
"string"
],
"description": "Registered legal name of the entity."
},
"companyId": {
"$ref": "#/components/schemas/IdentifierDto"
}
},
"additionalProperties": false,
"description": "Represents the legal entity information of a party."
},
"PartyNameDto": {
"type": "object",
"properties": {
"name": {
"type": [
"null",
"string"
],
"description": "Name of the party."
},
"languageId": {
"type": [
"null",
"string"
],
"description": "ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."
}
},
"additionalProperties": false,
"description": "Represents the name of a party with an optional language identifier."
},
"PartySummaryDto": {
"type": "object",
"properties": {
"partyName": {
"$ref": "#/components/schemas/PartyNameDto"
}
},
"additionalProperties": false,
"description": "Represents a summarized view of a party."
},
"PayeeFinancialAccountDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the financial account."
},
"financialInstitution": {
"type": [
"null",
"string"
],
"description": "Name or identifier of the financial institution."
}
},
"additionalProperties": false,
"description": "Represents a payee's financial account details."
},
"PaymentConditionDto": {
"type": "object",
"properties": {
"conditionCode": {
"type": [
"null",
"string"
],
"description": "Code identifying the payment condition."
},
"referenceDate": {
"type": [
"null",
"string"
],
"description": "Reference date associated with the payment condition.",
"format": "date-time"
},
"statusReason": {
"type": [
"null",
"string"
],
"description": "Reason describing the payment status."
}
},
"additionalProperties": false,
"description": "Represents the condition or status of a payment."
},
"PaymentMeansDto": {
"type": "object",
"properties": {
"paymentChannelCode": {
"type": [
"null",
"string"
],
"description": "Code identifying the payment channel."
},
"paymentDueDate": {
"type": [
"null",
"string"
],
"description": "Date the payment is due."
},
"paymentIds": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/IdentifierDto"
},
"description": "Collection of payment identifiers."
},
"financialAccount": {
"$ref": "#/components/schemas/FinancialAccountDto"
}
},
"additionalProperties": false,
"description": "Represents the payment means associated with an invoice."
},
"PaymentMeansInputDto": {
"type": "object",
"properties": {
"paymentChannelCode": {
"type": [
"null",
"string"
],
"description": "Code identifying the payment channel (e.g. bank transfer, credit card)."
},
"paymentDueDate": {
"type": [
"null",
"string"
],
"description": "Due date for the payment."
},
"paymentIds": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/IdentifierDto"
},
"description": "Collection of payment identifiers (e.g. bank account numbers)."
}
},
"additionalProperties": false,
"description": "Represents the means of payment for an invoice."
},
"PaymentMeansNewDto": {
"type": "object",
"properties": {
"paymentChannelCode": {
"type": [
"null",
"string"
],
"description": "Code identifying the payment channel."
},
"payeeFinancialAccount": {
"type": [
"null",
"string"
],
"description": "Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)",
"deprecated": true
},
"financialAccount": {
"$ref": "#/components/schemas/FinancialAccountDto"
}
},
"additionalProperties": false,
"description": "Represents payment means with financial account details."
},
"PaymentStatusDto": {
"type": "object",
"properties": {
"status": {
"enum": [
"UNPAID",
"PARTLY_PAID",
"FULLY_PAID"
],
"type": [
"null",
"string"
],
"description": "Current payment status."
},
"settlementDate": {
"type": [
"null",
"string"
],
"description": "Date when the payment was settled."
}
},
"additionalProperties": false,
"description": "Represents the payment status of an invoice."
},
"PaymentTermsDto": {
"type": "object",
"properties": {
"paymentTermsId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes describing the payment terms."
}
},
"additionalProperties": false,
"description": "Represents payment terms associated with an invoice."
},
"PaymentTermsInputDto": {
"type": "object",
"properties": {
"paymentTermsId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes describing the payment terms."
}
},
"additionalProperties": false,
"description": "Represents payment terms for an invoice."
},
"PeriodDto": {
"type": "object",
"properties": {
"startDate": {
"type": [
"null",
"string"
],
"description": "Start date of the period."
},
"endDate": {
"type": [
"null",
"string"
],
"description": "End date of the period."
}
},
"additionalProperties": false,
"description": "Represents a date period defined by a start and end date."
},
"PriceDto": {
"type": "object",
"properties": {
"priceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"priceTypeCode": {
"$ref": "#/components/schemas/PriceTypeCodeDto"
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeDto"
},
"description": "Collection of allowances or charges applied to the price."
},
"baseQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
}
},
"additionalProperties": false,
"description": "Represents price information for an invoiced item."
},
"PriceInputDto": {
"type": "object",
"properties": {
"priceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"priceTypeCode": {
"$ref": "#/components/schemas/PriceTypeCodeDto"
},
"baseQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeInputDto"
},
"description": "Collection of allowances and charges applied to the price."
}
},
"additionalProperties": false,
"description": "Represents price details for an invoice line item."
},
"PriceTypeCodeDto": {
"type": "object",
"properties": {
"code": {
"type": [
"null",
"string"
],
"description": "Price type code value."
},
"listId": {
"type": [
"null",
"string"
],
"description": "Identifier of the code list the code belongs to."
}
},
"additionalProperties": false,
"description": "Represents a price type classification code."
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": [
"null",
"string"
]
},
"title": {
"type": [
"null",
"string"
]
},
"status": {
"type": [
"null",
"integer"
],
"format": "int32"
},
"detail": {
"type": [
"null",
"string"
]
},
"instance": {
"type": [
"null",
"string"
]
}
},
"additionalProperties": {}
},
"ReminderDto": {
"type": "object",
"properties": {
"reminderSequence": {
"type": [
"null",
"integer"
],
"description": "Sequence number of the reminder.",
"format": "int32"
},
"lastReminderDate": {
"type": [
"null",
"string"
],
"description": "Date of the most recent reminder sent."
}
},
"additionalProperties": false,
"description": "Represents reminder information for an invoice."
},
"SalesInvoiceDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the invoice."
},
"buyerReference": {
"type": [
"null",
"string"
],
"description": "Reference for the buyer, usually the buyer's purchase order number."
},
"bookedInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is booked."
},
"cancelledInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is cancelled."
},
"issueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice was issued. Format: yyyy-MM-dd."
},
"issueTime": {
"type": [
"null",
"string"
],
"description": "Time when the invoice was issued (null if not available)."
},
"dueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice payment is due. Format: yyyy-MM-dd."
},
"creditInvoice": {
"$ref": "#/components/schemas/CreditInvoiceDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions associated with the invoice."
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes attached to the invoice."
},
"orderReference": {
"$ref": "#/components/schemas/OrderReferenceDto"
},
"documentCurrencyCode": {
"$ref": "#/components/schemas/DocumentCurrencyCodeDto"
},
"accountingSupplierParty": {
"$ref": "#/components/schemas/SupplierPartyDto"
},
"accountingCustomerParty": {
"$ref": "#/components/schemas/CustomerPartyDto"
},
"invoicePeriod": {
"$ref": "#/components/schemas/PeriodDto"
},
"delivery": {
"$ref": "#/components/schemas/DeliveryDto"
},
"deliveryTerms": {
"$ref": "#/components/schemas/DeliveryTermsDto"
},
"paymentTerms": {
"$ref": "#/components/schemas/PaymentTermsDto"
},
"paymentMeans": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/PaymentMeansDto"
},
"description": "Collection of payment means for the invoice."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeDto"
},
"description": "Collection of allowance and charge adjustments on the invoice."
},
"taxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxTotalDto"
},
"description": "Collection of tax totals for the invoice."
},
"withholdingTaxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/WithholdingTaxTotalDto"
},
"description": "Collection of withholding tax totals for the invoice."
},
"totalBalanceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"additionalDocumentReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AdditionalDocumentReferenceDto"
},
"description": "Collection of additional document references attached to the invoice."
},
"legalMonetaryTotal": {
"$ref": "#/components/schemas/LegalMonetaryTotalDto"
},
"paymentStatus": {
"$ref": "#/components/schemas/PaymentStatusDto"
},
"sellerReference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned by the seller."
},
"isSent": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice has been sent."
},
"isSold": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is sold to a factoring company for lending purposes."
},
"reminder": {
"$ref": "#/components/schemas/ReminderDto"
},
"invoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/InvoiceLineDto"
},
"description": "Collection of invoice line items."
}
},
"additionalProperties": false,
"description": "Represents a sales invoice with full detail."
},
"SalesInvoiceInputDto": {
"type": "object",
"properties": {
"reference": {
"type": [
"null",
"string"
],
"description": "Invoice number assigned by the sender."
},
"buyerReference": {
"type": [
"null",
"string"
],
"description": "Reference for the buyer (usually the buyer's purchase invoice number)."
},
"bookedInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is booked."
},
"cancelledInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is cancelled."
},
"issueDate": {
"type": [
"null",
"string"
],
"description": "Issue date of the invoice."
},
"issueTime": {
"type": [
"null",
"string"
],
"description": "Issue time of the invoice."
},
"dueDate": {
"type": [
"null",
"string"
],
"description": "Due date for payment of the invoice."
},
"creditInvoice": {
"$ref": "#/components/schemas/CreditInvoiceInputDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions assigned to the invoice."
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes attached to the invoice."
},
"orderReference": {
"$ref": "#/components/schemas/OrderReferenceDto"
},
"documentCurrencyCode": {
"$ref": "#/components/schemas/DocumentCurrencyCodeDto"
},
"accountingSupplierParty": {
"$ref": "#/components/schemas/SupplierPartyInputDto"
},
"accountingCustomerParty": {
"$ref": "#/components/schemas/CustomerPartyInputDto"
},
"invoicePeriod": {
"$ref": "#/components/schemas/PeriodDto"
},
"delivery": {
"$ref": "#/components/schemas/DeliveryDto"
},
"deliveryTerms": {
"$ref": "#/components/schemas/DeliveryTermsDto"
},
"paymentTerms": {
"$ref": "#/components/schemas/PaymentTermsInputDto"
},
"paymentMeans": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/PaymentMeansInputDto"
},
"description": "Collection of payment means for the invoice."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeInputDto"
},
"description": "Collection of allowances and charges on the invoice."
},
"taxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxTotalInputDto"
},
"description": "Collection of tax totals for the invoice."
},
"withholdingTaxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/WithholdingTaxTotalInputDto"
},
"description": "Collection of withholding tax totals for the invoice."
},
"totalBalanceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"additionalDocumentReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AdditionalDocumentReferenceDto"
},
"description": "Collection of additional document references."
},
"legalMonetaryTotal": {
"$ref": "#/components/schemas/LegalMonetaryTotalDto"
},
"paymentStatus": {
"$ref": "#/components/schemas/PaymentStatusDto"
},
"isSent": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice has been sent."
},
"sellerReference": {
"type": [
"null",
"string"
],
"description": "Reference for the seller."
},
"invoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SalesInvoiceLineInputDto"
},
"description": "Collection of sales invoice lines."
}
},
"additionalProperties": false,
"description": "Represents input data for a sales invoice."
},
"SalesInvoiceLineInputDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the invoice line."
},
"invoicedQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
},
"lineExtensionAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"item": {
"$ref": "#/components/schemas/ItemInputDto"
},
"price": {
"$ref": "#/components/schemas/PriceInputDto"
},
"delivery": {
"$ref": "#/components/schemas/InvoiceLineDeliveryDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions for this line."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeInputDto"
},
"description": "Collection of allowances and charges on this line."
},
"subInvoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SubInvoiceLineInputDto"
},
"description": "Collection of sub-lines within this invoice line."
}
},
"additionalProperties": false,
"description": "Represents a line item on a sales invoice."
},
"SalesInvoicePartySummaryDto": {
"type": "object",
"properties": {
"partyIdentification": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/IdentifierDto"
},
"description": "Collection of identifiers for the party."
},
"partyName": {
"$ref": "#/components/schemas/PartyNameDto"
},
"partyLegalEntity": {
"$ref": "#/components/schemas/PartyLegalEntityDto"
}
},
"additionalProperties": false,
"description": "Represents a summarized party view for sales invoice listings."
},
"SalesInvoiceSummaryDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the invoice."
},
"dueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice payment is due. Format: yyyy-MM-dd."
},
"issueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice was issued. Format: yyyy-MM-dd."
},
"createdDateTime": {
"type": [
"null",
"string"
],
"description": "Date and time when the invoice was created."
},
"modifiedDateTime": {
"type": [
"null",
"string"
],
"description": "Date and time when the invoice was last modified."
},
"isSent": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice has been sent."
},
"accountingCustomerParty": {
"$ref": "#/components/schemas/CustomerPartySummaryDto"
},
"paymentTerms": {
"$ref": "#/components/schemas/PaymentTermsDto"
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes attached to the invoice (null if not available)."
},
"totalBalanceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"legalMonetaryTotal": {
"$ref": "#/components/schemas/LegalMonetaryTotalDto"
},
"paymentStatus": {
"$ref": "#/components/schemas/PaymentStatusDto"
}
},
"additionalProperties": false,
"description": "Represents a summary view of a sales invoice."
},
"SalesInvoiceSummaryDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SalesInvoiceSummaryDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"SellersItemIdentificationDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the item assigned by the seller."
},
"extendedId": {
"type": [
"null",
"string"
],
"description": "Extended identifier for the item assigned by the seller."
}
},
"additionalProperties": false,
"description": "Represents the seller's identification of an item."
},
"SubInvoiceLineDto": {
"type": "object",
"properties": {
"invoicedQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
},
"item": {
"$ref": "#/components/schemas/ItemDto"
}
},
"additionalProperties": false,
"description": "Represents a sub-line within an invoice line."
},
"SubInvoiceLineInputDto": {
"type": "object",
"properties": {
"invoicedQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
},
"item": {
"$ref": "#/components/schemas/ItemInputDto"
}
},
"additionalProperties": false,
"description": "Represents a sub-line within an invoice line."
},
"SupplierDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the supplier."
},
"customerAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"party": {
"$ref": "#/components/schemas/PartyDto"
},
"deliveryAddresses": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AddressDto"
},
"description": "Collection of delivery addresses for the supplier."
},
"description": {
"$ref": "#/components/schemas/NoteDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions assigned to the supplier."
},
"active": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the supplier is active."
},
"currency": {
"type": [
"null",
"string"
],
"description": "Currency code associated with the supplier."
},
"paymentMeans": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SupplierPaymentMeansDto"
},
"description": "Collection of payment means for the supplier."
}
},
"additionalProperties": false,
"description": "Represents a supplier entity in the accounting system."
},
"SupplierDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SupplierDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"SupplierInvoiceDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the invoice."
},
"buyerReference": {
"type": [
"null",
"string"
],
"description": "Reference for the buyer, usually the buyer's purchase order number."
},
"bookedInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is booked."
},
"cancelledInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is cancelled."
},
"issueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice was issued. Format: yyyy-MM-dd."
},
"issueTime": {
"type": [
"null",
"string"
],
"description": "Time when the invoice was issued (null if not available)."
},
"dueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice payment is due. Format: yyyy-MM-dd."
},
"creditInvoice": {
"$ref": "#/components/schemas/CreditInvoiceDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions associated with the invoice."
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes attached to the invoice."
},
"orderReference": {
"$ref": "#/components/schemas/OrderReferenceDto"
},
"documentCurrencyCode": {
"$ref": "#/components/schemas/DocumentCurrencyCodeDto"
},
"accountingSupplierParty": {
"$ref": "#/components/schemas/SupplierPartyDto"
},
"accountingCustomerParty": {
"$ref": "#/components/schemas/CustomerPartyDto"
},
"invoicePeriod": {
"$ref": "#/components/schemas/PeriodDto"
},
"delivery": {
"$ref": "#/components/schemas/DeliveryDto"
},
"deliveryTerms": {
"$ref": "#/components/schemas/DeliveryTermsDto"
},
"paymentTerms": {
"$ref": "#/components/schemas/PaymentTermsDto"
},
"paymentMeans": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/PaymentMeansDto"
},
"description": "Collection of payment means for the invoice."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeDto"
},
"description": "Collection of allowance and charge adjustments on the invoice."
},
"taxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxTotalDto"
},
"description": "Collection of tax totals for the invoice."
},
"withholdingTaxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/WithholdingTaxTotalDto"
},
"description": "Collection of withholding tax totals for the invoice."
},
"totalBalanceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"additionalDocumentReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AdditionalDocumentReferenceDto"
},
"description": "Collection of additional document references attached to the invoice."
},
"legalMonetaryTotal": {
"$ref": "#/components/schemas/LegalMonetaryTotalDto"
},
"paymentStatus": {
"$ref": "#/components/schemas/PaymentStatusDto"
},
"invoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SupplierInvoiceLineDto"
},
"description": "Collection of supplier invoice line items."
},
"sellerReference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned by the seller (null if not available)."
}
},
"additionalProperties": false,
"description": "Represents a supplier (purchase) invoice with full detail."
},
"SupplierInvoiceInputDto": {
"type": "object",
"properties": {
"reference": {
"type": [
"null",
"string"
],
"description": "Invoice number assigned by the sender."
},
"buyerReference": {
"type": [
"null",
"string"
],
"description": "Reference for the buyer (usually the buyer's purchase invoice number)."
},
"bookedInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is booked."
},
"cancelledInvoiceIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the invoice is cancelled."
},
"issueDate": {
"type": [
"null",
"string"
],
"description": "Issue date of the invoice."
},
"issueTime": {
"type": [
"null",
"string"
],
"description": "Issue time of the invoice."
},
"dueDate": {
"type": [
"null",
"string"
],
"description": "Due date for payment of the invoice."
},
"creditInvoice": {
"$ref": "#/components/schemas/CreditInvoiceInputDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions assigned to the invoice."
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes attached to the invoice."
},
"orderReference": {
"$ref": "#/components/schemas/OrderReferenceDto"
},
"documentCurrencyCode": {
"$ref": "#/components/schemas/DocumentCurrencyCodeDto"
},
"accountingSupplierParty": {
"$ref": "#/components/schemas/SupplierPartyInputDto"
},
"accountingCustomerParty": {
"$ref": "#/components/schemas/CustomerPartyInputDto"
},
"invoicePeriod": {
"$ref": "#/components/schemas/PeriodDto"
},
"delivery": {
"$ref": "#/components/schemas/DeliveryDto"
},
"deliveryTerms": {
"$ref": "#/components/schemas/DeliveryTermsDto"
},
"paymentTerms": {
"$ref": "#/components/schemas/PaymentTermsInputDto"
},
"paymentMeans": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/PaymentMeansInputDto"
},
"description": "Collection of payment means for the invoice."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeInputDto"
},
"description": "Collection of allowances and charges on the invoice."
},
"taxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxTotalInputDto"
},
"description": "Collection of tax totals for the invoice."
},
"withholdingTaxTotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/WithholdingTaxTotalInputDto"
},
"description": "Collection of withholding tax totals for the invoice."
},
"totalBalanceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"additionalDocumentReferences": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AdditionalDocumentReferenceDto"
},
"description": "Collection of additional document references."
},
"legalMonetaryTotal": {
"$ref": "#/components/schemas/LegalMonetaryTotalDto"
},
"paymentStatus": {
"$ref": "#/components/schemas/PaymentStatusDto"
},
"invoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SupplierInvoiceLineInputDto"
},
"description": "Collection of supplier invoice lines."
},
"sellerReference": {
"type": [
"null",
"string"
],
"description": "Reference for the seller."
}
},
"additionalProperties": false,
"description": "Represents input data for a supplier invoice."
},
"SupplierInvoiceLineDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the supplier invoice line."
},
"type": {
"type": [
"null",
"string"
],
"description": "Line type classification."
},
"account": {
"$ref": "#/components/schemas/AccountingAccountDto"
},
"invoicedQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
},
"lineExtensionAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"item": {
"$ref": "#/components/schemas/ItemDto"
},
"price": {
"$ref": "#/components/schemas/PriceDto"
},
"delivery": {
"$ref": "#/components/schemas/InvoiceLineDeliveryDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions for the line."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeDto"
},
"description": "Collection of allowances or charges applied to the line."
},
"subInvoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SubInvoiceLineDto"
},
"description": "Collection of sub-lines within this invoice line."
}
},
"additionalProperties": false,
"description": "Represents a single line item on a supplier invoice."
},
"SupplierInvoiceLineInputDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the invoice line."
},
"type": {
"type": [
"null",
"string"
],
"description": "Type classification of the invoice line."
},
"account": {
"$ref": "#/components/schemas/AccountingAccountInputDto"
},
"invoicedQuantity": {
"$ref": "#/components/schemas/InvoicedQuantityDto"
},
"lineExtensionAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"item": {
"$ref": "#/components/schemas/ItemInputDto"
},
"price": {
"$ref": "#/components/schemas/PriceInputDto"
},
"delivery": {
"$ref": "#/components/schemas/InvoiceLineDeliveryDto"
},
"financialDimensions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/FinancialDimensionDto"
},
"description": "Collection of financial dimensions for this line."
},
"allowanceCharges": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AllowanceChargeInputDto"
},
"description": "Collection of allowances and charges on this line."
},
"subInvoiceLines": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SubInvoiceLineInputDto"
},
"description": "Collection of sub-lines within this invoice line."
}
},
"additionalProperties": false,
"description": "Represents a line item on a supplier invoice."
},
"SupplierInvoiceSummaryDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier generated by the accounting system."
},
"reference": {
"type": [
"null",
"string"
],
"description": "External reference or number assigned to the invoice."
},
"dueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice payment is due. Format: yyyy-MM-dd."
},
"issueDate": {
"type": [
"null",
"string"
],
"description": "Date when the invoice was issued. Format: yyyy-MM-dd."
},
"createdDateTime": {
"type": [
"null",
"string"
],
"description": "Date and time when the invoice was created."
},
"modifiedDateTime": {
"type": [
"null",
"string"
],
"description": "Date and time when the invoice was last modified."
},
"accountingSupplierParty": {
"$ref": "#/components/schemas/SupplierPartySummaryDto"
},
"notes": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of notes attached to the invoice (null if not available)."
},
"totalBalanceAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"legalMonetaryTotal": {
"$ref": "#/components/schemas/LegalMonetaryTotalDto"
},
"paymentStatus": {
"$ref": "#/components/schemas/PaymentStatusDto"
}
},
"additionalProperties": false,
"description": "Represents a summary view of a supplier invoice."
},
"SupplierInvoiceSummaryDtoPagedResultDto": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/PagedResultMetadataDto"
},
"data": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/SupplierInvoiceSummaryDto"
},
"description": "Collection of items in the current page."
}
},
"additionalProperties": false,
"description": "Represents a paginated result containing metadata and a collection of items."
},
"SupplierPartyDto": {
"type": "object",
"properties": {
"customerAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"party": {
"$ref": "#/components/schemas/PartyDto"
}
},
"additionalProperties": false,
"description": "Represents the supplier party on an invoice."
},
"SupplierPartyInputDto": {
"type": "object",
"properties": {
"customerAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"party": {
"$ref": "#/components/schemas/PartyInputDto"
}
},
"additionalProperties": false,
"description": "Represents the supplier party on an invoice."
},
"SupplierPartySummaryDto": {
"type": "object",
"properties": {
"customerAssignedAccountId": {
"$ref": "#/components/schemas/IdentifierDto"
},
"party": {
"$ref": "#/components/schemas/PartySummaryDto"
}
},
"additionalProperties": false,
"description": "Represents a summarized supplier party view for invoice listings."
},
"SupplierPaymentMeansDto": {
"type": "object",
"properties": {
"paymentChannelCode": {
"type": [
"null",
"string"
],
"description": "Code identifying the payment channel."
},
"payeeFinancialAccounts": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/PayeeFinancialAccountDto"
},
"description": "Collection of payee financial accounts. Obsolete: use FinancialAccount instead. (Deprecated: Use PayeeFinancialAccount instead)",
"deprecated": true
},
"payeeFinancialAccount": {
"type": [
"null",
"string"
],
"description": "Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)",
"deprecated": true
},
"financialAccount": {
"$ref": "#/components/schemas/FinancialAccountDto"
}
},
"additionalProperties": false,
"description": "Represents payment means associated with a supplier."
},
"TaxCategoryDto": {
"type": "object",
"properties": {
"percent": {
"type": "number",
"description": "Tax rate percentage for this category.",
"format": "double"
},
"taxScheme": {
"$ref": "#/components/schemas/TaxSchemeDto"
},
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the tax category."
}
},
"additionalProperties": false,
"description": "Represents a tax category with its percentage rate and scheme."
},
"TaxCategoryTaxSchemeDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the tax scheme."
}
},
"additionalProperties": false,
"description": "Represents the tax scheme associated with a tax category."
},
"TaxSchemeDto": {
"type": "object",
"properties": {
"taxSchemeId": {
"$ref": "#/components/schemas/IdentifierDto"
}
},
"additionalProperties": false,
"description": "Represents a tax scheme."
},
"TaxSubtotalDto": {
"type": "object",
"properties": {
"taxableAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxCategory": {
"$ref": "#/components/schemas/TaxSubtotalTaxCategoryDto"
}
},
"additionalProperties": false,
"description": "Represents a tax subtotal within a tax total."
},
"TaxSubtotalTaxCategoryDto": {
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"description": "Unique identifier for the tax category."
},
"percent": {
"type": [
"null",
"number"
],
"description": "Tax rate percentage for this category.",
"format": "double"
},
"taxScheme": {
"$ref": "#/components/schemas/TaxCategoryTaxSchemeDto"
},
"taxExemptionReason": {
"type": [
"null",
"string"
],
"description": "Reason for tax exemption, if applicable."
},
"taxExemptionReasonCode": {
"type": [
"null",
"string"
],
"description": "Code identifying the tax exemption reason."
}
},
"additionalProperties": false,
"description": "Represents the tax category details within a tax subtotal."
},
"TaxTotalDto": {
"type": "object",
"properties": {
"taxAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxIncludedIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the tax is included in the line amounts."
},
"taxSubtotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxSubtotalDto"
},
"description": "Collection of tax subtotals broken down by category."
}
},
"additionalProperties": false,
"description": "Represents the total tax amount for an invoice or line item."
},
"TaxTotalInputDto": {
"type": "object",
"properties": {
"taxAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxIncludedIndicator": {
"type": [
"null",
"boolean"
],
"description": "Indicates whether the tax is included in the line amounts."
},
"taxSubtotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxSubtotalDto"
},
"description": "Collection of tax subtotals composing this tax total."
}
},
"additionalProperties": false,
"description": "Represents the total tax amount for an invoice or line."
},
"TrialBalanceCategoryDto": {
"type": "object",
"properties": {
"descriptions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NoteDto"
},
"description": "Collection of descriptions for the category."
},
"endingBalance": {
"$ref": "#/components/schemas/FinancialReportBalanceDto"
},
"accountMovement": {
"$ref": "#/components/schemas/FinancialReportBalanceDto"
},
"subCategories": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TrialBalanceCategoryDto"
},
"description": "Collection of child categories within this category."
},
"accounts": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AccountTrialBalanceDto"
},
"description": "Collection of account-level trial balance entries within this category."
}
},
"additionalProperties": false,
"description": "Represents a category within a trial balance report, supporting hierarchical sub-categories."
},
"TrialBalancesDto": {
"type": "object",
"properties": {
"trialBalancePeriod": {
"$ref": "#/components/schemas/PeriodDto"
},
"financialReport": {
"$ref": "#/components/schemas/TrialBalancesFinancialReportDto"
}
},
"additionalProperties": false,
"description": "Represents a trial balance report for a given period."
},
"TrialBalancesFinancialReportDto": {
"type": "object",
"properties": {
"accounts": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/AccountTrialBalanceDto"
},
"description": "Collection of account-level trial balance entries."
},
"categories": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TrialBalanceCategoryDto"
},
"description": "Collection of trial balance categories."
}
},
"additionalProperties": false,
"description": "Represents the financial report structure for a trial balance."
},
"WithholdingTaxTotalDto": {
"type": "object",
"properties": {
"taxAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxSubtotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxSubtotalDto"
},
"description": "Collection of withholding tax subtotals broken down by category."
}
},
"additionalProperties": false,
"description": "Represents the total withholding tax amount for an invoice."
},
"WithholdingTaxTotalInputDto": {
"type": "object",
"properties": {
"taxAmount": {
"$ref": "#/components/schemas/AmountTypeDto"
},
"taxSubtotals": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TaxSubtotalDto"
},
"description": "Collection of tax subtotals composing this withholding tax total."
}
},
"additionalProperties": false,
"description": "Represents the total withholding tax amount for an invoice."
}
},
"securitySchemes": {
"ApiKey": {
"type": "apiKey",
"description": "Use the API key to access all API endpoints.",
"name": "x-api-key",
"in": "header"
}
}
},
"security": [
{
"ApiKey": []
}
],
"tags": [
{
"name": "Accounting Accounts",
"description": "Retrieve the chart of accounts (accounting accounts) for a given consent."
},
{
"name": "Accounting Periods",
"description": "Retrieve accounting periods (fiscal years) for a given consent."
},
{
"name": "Balance Sheet",
"description": "Retrieve balance sheet reports for a given consent."
},
{
"name": "Company Information",
"description": "Retrieve company information for a given consent."
},
{
"name": "Customers",
"description": "Retrieve customer records for a given consent."
},
{
"name": "Financial Dimensions",
"description": "Retrieve financial dimensions (cost centers, projects, etc.) for a given consent."
},
{
"name": "Income Statement",
"description": "Retrieve income statement (profit & loss) reports for a given consent."
},
{
"name": "Journals",
"description": "Create and retrieve journal entries for a given consent."
},
{
"name": "Journals - Attachments",
"description": "Retrieve attachments associated with journal entries."
},
{
"name": "Proxy.1",
"description": "Proxy raw requests to the underlying accounting system."
},
{
"name": "Sales Invoices",
"description": "Create and retrieve sales invoices for a given consent."
},
{
"name": "Sales Invoices - Attachments",
"description": "Create and retrieve attachments for sales invoices, including printable invoice PDFs."
},
{
"name": "Sales Invoices - Notes",
"description": "Add notes to sales invoices."
},
{
"name": "Sales Invoices - Payments",
"description": "Create and retrieve payment records for sales invoices."
},
{
"name": "Supplier Invoices",
"description": "Create and retrieve supplier (purchase) invoices for a given consent."
},
{
"name": "Supplier Invoices - Attachments",
"description": "Create and retrieve attachments for supplier invoices."
},
{
"name": "Supplier Invoices - Payments",
"description": "Create and retrieve payment records for supplier invoices."
},
{
"name": "Suppliers",
"description": "Retrieve supplier records for a given consent."
},
{
"name": "Trial Balances",
"description": "Retrieve trial balance reports for a given consent."
}
]
}