--- updatedAt: 2026-04-28T12:24:42.000Z agentTools: projectIndex: https://developer.candis.io/llms.txt --- # List reimbursement items of the organization # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/v1/organizations/{organizationId}/reimbursement-items": { "get": { "operationId": "listReimbursementItems", "parameters": [ { "name": "organizationId", "required": true, "in": "path", "description": "The organization ID.", "schema": { "example": "alpha-organization", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "The offset of the first element in the list.", "schema": { "minimum": 0, "default": 0, "example": 0, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of elements to return.", "schema": { "minimum": 1, "default": 50, "example": 50, "type": "number" } }, { "name": "sortField", "required": false, "in": "query", "description": "The field to sort by.", "schema": { "type": "string", "enum": [ "REIMBURSEMENT_ITEM_DATE", "UPDATED_AT" ] } }, { "name": "sortDirection", "required": false, "in": "query", "description": "The direction to sort by.", "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "status", "required": false, "in": "query", "description": "Current status of the reimbursement item. Comma separated values.", "schema": { "type": "string", "enum": [ "APPROVED", "EXPORTED" ] } }, { "name": "types", "required": false, "in": "query", "description": "Type of the reimbursement item. Comma separated values.", "schema": { "type": "string", "enum": [ "GENERAL_EXPENSE", "HOSPITALITY_EXPENSE", "PER_DIEM", "MILEAGE" ] } }, { "name": "reimbursementItemDateFrom", "required": false, "in": "query", "description": "From date and time for reimbursement item date.", "schema": { "example": "2024-01-01T12:00:00Z", "type": "string" } }, { "name": "reimbursementItemDateTo", "required": false, "in": "query", "description": "To date and time for reimbursement item date.", "schema": { "example": "2024-01-01T12:00:00Z", "type": "string" } }, { "name": "updatedAtFrom", "required": false, "in": "query", "description": "From date and time when the reimbursement item was updated.", "schema": { "example": "2024-01-01T12:00:00Z", "type": "string" } }, { "name": "updatedAtTo", "required": false, "in": "query", "description": "To date and time when the reimbursement item was updated.", "schema": { "example": "2024-01-01T12:00:00Z", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "reimbursementItems": { "type": "array", "description": "Records of reimbursement items.", "items": { "oneOf": [ { "title": "Hospitality Expense", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "status": { "allOf": [ { "type": "string", "enum": [ "APPROVED", "EXPORTED" ] } ] }, "createdAt": { "type": "string", "description": "Created at.", "example": "2024-01-01T12:00:00Z" }, "updatedAt": { "type": "string", "description": "Updated at.", "example": "2024-01-01T12:00:00Z" }, "title": { "type": "string", "description": "Title of the reimbursement item.", "example": "Reimbursement Item Title" }, "totalAmount": { "description": "Total amount of the reimbursement item.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" }, "baseAmount": { "type": "number", "description": "Amount after currency conversion to base currency (EUR)", "nullable": true }, "baseCurrency": { "type": "string", "description": "Base currency for conversion", "nullable": true }, "exchangeRate": { "type": "number", "description": "Exchange rate used for currency conversion", "nullable": true }, "exchangeRateDate": { "type": "string", "description": "Date for exchange rate calculation", "nullable": true } }, "required": [ "amount", "currency" ] } ] }, "reimbursementCase": { "description": "Reimbursement item case.", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item case.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "title": { "type": "string", "description": "Title of the reimbursement item case.", "example": "Reimbursement Item Case Title" }, "submittedForReviewAt": { "type": "string", "description": "Submitted for review at.", "example": "2024-01-01T12:00:00Z" } }, "required": [ "id", "title", "submittedForReviewAt" ] } ] }, "contact": { "description": "Contact of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "Contact name", "example": "John Doe" }, "accountsPayableNumber": { "type": "string", "description": "Contact payable number", "example": "K1349234", "nullable": true }, "paymentInfo": { "type": "object", "properties": { "iban": { "type": "string", "description": "IBAN", "example": "DE12345678901234567890" }, "swiftCode": { "type": "string", "description": "SWIFT code", "example": "BIC123456789", "nullable": true }, "bankAccountNumber": { "type": "string", "description": "Bank account number", "example": "1234567890", "nullable": true }, "accountHolder": { "type": "string", "description": "Account holder", "example": "John Doe", "nullable": true } }, "required": [ "iban" ] } } } ] }, "bookings": { "description": "Bookings of the reimbursement item.", "type": "array", "items": { "type": "object", "properties": { "dueDate": { "type": "string", "description": "Discount payment date", "example": "2022-09-15T22:00:00.000Z", "nullable": true }, "amount": { "type": "number", "description": "Amount in original currency.", "example": 2784 }, "baseAmount": { "type": "number", "description": "Amount in base currency (EUR).", "example": 2784, "nullable": true }, "costCenter": { "description": "Cost center", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "costObject": { "description": "Cost object", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "generalLedgerAccount": { "description": "General ledger account", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "accountCode": { "type": "string", "description": "General ledger account code", "example": "1100" }, "name": { "type": "string", "description": "General ledger account name", "example": "electricity" } }, "required": [ "accountCode", "name" ] } ] }, "extraCostInfo": { "description": "Extra cost info", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "artistSocialInsuranceCode": { "type": "string", "description": "Artist social insurance code.", "example": "W", "nullable": true }, "bookingKey": { "description": "Booking key", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "taxCode": { "type": "string", "description": "Tax Code", "example": "40" }, "description": { "type": "string", "description": "Tax code description", "example": "Tax Code 40" } }, "required": [ "taxCode", "description" ] } ] }, "vatRate": { "type": "number", "description": "Vat rate", "nullable": true }, "note": { "type": "string", "description": "Note", "example": "This is a note.", "nullable": true }, "postingText": { "type": "string", "description": "Posting text", "example": "This is a posting text.", "nullable": true } }, "required": [ "amount" ] } }, "invoiceNumber": { "type": "string", "description": "Invoice number of the reimbursement item.", "example": "1234567890" }, "expenseDate": { "type": "string", "description": "Expense date of the reimbursement item.", "example": "2024-01-01T12:00:00Z" }, "type": { "type": "string", "enum": [ "HOSPITALITY_EXPENSE" ] }, "location": { "type": "string", "description": "Location of the reimbursement item.", "example": "Berlin", "nullable": true }, "internalGuests": { "description": "Internal guests of the reimbursement item.", "example": [ "John Doe", "Jane Doe" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "externalGuests": { "description": "External guests of the reimbursement item.", "example": [ "John Doe", "Jane Doe" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "tipAmount": { "description": "Tip amount of the reimbursement item.", "example": 10000, "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" }, "baseAmount": { "type": "number", "description": "Amount after currency conversion to base currency (EUR)", "nullable": true }, "baseCurrency": { "type": "string", "description": "Base currency for conversion", "nullable": true }, "exchangeRate": { "type": "number", "description": "Exchange rate used for currency conversion", "nullable": true }, "exchangeRateDate": { "type": "string", "description": "Date for exchange rate calculation", "nullable": true } }, "required": [ "amount", "currency" ] } ] }, "receiptAmount": { "description": "Receipt amount of the reimbursement item.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" }, "baseAmount": { "type": "number", "description": "Amount after currency conversion to base currency (EUR)", "nullable": true }, "baseCurrency": { "type": "string", "description": "Base currency for conversion", "nullable": true }, "exchangeRate": { "type": "number", "description": "Exchange rate used for currency conversion", "nullable": true }, "exchangeRateDate": { "type": "string", "description": "Date for exchange rate calculation", "nullable": true } }, "required": [ "amount", "currency" ] } ] } }, "required": [ "id", "status", "createdAt", "updatedAt", "title", "totalAmount", "reimbursementCase", "contact", "bookings", "invoiceNumber", "expenseDate", "type", "receiptAmount" ] }, { "title": "General Expense", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "status": { "allOf": [ { "type": "string", "enum": [ "APPROVED", "EXPORTED" ] } ] }, "createdAt": { "type": "string", "description": "Created at.", "example": "2024-01-01T12:00:00Z" }, "updatedAt": { "type": "string", "description": "Updated at.", "example": "2024-01-01T12:00:00Z" }, "title": { "type": "string", "description": "Title of the reimbursement item.", "example": "Reimbursement Item Title" }, "totalAmount": { "description": "Total amount of the reimbursement item.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" }, "baseAmount": { "type": "number", "description": "Amount after currency conversion to base currency (EUR)", "nullable": true }, "baseCurrency": { "type": "string", "description": "Base currency for conversion", "nullable": true }, "exchangeRate": { "type": "number", "description": "Exchange rate used for currency conversion", "nullable": true }, "exchangeRateDate": { "type": "string", "description": "Date for exchange rate calculation", "nullable": true } }, "required": [ "amount", "currency" ] } ] }, "reimbursementCase": { "description": "Reimbursement item case.", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item case.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "title": { "type": "string", "description": "Title of the reimbursement item case.", "example": "Reimbursement Item Case Title" }, "submittedForReviewAt": { "type": "string", "description": "Submitted for review at.", "example": "2024-01-01T12:00:00Z" } }, "required": [ "id", "title", "submittedForReviewAt" ] } ] }, "contact": { "description": "Contact of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "Contact name", "example": "John Doe" }, "accountsPayableNumber": { "type": "string", "description": "Contact payable number", "example": "K1349234", "nullable": true }, "paymentInfo": { "type": "object", "properties": { "iban": { "type": "string", "description": "IBAN", "example": "DE12345678901234567890" }, "swiftCode": { "type": "string", "description": "SWIFT code", "example": "BIC123456789", "nullable": true }, "bankAccountNumber": { "type": "string", "description": "Bank account number", "example": "1234567890", "nullable": true }, "accountHolder": { "type": "string", "description": "Account holder", "example": "John Doe", "nullable": true } }, "required": [ "iban" ] } } } ] }, "bookings": { "description": "Bookings of the reimbursement item.", "type": "array", "items": { "type": "object", "properties": { "dueDate": { "type": "string", "description": "Discount payment date", "example": "2022-09-15T22:00:00.000Z", "nullable": true }, "amount": { "type": "number", "description": "Amount in original currency.", "example": 2784 }, "baseAmount": { "type": "number", "description": "Amount in base currency (EUR).", "example": 2784, "nullable": true }, "costCenter": { "description": "Cost center", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "costObject": { "description": "Cost object", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "generalLedgerAccount": { "description": "General ledger account", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "accountCode": { "type": "string", "description": "General ledger account code", "example": "1100" }, "name": { "type": "string", "description": "General ledger account name", "example": "electricity" } }, "required": [ "accountCode", "name" ] } ] }, "extraCostInfo": { "description": "Extra cost info", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "artistSocialInsuranceCode": { "type": "string", "description": "Artist social insurance code.", "example": "W", "nullable": true }, "bookingKey": { "description": "Booking key", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "taxCode": { "type": "string", "description": "Tax Code", "example": "40" }, "description": { "type": "string", "description": "Tax code description", "example": "Tax Code 40" } }, "required": [ "taxCode", "description" ] } ] }, "vatRate": { "type": "number", "description": "Vat rate", "nullable": true }, "note": { "type": "string", "description": "Note", "example": "This is a note.", "nullable": true }, "postingText": { "type": "string", "description": "Posting text", "example": "This is a posting text.", "nullable": true } }, "required": [ "amount" ] } }, "invoiceNumber": { "type": "string", "description": "Invoice number of the reimbursement item.", "example": "1234567890" }, "expenseDate": { "type": "string", "description": "Expense date of the reimbursement item.", "example": "2024-01-01T12:00:00Z" }, "type": { "type": "string", "enum": [ "GENERAL_EXPENSE" ] } }, "required": [ "id", "status", "createdAt", "updatedAt", "title", "totalAmount", "reimbursementCase", "contact", "bookings", "invoiceNumber", "expenseDate", "type" ] }, { "title": "Per Diem", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "status": { "allOf": [ { "type": "string", "enum": [ "APPROVED", "EXPORTED" ] } ] }, "createdAt": { "type": "string", "description": "Created at.", "example": "2024-01-01T12:00:00Z" }, "updatedAt": { "type": "string", "description": "Updated at.", "example": "2024-01-01T12:00:00Z" }, "title": { "type": "string", "description": "Title of the reimbursement item.", "example": "Reimbursement Item Title" }, "totalAmount": { "description": "Total amount of the reimbursement item.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" }, "baseAmount": { "type": "number", "description": "Amount after currency conversion to base currency (EUR)", "nullable": true }, "baseCurrency": { "type": "string", "description": "Base currency for conversion", "nullable": true }, "exchangeRate": { "type": "number", "description": "Exchange rate used for currency conversion", "nullable": true }, "exchangeRateDate": { "type": "string", "description": "Date for exchange rate calculation", "nullable": true } }, "required": [ "amount", "currency" ] } ] }, "reimbursementCase": { "description": "Reimbursement item case.", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item case.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "title": { "type": "string", "description": "Title of the reimbursement item case.", "example": "Reimbursement Item Case Title" }, "submittedForReviewAt": { "type": "string", "description": "Submitted for review at.", "example": "2024-01-01T12:00:00Z" } }, "required": [ "id", "title", "submittedForReviewAt" ] } ] }, "contact": { "description": "Contact of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "Contact name", "example": "John Doe" }, "accountsPayableNumber": { "type": "string", "description": "Contact payable number", "example": "K1349234", "nullable": true }, "paymentInfo": { "type": "object", "properties": { "iban": { "type": "string", "description": "IBAN", "example": "DE12345678901234567890" }, "swiftCode": { "type": "string", "description": "SWIFT code", "example": "BIC123456789", "nullable": true }, "bankAccountNumber": { "type": "string", "description": "Bank account number", "example": "1234567890", "nullable": true }, "accountHolder": { "type": "string", "description": "Account holder", "example": "John Doe", "nullable": true } }, "required": [ "iban" ] } } } ] }, "bookings": { "description": "Bookings of the reimbursement item.", "type": "array", "items": { "type": "object", "properties": { "dueDate": { "type": "string", "description": "Discount payment date", "example": "2022-09-15T22:00:00.000Z", "nullable": true }, "amount": { "type": "number", "description": "Amount in original currency.", "example": 2784 }, "baseAmount": { "type": "number", "description": "Amount in base currency (EUR).", "example": 2784, "nullable": true }, "costCenter": { "description": "Cost center", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "costObject": { "description": "Cost object", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "generalLedgerAccount": { "description": "General ledger account", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "accountCode": { "type": "string", "description": "General ledger account code", "example": "1100" }, "name": { "type": "string", "description": "General ledger account name", "example": "electricity" } }, "required": [ "accountCode", "name" ] } ] }, "extraCostInfo": { "description": "Extra cost info", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "artistSocialInsuranceCode": { "type": "string", "description": "Artist social insurance code.", "example": "W", "nullable": true }, "bookingKey": { "description": "Booking key", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "taxCode": { "type": "string", "description": "Tax Code", "example": "40" }, "description": { "type": "string", "description": "Tax code description", "example": "Tax Code 40" } }, "required": [ "taxCode", "description" ] } ] }, "vatRate": { "type": "number", "description": "Vat rate", "nullable": true }, "note": { "type": "string", "description": "Note", "example": "This is a note.", "nullable": true }, "postingText": { "type": "string", "description": "Posting text", "example": "This is a posting text.", "nullable": true } }, "required": [ "amount" ] } }, "invoiceNumber": { "type": "string", "description": "Invoice number of the reimbursement item.", "example": "1234567890" }, "expenseDate": { "type": "string", "description": "Expense date of the reimbursement item.", "example": "2024-01-01T12:00:00Z" }, "type": { "type": "string", "enum": [ "PER_DIEM" ] }, "segments": { "description": "Segments of the reimbursement item.", "type": "array", "items": { "type": "object", "properties": { "startAt": { "type": "string", "description": "Start at of the reimbursement item segment.", "example": "2024-01-01T12:00:00Z" }, "endAt": { "type": "string", "description": "End at of the reimbursement item segment.", "example": "2024-01-01T12:00:00Z" }, "location": { "description": "Location of the reimbursement item segment.", "allOf": [ { "type": "object", "properties": { "region": { "description": "Region of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "en": { "type": "string", "description": "English translation.", "example": "English" }, "de": { "type": "string", "description": "German translation.", "example": "German" } }, "required": [ "en", "de" ] } ] }, "countryIsoCode": { "type": "string", "description": "Country ISO code of the reimbursement item.", "example": "DE" }, "country": { "description": "Country of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "en": { "type": "string", "description": "English translation.", "example": "English" }, "de": { "type": "string", "description": "German translation.", "example": "German" } }, "required": [ "en", "de" ] } ] }, "location": { "description": "Location of the reimbursement item.", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "en": { "type": "string", "description": "English translation.", "example": "English" }, "de": { "type": "string", "description": "German translation.", "example": "German" } }, "required": [ "en", "de" ] } ] } }, "required": [ "region", "countryIsoCode", "country" ] } ] } }, "required": [ "startAt", "endAt", "location" ] } }, "days": { "description": "Days of the reimbursement item.", "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Date of the reimbursement item day.", "example": "2024-01-01T12:00:00Z" }, "numberOfMinutes": { "type": "number", "description": "Number of minutes of the reimbursement item day.", "example": 100 }, "dayRate": { "description": "Day rate of the reimbursement item day.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" } }, "required": [ "amount", "currency" ] } ] }, "reimbursableRate": { "description": "Reimbursable rate of the reimbursement item day.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" } }, "required": [ "amount", "currency" ] } ] }, "location": { "description": "Location of the reimbursement item day.", "allOf": [ { "type": "object", "properties": { "region": { "description": "Region of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "en": { "type": "string", "description": "English translation.", "example": "English" }, "de": { "type": "string", "description": "German translation.", "example": "German" } }, "required": [ "en", "de" ] } ] }, "countryIsoCode": { "type": "string", "description": "Country ISO code of the reimbursement item.", "example": "DE" }, "country": { "description": "Country of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "en": { "type": "string", "description": "English translation.", "example": "English" }, "de": { "type": "string", "description": "German translation.", "example": "German" } }, "required": [ "en", "de" ] } ] }, "location": { "description": "Location of the reimbursement item.", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "en": { "type": "string", "description": "English translation.", "example": "English" }, "de": { "type": "string", "description": "German translation.", "example": "German" } }, "required": [ "en", "de" ] } ] } }, "required": [ "region", "countryIsoCode", "country" ] } ] }, "providedBreakfast": { "type": "boolean", "description": "Provided breakfast of the reimbursement item day.", "example": true }, "providedLunch": { "type": "boolean", "description": "Provided lunch of the reimbursement item day.", "example": true }, "providedDinner": { "type": "boolean", "description": "Provided dinner of the reimbursement item day.", "example": true }, "providedAccommodation": { "type": "boolean", "description": "Provided accommodation of the reimbursement item day.", "example": true, "nullable": true } }, "required": [ "date", "numberOfMinutes", "dayRate", "reimbursableRate", "location", "providedBreakfast", "providedLunch", "providedDinner" ] } } }, "required": [ "id", "status", "createdAt", "updatedAt", "title", "totalAmount", "reimbursementCase", "contact", "bookings", "invoiceNumber", "expenseDate", "type", "segments", "days" ] }, { "title": "Mileage", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "status": { "allOf": [ { "type": "string", "enum": [ "APPROVED", "EXPORTED" ] } ] }, "createdAt": { "type": "string", "description": "Created at.", "example": "2024-01-01T12:00:00Z" }, "updatedAt": { "type": "string", "description": "Updated at.", "example": "2024-01-01T12:00:00Z" }, "title": { "type": "string", "description": "Title of the reimbursement item.", "example": "Reimbursement Item Title" }, "totalAmount": { "description": "Total amount of the reimbursement item.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" }, "baseAmount": { "type": "number", "description": "Amount after currency conversion to base currency (EUR)", "nullable": true }, "baseCurrency": { "type": "string", "description": "Base currency for conversion", "nullable": true }, "exchangeRate": { "type": "number", "description": "Exchange rate used for currency conversion", "nullable": true }, "exchangeRateDate": { "type": "string", "description": "Date for exchange rate calculation", "nullable": true } }, "required": [ "amount", "currency" ] } ] }, "reimbursementCase": { "description": "Reimbursement item case.", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the reimbursement item case.", "example": "8341a018-6196-47cb-8fa2-3ad40983be24" }, "title": { "type": "string", "description": "Title of the reimbursement item case.", "example": "Reimbursement Item Case Title" }, "submittedForReviewAt": { "type": "string", "description": "Submitted for review at.", "example": "2024-01-01T12:00:00Z" } }, "required": [ "id", "title", "submittedForReviewAt" ] } ] }, "contact": { "description": "Contact of the reimbursement item.", "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "Contact name", "example": "John Doe" }, "accountsPayableNumber": { "type": "string", "description": "Contact payable number", "example": "K1349234", "nullable": true }, "paymentInfo": { "type": "object", "properties": { "iban": { "type": "string", "description": "IBAN", "example": "DE12345678901234567890" }, "swiftCode": { "type": "string", "description": "SWIFT code", "example": "BIC123456789", "nullable": true }, "bankAccountNumber": { "type": "string", "description": "Bank account number", "example": "1234567890", "nullable": true }, "accountHolder": { "type": "string", "description": "Account holder", "example": "John Doe", "nullable": true } }, "required": [ "iban" ] } } } ] }, "bookings": { "description": "Bookings of the reimbursement item.", "type": "array", "items": { "type": "object", "properties": { "dueDate": { "type": "string", "description": "Discount payment date", "example": "2022-09-15T22:00:00.000Z", "nullable": true }, "amount": { "type": "number", "description": "Amount in original currency.", "example": 2784 }, "baseAmount": { "type": "number", "description": "Amount in base currency (EUR).", "example": 2784, "nullable": true }, "costCenter": { "description": "Cost center", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "costObject": { "description": "Cost object", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "generalLedgerAccount": { "description": "General ledger account", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "accountCode": { "type": "string", "description": "General ledger account code", "example": "1100" }, "name": { "type": "string", "description": "General ledger account name", "example": "electricity" } }, "required": [ "accountCode", "name" ] } ] }, "extraCostInfo": { "description": "Extra cost info", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "KOST2" }, "name": { "type": "string", "example": "booking-1-cs-2-name" } }, "required": [ "code" ] } ] }, "artistSocialInsuranceCode": { "type": "string", "description": "Artist social insurance code.", "example": "W", "nullable": true }, "bookingKey": { "description": "Booking key", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "taxCode": { "type": "string", "description": "Tax Code", "example": "40" }, "description": { "type": "string", "description": "Tax code description", "example": "Tax Code 40" } }, "required": [ "taxCode", "description" ] } ] }, "vatRate": { "type": "number", "description": "Vat rate", "nullable": true }, "note": { "type": "string", "description": "Note", "example": "This is a note.", "nullable": true }, "postingText": { "type": "string", "description": "Posting text", "example": "This is a posting text.", "nullable": true } }, "required": [ "amount" ] } }, "invoiceNumber": { "type": "string", "description": "Invoice number of the reimbursement item.", "example": "1234567890" }, "expenseDate": { "type": "string", "description": "Expense date of the reimbursement item.", "example": "2024-01-01T12:00:00Z" }, "type": { "type": "string", "enum": [ "MILEAGE" ] }, "locations": { "description": "Locations of the reimbursement item.", "type": "array", "items": { "type": "object", "properties": { "en": { "type": "string", "description": "English translation.", "example": "English" }, "de": { "type": "string", "description": "German translation.", "example": "German" } }, "required": [ "en", "de" ] } }, "applicableRate": { "description": "Applicable rate of the reimbursement item.", "example": 10000, "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "description": "Original amount before currency conversion" }, "currency": { "type": "string", "description": "Original currency before conversion to base currency" } }, "required": [ "amount", "currency" ] } ] }, "distanceOverride": { "description": "Distance override of the reimbursement item.", "nullable": true, "type": "object", "allOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enabled of the reimbursement item.", "example": true, "nullable": true }, "distanceInKm": { "type": "number", "description": "Distance in km of the reimbursement item.", "example": 100, "nullable": true }, "reason": { "type": "string", "description": "Reason of the reimbursement item.", "example": "Reason for the distance override", "nullable": true } } } ] }, "vehicleType": { "description": "Vehicle type of the reimbursement item.", "allOf": [ { "type": "string", "enum": [ "CAR", "MOTORBIKE" ], "description": "Vehicle type of the reimbursement item." } ] }, "calculatedDistanceInKm": { "type": "number", "description": "Calculated distance in km of the reimbursement item.", "example": 100 }, "isRoundTrip": { "type": "boolean", "description": "Is round trip of the reimbursement item.", "example": true } }, "required": [ "id", "status", "createdAt", "updatedAt", "title", "totalAmount", "reimbursementCase", "contact", "bookings", "invoiceNumber", "expenseDate", "type", "locations", "applicableRate", "vehicleType", "calculatedDistanceInKm", "isRoundTrip" ] } ] } }, "pagination": { "description": "Pagination Data providing information and the record count, page size and total count", "allOf": [ { "type": "object", "properties": { "pageCount": { "type": "number", "example": 10, "description": "This is the total number of pages available with records" }, "pageSize": { "type": "number", "example": 50, "description": "This is the length of size of the current page" }, "totalCount": { "type": "number", "example": 500, "description": "This is the total count of export records available" } }, "required": [ "pageCount", "pageSize", "totalCount" ] } ] } }, "required": [ "reimbursementItems", "pagination" ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The Error Code assigned to the issue encountered", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "BAD_REQUEST", "SERVICE_UNAVAILABLE", "INTERNAL_SERVER_ERROR", "MISSING_REQUESTER_ID", "BAD_INPUT", "NOT_FOUND", "EXPORTABLE_POSTINGS_NOT_FOUND", "TOO_MANY_REQUEST", "FAILED_TO_FETCH_DOWNLOAD_URL", "FILE_NOT_FOUND" ] }, "message": { "type": "string", "description": "Description about the issue encountered" }, "requestId": { "type": "string", "description": "This is the unique identifier for the request." }, "errors": { "description": "This is an optional output that can provide more details about the input parameters that may have caused an issue.", "type": "array", "items": { "type": "object", "properties": { "index": { "type": "string", "description": "This identifies the index of the payload that has an issue." }, "property": { "type": "string", "description": "This identifies the parameter that has an issue." }, "messages": { "description": "This provides more details about the parameter that has an issue.", "type": "array", "items": { "type": "string" } } }, "required": [ "property", "messages" ] } } }, "required": [ "errorCode", "message" ] } } } }, "429": { "description": "The request limit for this organization, or for its holding, has been exceeded.\n\nSee the [Rate Limiting Policy](https://developer.candis.io/docs/rate-limiting-policy) for the limits, response headers and retry guidance.", "headers": { "Retry-After": { "description": "Whole seconds to wait before retrying. See the Rate Limiting Policy for how the value is derived.", "schema": { "type": "integer", "example": 42 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The Error Code assigned to the issue encountered", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "BAD_REQUEST", "SERVICE_UNAVAILABLE", "INTERNAL_SERVER_ERROR", "MISSING_REQUESTER_ID", "BAD_INPUT", "NOT_FOUND", "EXPORTABLE_POSTINGS_NOT_FOUND", "TOO_MANY_REQUEST", "FAILED_TO_FETCH_DOWNLOAD_URL", "FILE_NOT_FOUND" ] }, "message": { "type": "string", "description": "Description about the issue encountered" }, "requestId": { "type": "string", "description": "This is the unique identifier for the request." }, "limit": { "type": "string", "description": "Which limit rejected the request: the request limit, which counts requests, or the record limit, which meters the records in the request body.", "enum": [ "request", "record" ] }, "scope": { "type": "string", "description": "Whose allowance was exhausted: the organization’s own, or the shared allowance of the holding it belongs to.", "enum": [ "organization", "holding" ] } }, "required": [ "errorCode", "message" ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The Error Code assigned to the issue encountered", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "BAD_REQUEST", "SERVICE_UNAVAILABLE", "INTERNAL_SERVER_ERROR", "MISSING_REQUESTER_ID", "BAD_INPUT", "NOT_FOUND", "EXPORTABLE_POSTINGS_NOT_FOUND", "TOO_MANY_REQUEST", "FAILED_TO_FETCH_DOWNLOAD_URL", "FILE_NOT_FOUND" ] }, "message": { "type": "string", "description": "Description about the issue encountered" }, "requestId": { "type": "string", "description": "This is the unique identifier for the request." } }, "required": [ "errorCode", "message" ] } } } } }, "security": [ { "bearer": [] } ], "summary": "List reimbursement items of the organization", "tags": [ "Reimbursements" ] } } }, "info": { "title": "Candis API", "version": "1.0", "description": "", "contact": {}, "x-logo": { "url": "https://www.candis.io/img/candis-logo-black.svg", "altText": "Candis GmbH" } }, "servers": [ { "url": "https://api.candis.io" }, { "description": "Candis API Authorization Server.", "url": "https://id.my.candis.io/auth/realms/candis/protocol/openid-connect" } ], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } } } } ```