{"components":{"parameters":{"ExportTaskQueryFilter":{"description":"Filter string used to restrict the data returned. You can use [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) filters. The fields to filter differ from other endpoints. The filterable attributes for this endpoint are `created`, `fullDate`, `postingDate`, `type`, `facilityId` and `exportMethod`.","example":"created ge 2025-01-23 and facilityId eq expense","in":"query","name":"filter","schema":{"type":"string"}},"LegalEntityIdInPath":{"description":"Yokoy unique ID of the legal entity (company).","example":"aB9jQoE3HE","in":"path","name":"legalEntityId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},"PaginationCount":{"description":"Optional count for paginating. When provided, the results are paginated. Without `count`, no pagination is provided.\nThe maximum number of items that can be included in a paginated response is `100`.\nWhen paginated, the response includes the `itemsPerPage` attribute.\nIf the number of items available is greater than or equal to `count`, it also includes the `nextCursor` attribute, which can be used to fetch the subsequent page of items.\n","example":30,"in":"query","name":"count","required":false,"schema":{"maximum":100,"type":"number"}},"PaginationCursor":{"description":"Optional cursor for paginating. When provided, the API fetches a subsequent page of items.\nThe subsequent page is identified by the value given in `nextCursor` in the previous response.\n`cursor` can only be used if the `count` attribute is passed as a query parameter.\n","example":"06x2u4nagAMEq3gGMoch","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},"QueryFilter":{"description":"Filter string used to restrict the data returned. You can use [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) filters.","example":"created ge 2024-03-02T09:00.000Z and customInformation.customField eq foo","in":"query","name":"filter","schema":{"type":"string"}},"YokoyAuthMethod":{"example":"yokoy","in":"header","name":"X-Yk-Auth-Method","required":true,"schema":{"enum":["yokoy"],"type":"string"}},"YokoyCorrelationId":{"description":"Correlation ID that can be used to trace a request in the flow.","example":"4ea8985e-80a2-40a0-8a40-401a1a1374b3","in":"header","name":"X-Yk-Correlation-Id","required":false,"schema":{"type":"string"}}},"responses":{"Conflict":{"content":{"application/json":{"example":{"code":409,"message":"Request conflict with the current state of the target resource."},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request conflict with the current state of the target resource."},"Forbidden":{"content":{"application/json":{"example":{"code":403,"message":"User not authorized to access organization"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The client is not authorized to perform the requested operation."},"Found":{"description":"Redirect URL of a requested resource.","headers":{"Location":{"schema":{"type":"string"}}}},"GatewayError":{"content":{"application/json":{"example":{"code":502,"message":"Gateway error"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An issue occurred in a downstream service. Please try again later."},"HttpValidationError":{"content":{"application/json":{"example":{"code":400,"errors":[{"field":"Yokoy Field","message":"Yokoy Field is mandatory"}],"message":"Validation Error"},"schema":{"$ref":"#/components/schemas/HttpError","additionalProperties":true}}},"description":"The request was not valid."},"InsufficientData":{"content":{"application/json":{"example":{"code":422,"message":"Insufficient data"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request cannot be processed due to insufficient data."},"InternalError":{"content":{"application/json":{"example":{"code":500,"message":"Server error"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An internal error occurred."},"InvalidFilter":{"content":{"application/json":{"example":{"code":400,"message":"Invalid filter string: foo e bar"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."},"NotFound":{"content":{"application/json":{"example":{"code":404,"message":"Resource not found"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The specified resource was not found."},"ServiceUnavailable":{"content":{"application/json":{"example":{"code":503,"message":"Service unavailable"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The server is unavailable. Please try again later"},"TooManyRequests":{"content":{"application/json":{"example":{"code":429,"message":"Too many requests"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request cannot be processed by the server due to too many concurrent requests."},"Unauthorized":{"content":{"application/json":{"example":{"code":401,"message":"Token expired"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The server was unable to establish the identity of the client."},"ValidationError":{"content":{"application/json":{"example":{"code":400,"message":"ValidationError: name is mandatory"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."}},"schemas":{"AdditionalCategoryItem":{"properties":{"categoryId":{"description":"Yokoy unique ID of the expense category.","example":"1WOspYIfp6","pattern":"[\\w-]+","type":"string"},"costCenterId":{"description":"Yokoy unique ID of the cost object.","example":"Mt34DVcI8R2sdLutWViu","nullable":true,"pattern":"[\\w-]+","type":"string"},"gross":{"description":"Gross amount allocated to the additional category. For each additional category, the gross amount is subtracted from the total claim.","example":10.0,"type":"number"},"taxRateId":{"description":"Yokoy unique ID of the tax rate object.","example":"06x2u4nagAMEq3gGMoch","nullable":true,"pattern":"[\\w-]+","type":"string"}},"type":"object"},"AdvancedTaxRate":{"allOf":[{"$ref":"#/components/schemas/TaxRate"}],"properties":{"components":{"allOf":[{"$ref":"#/components/schemas/TaxComponents"}],"nullable":false}},"required":["components"],"type":"object"},"CardAccount":{"properties":{"accountNumber":{"description":"Associated account number. Unactivated accounts are indicated by an empty value.\nFor CHF/EUR accounts, it corresponds to account's IBAN.\nFor GBP accounts, it corresponds to the account's account number. If the currency is GBP, then property `sortCode` is also provided. For other currencies, this property is not provided.\n","example":"GB00MOCK00000000000000","type":"string"},"created":{"description":"Timestamp (date and time) when the card account was created. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2024-02-29T11:08:45.478Z","format":"date-time","nullable":true,"type":"string"},"currency":{"description":"Card account currency. ISO 4217 three-letter code.","example":"GBP","type":"string"},"id":{"description":"Yokoy unique ID of a card account.","example":"abc_ABC-09","pattern":"[\\w-]+","type":"string"},"lastModified":{"description":"Timestamp (date and time) when the card account was last modified. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2024-03-15T17:08:45.478Z","format":"date-time","nullable":true,"type":"string"},"provider":{"description":"Associated card program","enum":["Yokoy Business Prepaid Mastercard","Yokoy Platinum Visa"],"example":"Yokoy Platinum Visa","type":"string"},"sortCode":{"description":"Exclusive of GBP accounts. It corresponds to account's sort code.","example":"00-00-00","nullable":true,"type":"string"},"status":{"description":"Status of the card account.\n  - `0`: Account was requested.\n  - `1`: Account is open. Cards can be ordered.\n  - `2`: Account is closed. Cards can no longer be ordered.\n  - `3`: Account request was denied.\n","enum":[0,1,2,3],"type":"number"}},"required":["id","currency","status","accountNumber","provider"],"type":"object"},"CardAccountBalance":{"properties":{"available":{"description":"Available balance of the card account that can be used for purchases. It corresponds to the balance plus the reservations.","example":8641.42,"type":"number"},"balance":{"description":"Current total balance of the card account.","example":10000,"type":"number"},"reservations":{"description":"Reserved amount of the card account that is currently blocked by merchants or not yet cleared. This must be a negative number.","example":-1358.58,"type":"number"}},"required":["balance","available","reservations"],"type":"object"},"Category":{"properties":{"accountReference":{"description":"Account (ERP). Expense account on which the expense is booked.","example":"6300","type":"string"},"chargeToEmployee":{"description":"Only applies to private expenses that are paid with the company card. If enabled, the expense is booked on the user account instead of the expense account.","example":false,"nullable":true,"type":"boolean"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information attributes associated with the category.","example":{"externalId":"Cat1"},"nullable":true,"type":"object"},"id":{"description":"Yokoy unique ID of the expense category.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","readOnly":true,"type":"string"},"name":{"description":"Name of the expense category.","example":"Lunch","type":"string"},"statusActive":{"description":"Status of the expense category. Only active categories can be used for new expenses.","example":true,"type":"boolean"}},"required":["name","accountReference","statusActive"],"type":"object"},"CompanyCard":{"properties":{"accountReference":{"description":"Creditor number (ERP).","example":6300,"type":"string"},"cardReference":{"description":"External reference to the company card.","example":"card01","nullable":true,"type":"string"},"currency":{"description":"Currency of the card. ISO 4217 three-letter code.","example":"CHF","type":"string"},"description":{"description":"Description of the card.","example":"Company card for IT department.","nullable":true,"type":"string"},"id":{"description":"Yokoy unique ID of the card.","example":"Y6c2p3G0x","pattern":"[\\w-]+","readOnly":true,"type":"string"},"name":{"description":"Name of the card. This name is used to identify the card in Yokoy only.","example":"Card for Alex Perez.","type":"string"},"number":{"description":"The card number. Any string can be supplied. Only the last four characters are returned. The renaming digits are padded with stars. Queries can only be made using the `endswith`` operator on four or less characters. For example, 'number ew \"1234\"'.","example":null,"type":"string"},"ownerId":{"description":"Yokoy unique ID of the user who owns the card.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"statusActive":{"description":"Status of the card, whether the card is active or inactive.","example":true,"type":"boolean"}},"required":["name","ownerId","statusActive","accountReference","number","currency"],"type":"object"},"CostCenter":{"properties":{"accessType":{"description":"Defines the users that can submit expenses, trips, and invoices to the cost object.\n - `all`: Any Yokoy user can use this cost object.\n - `finance`: Only finance users can use this cost object.\n - `specificUsers`: Only finance users and an explicitly defined list of users are allowed. Users can be specified with the `userAccessGrants` property of the cost object PATCH endpoint.\n","enum":["all","finance","specificUsers"],"example":"specificUsers","type":"string"},"approvalLimit":{"description":"Approval limit in the the legal entity\u2018s currency.","example":999999,"minimum":0.0,"nullable":true,"type":"number"},"approverId":{"description":"Yokoy user ID that identifies the cost object's approver.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"pattern":"[\\w-]+","type":"string"},"autoApprovalLimit":{"description":"Auto approval limit in the legal entity\u2018s currency.","example":100000.0,"minimum":0.0,"nullable":true,"type":"number"},"code":{"description":"Code (ERP). External account number associated with the cost object.","example":"C33998","type":"string"},"customInformation":{"additionalProperties":{"description":"Dictionary of custom information attributes associated with the cost object.","example":{"externalId":"00001C"},"type":"string"},"nullable":true,"type":"object"},"delegateExpiry":{"description":"Expiry date and time of the cost object's delegate.","example":"Fri, 14 Aug 2020 21:59:59 GMT","nullable":true,"readOnly":true,"type":"string"},"delegateId":{"description":"Yokoy user ID that identifies the cost object\u2018s delegate.","example":"h9cQajbG","nullable":true,"pattern":"[\\w-]+","type":"string"},"description":{"description":"Description of the cost object.","example":"IT costs related to employees, hardware, and software.","nullable":true,"type":"string"},"id":{"description":"Yokoy unique ID of the cost object (cost center).","example":"uhmkC9zMzn","pattern":"[\\w-]+","readOnly":true,"type":"string"},"name":{"description":"Name of the cost object.","example":"IT department","type":"string"},"parentId":{"description":"Yokoy unique ID of the parent cost object.","example":"9rL5X8PJ","nullable":true,"pattern":"[\\w-]+","type":"string"},"scopes":{"description":"Scopes of the cost object. Defines whether cost objects can be used in travel, expenses, invoices or both.","example":["travel","expenses","invoices"],"items":{"enum":["travel","expenses","invoices"],"type":"string"},"nullable":true,"type":"array"},"statusActive":{"description":"Status of the cost object. Only active cost objects can be used in travel, expenses, trips, and invoices.","example":true,"type":"boolean"}},"required":["code","name"],"type":"object"},"CostCenterItem":{"properties":{"id":{"description":"Yokoy unique ID of the cost object (cost center).","example":"CZwA376CfxtOyjg43LRU","pattern":"[\\w-]+","type":"string"},"pctWeight":{"description":"Percentage of the cost to be assigned to the cost object.","maximum":100.0,"minimum":0.0,"type":"number"}},"type":"object"},"Country":{"enum":["CH","DE","US","GB","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP",false,"OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","other"],"type":"string"},"DailyStatementReference":{"properties":{"date":{"description":"Date of the daily statement.","example":"2025-02-05","format":"date","type":"string"},"id":{"description":"Unique identifier of the daily statement.","example":"2025-02-05","type":"string"},"type":{"description":"Statement format type.","example":"camt053","type":"string"},"url":{"description":"URL to download the statement file.","example":"https://example.com/statements/2025-02-05","type":"string"}},"required":["id","date","type"],"type":"object"},"DateRange":{"items":{"example":["2023-02-21","2023-02-22"],"format":"date","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"maxItems":2,"minItems":2,"type":"array"},"DateString":{"example":"2024-02-21","format":"date","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"Error":{"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"EventLogEntry":{"properties":{"actionType":{"description":"Type of event.","enum":["approve","archive","backToReview","export","needsRevision","recall","reject","review","submit","revertExport","imported","exportReverted","forwardApproval"],"example":"needsRevision","type":"string"},"comment":{"description":"Comment made by the user who triggered the event.","example":"Please re-upload the invoice instead of the payment receipt.","pattern":"[\\w-]+","type":"string"},"name":{"description":"Name of the user who triggered the event.","example":"Alex Perez","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp (date and time) of the event. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","type":"string"},"userId":{"description":"Yokoy unique ID of the user.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"pattern":"[\\w-]+","type":"string"}},"type":"object"},"Expense":{"properties":{"additionalCategoryItems":{"items":{"$ref":"#/components/schemas/AdditionalCategoryItem"},"type":"array"},"additionalCharges":{"description":"Additional charges to be added to the total amount (for example, tip, personal card fees, FX conversion fees).","example":10.0,"minimum":0.0,"nullable":true,"type":"number"},"approverIds":{"description":"List of users who have already approved the expense.","items":{"description":"Yokoy unique ID of the approver.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"type":"array"},"attachments":{"description":"Array of URLs that redirect to the supporting documents attached to the expense.","items":{"example":"https://api.test.yokoy.ai/v1/organizations/H39F_g9-bqmFqSCrwDyqo/expenses/LNjzLHG75e/attachments/2024-04-16T13:25:25.278Z-1.pdf","type":"string"},"nullable":true,"type":"array"},"categoryId":{"description":"Yokoy unique ID of the category. This is the primary/first category tagged in the expense.","example":"Eg4KzzqxpWvjqHE2H7mH","nullable":true,"pattern":"[\\w-]+","type":"string"},"costCenterItems":{"items":{"$ref":"#/components/schemas/CostCenterItem"},"nullable":true,"type":"array"},"country":{"description":"Country where expense occurred. Expressed as an ISO 3166 Alpha-2 code.","example":"US","type":"string"},"created":{"description":"Timestamp (date and time) of when the expense was created. Expressed in ISO 8601 format. Coordinated Universal Time (UTC)","example":"2022-11-15T17:08:45.478Z","format":"date-time","type":"string"},"currency":{"description":"Original expense currency. ISO 4217 three-letter code.","example":"EUR","type":"string"},"currentApproverIds":{"description":"List of users that still need to approve the expense. As users approve the expense, their IDs are added to `approverIds` and removed from this array.","items":{"description":"Yokoy unique ID of the current approver.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"type":"array"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information attributes associated with the expense.","example":{"bookingType":"ASDF1234"},"nullable":true,"type":"object"},"description":{"description":"Description including business purpose (free text descriptions added by users).","example":"Hotel expense for business meeting","type":"string"},"eventLog":{"items":{"$ref":"#/components/schemas/EventLogEntry"},"nullable":true,"type":"array"},"expenseDate":{"description":"Date when the expense occurred (date on receipt or invoice). Expressed in `YYYY-MM-DD` format.","example":"2022-01-21","type":"string"},"expenseEndDate":{"description":"End date of an expense related to an extended stay (e.g. hotel stay, flight). Expressed in `YYYY-MM-DD` format.","example":"2022-01-27","type":"string"},"expenseStartDate":{"description":"Start date of an expense related to an extended stay (e.g. hotel stay, flight). Expressed in `YYYY-MM-DD` format.","example":"2022-01-23","type":"string"},"expenseType":{"description":"Type of expense. Expenses can be receipt, receiptless, per diems, or mileage claims.","enum":["receipt","receiptless","perDiem","mileage"],"example":"receipt","type":"string"},"exportJobId":{"description":"Yokoy unique ID of the last export job that the expense has been included in, if any.","example":"jdfg8s8","nullable":true,"pattern":"[\\w-]+","type":"string"},"fxRates":{"description":"Foreign exchange reference rates used by Yokoy to convert expense amounts from the expense currency to other currencies. All currencies are quoted against the US dollar (base currency). ISO 4217 three-letter code.","example":"{ \"USD\": 1, \"EUR\": 0.925917, \"CHF\": 0.902285, \"JPY\": 151.345}","nullable":true,"type":"object"},"id":{"description":"Yokoy unique ID of the expense.","example":"uhmkC9zMzn","pattern":"[\\w-]+","readOnly":true,"type":"string"},"incomeTaxableAmounts":{"description":"Array of income taxable amounts calculated for the expense. See <a href=\"https://help.yokoy.ai/en/articles/278893-calculating-taxable-amounts-on-company-benefits\">Calculating taxable amounts on company benefits</a>.\n","items":{"$ref":"#/components/schemas/IncomeTaxableAmount"},"nullable":true,"type":"array"},"isCreditNote":{"description":"Determines if the expense is a credit note (equivalent to negative expense amount) or not.","example":false,"nullable":true,"type":"boolean"},"lastModified":{"description":"Timestamp (date and time) of when the expense was last modified. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","type":"string"},"legalEntityId":{"description":"Yokoy unique ID of the legal entity to which the expense is assigned.","example":"aB9jQoE3HE","type":"string"},"numberOfParticipants":{"description":"Number of participants.","example":2,"nullable":false,"type":"number"},"participantNames":{"description":"Participant names separated by ', '.","example":"John Doe, Alex Perez","nullable":false,"type":"string"},"participants":{"description":"List of participants involved in the expense, separated by organization employees (`internal`) and third-party participants (`external`).","nullable":true,"properties":{"external":{"description":"List of external participants.","items":{"properties":{"company":{"description":"Name of the participant\u2018s company.","example":"Yokoy","nullable":true,"type":"string"},"email":{"description":"Participant's email address.","example":"user1@example.com","nullable":true,"type":"string"},"name":{"description":"Participant's first and last name.","example":"Alex Perez","nullable":false,"type":"string"}},"type":"object"},"type":"array"},"internal":{"description":"List of Yokoy user IDs of internal participants.","example":["0TUxyxkqXvd88e1y2Pz9"],"items":{"description":"Yokoy unique ID of the user.","nullable":false,"type":"string"},"type":"array"}},"type":"object"},"paymentMethod":{"description":"Expense payment method. It can be privately paid, company card, or travel provider.","enum":["paidPrivately","companyCreditCard","travelProvider"],"example":"paidPrivately","type":"string"},"perDiemAmounts":{"description":"Breakdown of the per diem amount calculation. Only applicable to per diem expenses.","example":{"additions":0,"baseAmount":1.11,"baseRate":1.11,"deductions":-1.1,"modificationAmounts":{"fy0IyGGt1Apw8L26i3Pd":{"amount":-1.1,"modificationId":"fy0IyGGt1Apw8L26i3Pd"}},"modifications":[{"amount":-1.1,"modificationId":"fy0IyGGt1Apw8L26i3Pd"}]},"nullable":true,"properties":{"additions":{"description":"Supplements that are added to the per diem base amount.","example":10.0,"type":"number"},"baseAmount":{"description":"Per diem base amount, excluding any applicable modifications (supplement or deduction).","example":100.0,"type":"number"},"baseRate":{"description":"Base rate used to calculate the per diem base amount.","example":50.0,"type":"number"},"deductions":{"description":"Deductions that are subtracted from the per diem base amount.","example":0.0,"type":"number"},"modificationAmounts":{"additionalProperties":{"description":"Dictionary of partial amounts of the per diem modifications applied to the per diem base amount. Each key corresponds to a modification ID.","properties":{"amount":{"type":"number"},"modificationId":{"type":"string"}},"required":["amount","modificationId"],"type":"object"},"deprecated":true,"description":"Deprecated. Use `modifications`.","type":"object"},"modifications":{"description":"Array of per diem modifications applied to the per diem base amount.","items":{"properties":{"amount":{"description":"Amount of the per diem modification.","type":"number"},"modificationId":{"description":"Yokoy unique ID of the per diem modification.","type":"string"}},"required":["amount","modificationId"],"type":"object"},"type":"array"}},"required":["baseAmount","additions","deductions","modificationAmounts","modifications"],"type":"object"},"postingDate":{"description":"Date when expense is posted to the general ledger. Expressed in `YYYY-MM-DD` format.","example":"2022-01-30","type":"string"},"receipt":{"description":"URL to the receipt used to create the expense.","example":"https://api.yokoy.ai/organizations/AbcDeF1234/expenses/aB9jQoE3HE/receipt","nullable":true,"type":"string"},"status":{"description":"Status of the expense.","enum":["draft","needsRevision","forApproval","forReview","forExpenseExport","rejected","expenseExported","forTransactionExport","transactionExported","readyForTripSubmission","travelDraft"],"example":"draft","type":"string"},"tags":{"additionalProperties":{"description":"Yokoy tag ID associated with the tag dimension.","type":"string"},"description":"Tags associated with the expense. Expressed as a key pair with the tag dimension ID (tagDimension1) and tag ID (tagValue2).","example":"{ \"ecfoBGOJtV6xLEjFIaJP\": \"ugxFgyEUq3KvyZLxhuGd\", \"tagDimension2\": \"tagValue2\"}","nullable":true,"type":"object"},"taxItems":{"items":{"$ref":"#/components/schemas/TaxItem"},"nullable":true,"type":"array"},"taxNumber":{"description":"Merchant tax number extracted from the expense or invoice.","example":"CHE-172.979.264","type":"string"},"taxableAmount":{"description":"Taxable part of the total per diem amount. Only applicable to per diem expenses.","example":400.0,"minimum":0.0,"nullable":true,"type":"number"},"totalAmount":{"description":"Expense amount in the original expense currency (excluding additional charges).","example":990.0,"minimum":0.0,"nullable":true,"type":"number"},"totalClaim":{"description":"Total claim in the original expense currency (including additional charges).","example":1000.0,"minimum":0.0,"nullable":true,"type":"number"},"tripId":{"description":"Yokoy unique ID of the trip (primary/first category tagged in the expense).","example":"h9cQajbG","nullable":true,"pattern":"[\\w-]+","type":"string"},"userId":{"description":"Yokoy unique ID of the user.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"pattern":"[\\w-]+","type":"string"}},"required":["id","status","totalAmount","totalClaim"],"type":"object"},"ExpenseCreditorItem":{"properties":{"account":{"description":"Account","example":12456,"type":"string"},"amount":{"description":"Total amount in the journal entry currency.","example":28.29,"type":"number"},"amountOriginalExpenseCurrency":{"description":"Amount in the original expense currency.","example":28.29,"type":"number"}},"type":"object"},"ExpenseExportArtefact":{"properties":{"generatedFiles":{"description":"List of file names of additional files generated in the context of the export.","items":{"example":"summary.pdf","type":"string"},"type":"array"},"id":{"description":"Yokoy unique ID of the artefact.","example":"q1cOJIRODTjLDwM1aX4B","type":"string"},"originalFormat":{"description":"Original format of the serialized artefact.","example":"application/json","type":"string"},"relatedDocumentIds":{"description":"List of Yokoy expense IDs contained in the artefact.","items":{"description":"Yokoy ID of the exported expense.","example":"aB9jQoE3HE","type":"string"},"type":"array"},"serializedArtefact":{"description":"Serialized artefact of the form `ExpenseExportPayload`.","example":"{\"journalEntry\":{\"journalEntryType\":\"expense\",\"lineItems\":[{\"account\":\"6630\",\"categoryId\":\"aquNlTt8v2NOqzOruWtE\",\"amountNet\":18.5,\"amountGross\":18.5,\"costCenterCode\":\"1234\",\"costCenterId\":\"4neg0miskYbpOvKkMBd4\",\"amountGrossOriginalExpenseCurrency\":18.5,\"amountNetOriginalExpenseCurrency\":18.5}],\"taxItems\":[],\"creditorItem\":{\"account\":\"123\",\"amount\":18.5,\"amountOriginalExpenseCurrency\":18.5},\"currency\":\"EUR\",\"originalExpenseCurrency\":\"EUR\"}}","type":"string"}},"type":"object"},"ExpenseExportPayload":{"properties":{"journalEntry":{"$ref":"#/components/schemas/ExpenseJournalEntry"}},"type":"object"},"ExpenseExportTaskInformation":{"properties":{"resource":{"properties":{"created":{"description":"Timestamp (date and time) when the export was triggered. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-04-01T17:08:45.478Z","format":"date-time","type":"string"},"earliestPostingDate":{"description":"Earliest allowed posting date specified for the export. Expressed in `YYYY-MM-DD`.","example":"2023-03-31","pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string"},"exporterId":{"description":"Yokoy unique ID of the user on behalf of whom the export is performed.","example":"9L7rovNzNhTCsJSTkbfq","type":"string"},"exporterName":{"description":"Last name of the user on behalf of whom the export is performed.","example":"Perez","type":"string"},"facilityId":{"description":"Yokoy unique ID of the export facility (corresponding to the expense type).","enum":["expense","card","travel"],"example":"expense","type":"string"},"generatedFiles":{"description":"List of file names of the additional files generated with the export.","items":{"example":"summary.pdf","type":"string"},"type":"array"},"id":{"description":"ID of the export job.","example":"h6tplNlvNxnHUpeAwd7D","type":"string"},"isPending":{"description":"Status of the export job, whether the export job is still pending.","example":true,"type":"boolean"},"method":{"description":"Method used to trigger the export.","enum":["api","manual","automatic"],"example":"api","type":"string"}},"type":"object"}},"type":"object"},"ExpenseJournalEntry":{"properties":{"creditorItem":{"$ref":"#/components/schemas/ExpenseCreditorItem"},"currency":{"description":"Currency of the journal entry. ISO 4217 three-letter code.","example":"CHF","type":"string"},"journalEntryType":{"description":"Type of the journal entry.","enum":["expense","creditNote"],"example":"expense","type":"string"},"lineItems":{"description":"Line items in the journal entry.","items":{"$ref":"#/components/schemas/ExpenseJournalEntryLineItem"},"type":"array"},"originalExpenseCurrency":{"description":"Original currency of the expense. ISO 4217 three-letter code.","example":"CHF","type":"string"},"taxItems":{"description":"Consolidated tax items","items":{"$ref":"#/components/schemas/ExpenseTaxItem"},"type":"array"}},"type":"object"},"ExpenseJournalEntryLineItem":{"properties":{"account":{"description":"Account of the line item.","example":6300,"type":"string"},"amountGross":{"description":"Gross amount in the journal entry currency.","example":28.29,"type":"number"},"amountGrossOriginalExpenseCurrency":{"description":"Gross amount in the original expense currency.","example":23.38,"type":"number"},"amountNet":{"description":"Net amount in the journal entry currency.","example":23.38,"type":"number"},"amountNetOriginalExpenseCurrency":{"description":"Net amount in the original expense currency.","example":23.38,"type":"number"},"categoryId":{"description":"Yokoy unique ID of the expense category.","example":"1WOspYIfp6","type":"string"},"costCenterCode":{"description":"Code (ERP) of the cost object. External reference.","example":"C33998","type":"string"},"costCenterId":{"description":"Yokoy unique ID of the cost object (cost center).","example":"Mt34DVcI8R2sdLutWViu","type":"string"},"taxItem":{"$ref":"#/components/schemas/ExpenseTaxItem"}},"type":"object"},"ExpenseTaxItem":{"properties":{"account":{"description":"Tax account","example":239,"type":"string"},"amount":{"description":"Amount of the tax.","example":4.91,"type":"number"},"amountOriginalExpenseCurrency":{"description":"Tax amount in the original expense currency.","example":4.91,"type":"number"},"baseAmountGross":{"description":"Base gross amount in the journal entry currency.","example":28.29,"type":"number"},"baseAmountGrossOriginalExpenseCurrency":{"description":"Base gross amount in the original expense currency.","example":28.29,"type":"number"},"baseAmountNet":{"description":"Base net amount in the journal entry currency.","example":23.38,"type":"number"},"baseAmountNetOriginalExpenseCurrency":{"description":"Base net amount in the original expense currency.","example":23.38,"type":"number"},"code":{"description":"VAT code (ERP). External reference of the tax rate.","example":"tax77","type":"string"},"country":{"description":"Country of the tax rate. Expressed as an ISO 3166 Alpha-2 code.","example":"CH","type":"string"},"rate":{"description":"Tax rate.","example":21,"type":"number"},"taxId":{"description":"Yokoy unique ID of the tax rate.","example":"wVtcmFCUh6q1LCszWB1E","type":"string"}},"type":"object"},"ExternalInvoice":{"properties":{"description":{"description":"Description of the external invoice.","example":"Services for Project A","nullable":true,"type":"string"},"externalId":{"description":"External ID of the external invoice.","example":"external-1234567890","nullable":false,"type":"string"},"id":{"description":"Yokoy unique ID of the external invoice.","example":"9L7rovNzNhTCsJSTkbfq","nullable":false,"pattern":"[\\w-]+","readOnly":true,"type":"string"},"invoiceNumber":{"description":"Invoice number of the external invoice.","example":"EXT-001","nullable":false,"type":"string"},"items":{"description":"Line items of the external invoice.","items":{"$ref":"#/components/schemas/ExternalInvoiceItem"},"type":"array"},"postingDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Posting date of the external invoice. Expressed in `YYYY-MM-DD` format.","nullable":true}]}},"required":["id","invoiceNumber","externalId","items"],"type":"object"},"ExternalInvoiceItem":{"properties":{"amount":{"description":"Amount of the external invoice line item.","example":35,"minimum":0,"type":"number"},"currency":{"description":"Currency of the external invoice. ISO 4217 three-letter code.","example":"EUR","nullable":true,"type":"string"},"externalId":{"description":"External ID of the external invoice line item.","example":"external-1234567890","nullable":true,"type":"string"},"goodsReceiptId":{"description":"Yokoy unique ID of the goods receipt that is associated with the external invoice line item.\nIt must refer to an existing Yokoy goods receipt ID.\n","example":"cKrD9ni5D8","nullable":true,"type":"string"},"goodsReceiptItemId":{"description":"Yokoy unique ID of the goods receipt line item that is associated with the external invoice line item.\nIt must refer to an existing Yokoy goods receipt ID with the specified goods receipt.\nIf `goodsReceiptId` is provided, then `goodsReceiptItemId` must also be provided.\n","example":"-QkwYQo0ij","nullable":true,"type":"string"},"id":{"description":"Yokoy unique ID for the external invoice line item. For new line items, Yokoy generates the ID. For existing line items, reference the Yokoy unique ID for that line item.\n","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"itemNumber":{"description":"Item number of the external invoice line item.","example":"126","nullable":true,"type":"string"},"itemPrice":{"description":"Amount per unit of the external invoice line item.","example":5,"minimum":0,"nullable":true,"type":"number"},"purchaseOrderId":{"description":"Yokoy unique ID of the purchase order that is associated with the external invoice line item.\nIt must be an existing Yokoy purchase order ID.\n","example":"BEzLd_35sh","type":"string"},"purchaseOrderItemId":{"description":"Yokoy unique ID of the purchase order line item that is associated with the external invoice line item.\nIt must be an existing Yokoy purchase order line item ID, linked to the specified purchase order.\n","example":"6GgTvlKSc0","type":"string"},"quantity":{"description":"Quantity of the external invoice line item.","example":7,"minimum":0,"nullable":false,"type":"number"},"status":{"default":"active","description":"Status of the external invoice. Only `active` is accepted.","enum":["active"],"example":"active","nullable":false,"type":"string"},"unit":{"description":"Unit of the line item.","example":"kg","nullable":true,"type":"string"}},"required":["amount","purchaseOrderId","purchaseOrderItemId"],"type":"object"},"FxRateSource":{"properties":{"id":{"description":"Yokoy ID of the foreign exchange rate source.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","readOnly":true,"type":"string"},"label":{"description":"Name of the foreign exchange rate.","example":"Organization A FX conversion rate","type":"string"}},"required":["label","id"],"type":"object"},"FxRates":{"properties":{"baseCurrency":{"description":"Optional base currency (if not provided, USD is assumed to be the base currency).","example":"EUR","type":"string"},"fxRates":{"description":"Foreign exchange reference rates. All currencies are quoted against the base currency (USD default).","example":{"CHF":1.0759,"EUR":1,"JPY":162.3675,"USD":1.0516},"type":"object"}},"required":["fxRates"],"type":"object"},"GoodsReceipt":{"properties":{"amount":{"description":"The goods receipt's amount. Calculated from the inner items.","example":35,"minimum":0,"readOnly":true,"type":"number"},"currency":{"description":"Currency of the goods receipt. ISO 4217 three-letter code.","example":"CHF","type":"string"},"externalId":{"description":"External ID of the goods receipt, displayed as delivery note in the invoice matcher.","example":"external-1234567890","nullable":true,"type":"string"},"goodsReceiptNumber":{"description":"Goods receipt number.","example":"1234567890","type":"string"},"id":{"description":"Yokoy unique ID of the goods receipt.","example":"cKrD9ni5D8","pattern":"[\\w-]+","readOnly":true,"type":"string"},"items":{"items":{"$ref":"#/components/schemas/GoodsReceiptItem"},"type":"array"},"postingDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Posting date of the goods receipt. Expressed in `YYYY-MM-DD` format.","nullable":true}]}},"required":["id","goodsReceiptNumber","currency","items"],"type":"object"},"GoodsReceiptItem":{"properties":{"amount":{"description":"Amount of the goods receipt item.","example":35,"minimum":0,"type":"number"},"externalId":{"description":"External ID of the goods receipt item.","example":"external-1234567890","nullable":true,"type":"string"},"id":{"description":"Yokoy ID of the goods receipt item. For new items, Yokoy generates the ID. For existing items, you can reference that ID.\n","example":"-QkwYQo0ij","pattern":"[\\w-]+","readOnly":true,"type":"string"},"itemNumber":{"description":"Number of the goods receipt item.","example":"1234567890","nullable":true,"type":"string"},"itemPrice":{"description":"Item price of the goods receipt line item.","minimum":0,"nullable":true,"readOnly":false,"type":"number"},"purchaseOrderId":{"description":"Yokoy ID of the purchase order associated with the goods receipt line item.","type":"string"},"purchaseOrderItemId":{"description":"Yokoy ID of the purchase order line item associated with the goods receipt line item.","type":"string"},"quantity":{"description":"Quantity of the goods receipt line item.","example":123,"minimum":0,"nullable":false,"type":"number"},"status":{"default":"active","description":"Status of the goods receipt, indicating its current state.","enum":["active","inactive","deleted","blocked"],"example":"active","type":"string"},"unit":{"description":"Unit of the goods receipt line item.","example":"kg","nullable":true,"type":"string"}},"required":["id","statusActive","purchaseOrderId","purchaseOrderItemId","amount"],"type":"object"},"HttpError":{"properties":{"field":{"type":"string"},"message":{"type":"string"}},"required":["field","message"],"type":"object"},"IncomeTaxableAmount":{"properties":{"aggregatedExpenses":{"description":"Previously exported expenses included in income tax calculation.","example":[{"amount":200.0,"expenseId":"9L7rovNzNhTCsJSTkbfq","incomeTaxableAmount":100.0},{"amount":50.0,"expenseId":"4VrKKvgzVr","incomeTaxableAmount":50.0}],"items":{"properties":{"amount":{"description":"Amount of the aggregated expense included in the income tax calculation.","example":150.0,"type":"number"},"expenseId":{"description":"Yokoy unique ID of the expense.","example":"9L7rovNzNhTCsJSTkbfq","type":"string"},"incomeTaxableAmount":{"description":"Taxable amount of the aggregate expense included in the income tax calculation.","example":150.0,"type":"number"}},"type":"object"},"type":"array"},"categoryId":{"description":"Yokoy unique ID of the category.","example":"Eg4KzzqxpWvjqHE2H7mH","type":"string"},"currency":{"description":"Currency of the taxable amount subject to income tax. ISO 4217 three-letter code.","example":"EUR","type":"string"},"incomeTaxRuleId":{"description":"Unique ID of the income tax rule.","example":"8472f8a3-794f-43fa-a886-c3082a74b441","type":"string"},"incomeTaxableAmount":{"description":"Taxable amount of the expense subject to income tax.","example":150.0,"type":"number"},"payrollCode":{"description":"Payroll code associated to the income tax rule.","example":"code-0000","type":"string"},"userId":{"description":"Yokoy unique ID of the user.","example":"9L7rovNzNhTCsJSTkbfq","type":"string"}},"type":"object"},"Invoice":{"properties":{"country":{"description":"Country of the invoice. Expressed as an ISO 3166 Alpha-2 code.","example":"CH","type":"string"},"created":{"description":"Timestamp (date and time) when the invoice was created. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"Currency of the invoice. ISO 4217 three-letter code.","example":"CHF","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information associated with the invoice.","example":{"some-key":"some-value"},"nullable":true,"type":"object"},"date":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Date of the invoice. Expressed in `YYYY-MM-DD` format.","example":"2024-01-01","nullable":true}]},"documentData":{"description":"A base64-encoded string of the document related to the invoice. This document is uploaded and linked to the invoice.\nHowever, the document is not analyzed by the Yokoy AI.\nThe document must be a PDF.\n","example":"JVBERi0xLjYNJeLjz9MNCjI0IDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29kZS9GaXJzdCA0L0xlbmd0aCAyMTYvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjePI9RS8MwFIX/yn1bi9jepCQ6GYNpFBTEMsW97CVLbjWYNpImmz/fVsXXcw/f/c4SEFarepPTe4iFok8dU09DgtDBQx6TMwT74vaLTE7uSPDUdXM0Xe/73r1FnVwYYEtHR6d9WdY3kX4ipRMV6oojSmxQMoGyac5RLBAXf63p38aGA7XPorLewyvFcYaJile8rB+D/YcwiRdMMGScszO8/IW0MdhsaKKYGA46gXKTr/cUQVY4We/cYMNpnLVeXPJUXHs9fECr7kAFk+eZ5Xr9LcAAfKpQrA0KZW5kc3RyZWFtDWVuZG9iag0yNSAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgNC9MZW5ndGggNDkvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjeslAwULCx0XfOL80rUTDU985MKY42NAIKBsXqh1QWpOoHJKanFtvZAQQYAN/6C60NCmVuZHN0cmVhbQ1lbmRvYmoNMjYgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDkvTGVuZ3RoIDQyL04gMi9UeXBlL09ialN0bT4+c3RyZWFtDQpo3jJTMFAwVzC0ULCx0fcrzS2OBnENFIJi7eyAIsH6LnZ2AAEGAI2FCDcNCmVuZHN0cmVhbQ1lbmRvYmoNMjcgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDUvTGVuZ3RoIDEyMC9OIDEvVHlwZS9PYmpTdG0+PnN0cmVhbQ0KaN4yNFIwULCx0XfOzytJzSspVjAyBgoE6TsX5Rc45VdEGwB5ZoZGCuaWRrH6vqkpmYkYogGJRUCdChZgfUGpxfmlRcmpxUAzA4ryk4NTS6L1A1zc9ENSK0pi7ez0g/JLEktSFQz0QyoLUoF601Pt7AACDADYoCeWDQplbmRzdHJlYW0NZW5kb2JqDTIgMCBvYmoNPDwvTGVuZ3RoIDM1MjUvU3VidHlwZS9YTUwvVHlwZS9NZXRhZGF0YT4+c3RyZWFtDQo8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pgo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjQtYzAwNSA3OC4xNDczMjYsIDIwMTIvMDgvMjMtMTM6MDM6MDMgICAgICAgICI+CiAgIDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+CiAgICAgIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICAgICAgICAgIHhtbG5zOnBkZj0iaHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIKICAgICAgICAgICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj4KICAgICAgICAgPHBkZjpQcm9kdWNlcj5BY3JvYmF0IERpc3RpbGxlciA2LjAgKFdpbmRvd3MpPC9wZGY6UHJvZHVjZXI+CiAgICAgICAgIDx4bXA6Q3JlYXRlRGF0ZT4yMDA2LTAzLTA2VDE1OjA2OjMzLTA1OjAwPC94bXA6Q3JlYXRlRGF0ZT4KICAgICAgICAgPHhtcDpDcmVhdG9yVG9vbD5BZG9iZVBTNS5kbGwgVmVyc2lvbiA1LjIuMjwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8eG1wOk1vZGlmeURhdGU+MjAxNi0wNy0xNVQxMDoxMjoyMSswODowMDwveG1wOk1vZGlmeURhdGU+CiAgICAgICAgIDx4bXA6TWV0YWRhdGFEYXRlPjIwMTYtMDctMTVUMTA6MTI6MjErMDg6MDA8L3htcDpNZXRhZGF0YURhdGU+CiAgICAgICAgIDx4bXBNTTpEb2N1bWVudElEPnV1aWQ6ZmYzZGNmZDEtMjNmYS00NzZmLTgzOWEtM2U1Y2FlMmRhMmViPC94bXBNTTpEb2N1bWVudElEPgogICAgICAgICA8eG1wTU06SW5zdGFuY2VJRD51dWlkOjM1OTM1MGIzLWFmNDAtNGQ4YS05ZDZjLTAzMTg2YjRmZmIzNjwveG1wTU06SW5zdGFuY2VJRD4KICAgICAgICAgPGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD4KICAgICAgICAgPGRjOnRpdGxlPgogICAgICAgICAgICA8cmRmOkFsdD4KICAgICAgICAgICAgICAgPHJkZjpsaSB4bWw6bGFuZz0ieC1kZWZhdWx0Ij5CbGFuayBQREYgRG9jdW1lbnQ8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6QWx0PgogICAgICAgICA8L2RjOnRpdGxlPgogICAgICAgICA8ZGM6Y3JlYXRvcj4KICAgICAgICAgICAgPHJkZjpTZXE+CiAgICAgICAgICAgICAgIDxyZGY6bGk+RGVwYXJ0bWVudCBvZiBKdXN0aWNlIChFeGVjdXRpdmUgT2ZmaWNlIG9mIEltbWlncmF0aW9uIFJldmlldyk8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6U2VxPgogICAgICAgICA8L2RjOmNyZWF0b3I+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgCjw/eHBhY2tldCBlbmQ9InciPz4NCmVuZHN0cmVhbQ1lbmRvYmoNMTEgMCBvYmoNPDwvTWV0YWRhdGEgMiAwIFIvUGFnZUxhYmVscyA2IDAgUi9QYWdlcyA4IDAgUi9UeXBlL0NhdGFsb2c+Pg1lbmRvYmoNMjMgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAxMD4+c3RyZWFtDQpIiQIIMAAAAAABDQplbmRzdHJlYW0NZW5kb2JqDTI4IDAgb2JqDTw8L0RlY29kZVBhcm1zPDwvQ29sdW1ucyA0L1ByZWRpY3RvciAxMj4+L0ZpbHRlci9GbGF0ZURlY29kZS9JRFs8REI3Nzc1Q0NFMjI3RjZCMzBDNDQwREY0MjIxREMzOTA+PEJGQ0NDRjNGNTdGNjEzNEFCRDNDMDRBOUU0Q0ExMDZFPl0vSW5mbyA5IDAgUi9MZW5ndGggODAvUm9vdCAxMSAwIFIvU2l6ZSAyOS9UeXBlL1hSZWYvV1sxIDIgMV0+PnN0cmVhbQ0KaN5iYgACJjDByGzIwPT/73koF0wwMUiBWYxA4v9/EMHA9I/hBVCxoDOQeH8DxH2KrIMIglFwIpD1vh5IMJqBxPpArHYgwd/KABBgAP8bEC0NCmVuZHN0cmVhbQ1lbmRvYmoNc3RhcnR4cmVmDQo0NTc2DQolJUVPRg0K","format":"base64","nullable":false,"type":"string","writeOnly":true},"dueDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Due date of the invoice. Expressed in `YYYY-MM-DD` format.","example":"2025-01-01","nullable":true}]},"eventLog":{"items":{"$ref":"#/components/schemas/EventLogEntry"},"nullable":true,"type":"array"},"exportJobId":{"description":"Yokoy unique ID of the last export job that the invoice has been included in, if any.","example":"jdfg8s8","nullable":true,"pattern":"[\\w-]+","readOnly":true,"type":"string"},"fxRates":{"description":"Foreign exchange reference rates used by Yokoy to convert the original invoice amount to other currencies. All currencies are quoted against the US dollar (base currency). ISO 4217 three-letter code.","example":{"CHF":0.902285,"EUR":0.925917,"JPY":151.345,"USD":1},"nullable":true,"type":"object"},"grossAmount":{"description":"Gross amount of the invoice. Aggregated from the invoice's line items.","example":466.82,"readOnly":true,"type":"number"},"id":{"description":"Yokoy unique ID of the invoice.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","readOnly":true,"type":"string"},"invoiceNumber":{"description":"Invoice number","example":"12345","type":"string"},"isCreditNote":{"description":"Indicates whether or not the invoice is a credit note.\nThis attribute is read only as Yokoy determines whether the invoice is a credit note based on the invoice gross amount.\n","example":true,"nullable":true,"readOnly":true,"type":"boolean"},"lastModified":{"description":"Timestamp (date and time) when the invoice was last modified. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","readOnly":true,"type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/InvoiceLineItem"},"type":"array"},"netAmount":{"description":"Net amount of the invoice. Aggregated from the invoice's line items.","example":421.96,"readOnly":true,"type":"number"},"oneTimeSupplierInfo":{"allOf":[{"$ref":"#/components/schemas/OneTimeSupplierInfo"},{"nullable":false}]},"paymentBlocked":{"default":false,"description":"Indicates whether the invoice has a payment block. A payment block is a restriction set on the invoice to instruct the finance system to avoid paying the invoice during the payment run.","nullable":true,"type":"boolean"},"paymentInformation":{"allOf":[{"$ref":"#/components/schemas/InvoiceBankAccount"},{"nullable":true}]},"paymentTermId":{"description":"Yokoy unique ID of the payment terms associated with the invoice.","example":"06x2u4nagAMEq3gGoMch","nullable":true,"type":"string"},"postingDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Posting date of the invoice. Expressed in `YYYY-MM-DD` format.","example":"2024-01-01","nullable":true}]},"purchaseOrderIds":{"description":"Array of Yokoy purchase order IDs associated with the invoice.","example":["9L7rovNzNhTCsJSTkbfq","ZPR8UGnX2QoiOB2eDNp9"],"items":{"nullable":false,"type":"string"},"nullable":true,"type":"array"},"qrInfo":{"$ref":"#/components/schemas/InvoiceQrInformation"},"serviceDate":{"description":"The invoice's service date(s). If a single date is passed as a string, then it describes that date.\nOtherwise, if an array is passed with two dates, then it is considered as a range of dates.\n","example":["2023-12-01","2024-01-01"],"nullable":true,"oneOf":[{"$ref":"#/components/schemas/DateString","type":null},{"$ref":"#/components/schemas/DateRange","maxLength":2,"type":null}]},"status":{"description":"Status of the invoice. Yokoy determines the status of the invoice. It cannot be changed directly.\nThe statuses can be draft (`0`), needs revision (`1`), in approval (`2`), in review (`3`), ready for export (`4`), rejected (`5`), exported (`6`), new (`7`), or waiting for async input (`8`).\n","enum":[0,1,2,3,4,5,6,7,8],"example":"0","pattern":"[\\w-]+","readOnly":true,"type":"string"},"submitters":{"description":"List of Yokoy user IDs who submitted the invoice or who are responsible for coding the invoice.","example":["9L7rovNzNhTCsJSTkbfq","09NcHB2XRXXQYRHYDCsW"],"items":{"nullable":false,"type":"string"},"nullable":true,"type":"array"},"supplierId":{"description":"Yokoy unique ID of the legal entity supplier associated with the invoice.","example":"bbebb9a0-87ef-439c-9ac3-e320e47d85d5","nullable":true,"type":"string"},"taxAmount":{"description":"Tax amount of the invoice. Aggregated from the invoice's line items.","example":421.23,"minimum":0,"nullable":true,"readOnly":true,"type":"number"},"taxableAmount":{"deprecated":true,"description":"Taxable amount of the invoice. Aggregated from the invoice's line items. Deprecated. Use `taxAmount` instead.","example":421.96,"minimum":0,"nullable":true,"readOnly":true,"type":"number"}},"required":["id","status","invoiceNumber","documentData","lineItems","country"],"type":"object"},"InvoiceBankAccount":{"description":"Information related to the payment of the invoice.","properties":{"bankAccount":{"description":"Bank account number. Often used if no IBAN exists.","example":"987654321","nullable":true,"type":"string"},"bankCountry":{"description":"Country of the bank.","example":"UK","nullable":true,"type":"string"},"bankKey":{"description":"Bank key (also called branch code).","example":"XXX","nullable":true,"type":"string"},"bankNumber":{"description":"Bank number (also called bank code).","example":"UBSW","nullable":true,"type":"string"},"externalId":{"description":"External ID of the bank in ERP systems.","example":"UBS12","nullable":true,"type":"string"},"iban":{"description":"IBAN (International Bank Account Number).","example":"CH5604835012345678009","nullable":true,"type":"string"},"swiftCode":{"description":"Swift code (also called the BIC).","example":"UBSWCHZHXXX","nullable":true,"type":"string"}},"type":"object"},"InvoiceBase64":{"properties":{"invoiceId":{"description":"Yokoy unique ID of the invoice.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","readOnly":true,"type":"string"},"pdfBase64":{"description":"Invoice PDF file encoded in base64 format.","example":"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg==","pattern":"[\\w-]+","readOnly":true,"type":"string"}},"type":"object"},"InvoiceCategory":{"properties":{"accountReference":{"description":"Account reference (ERP) of the invoice category.","example":"saas","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information associated with the category.","example":{"externalId":"InvCat1"},"nullable":true,"type":"object"},"description":{"description":"Description of the invoice category.","example":"Any costs for Software for internal purposes.","nullable":true,"type":"string"},"exportCostObject":{"default":true,"description":"Indicates if the cost object should be included during export.","example":true,"type":"boolean"},"id":{"description":"Yokoy unique ID of the invoice category.","example":"hm0qUnb8s","pattern":"[\\w-]+","readOnly":true,"type":"string"},"isTaxOnly":{"default":false,"description":"Determines whether the line item is a tax-only item. This means that the total amount of the invoice line item is entirely tax. There is no net amount.","example":true,"nullable":true,"type":"boolean"},"name":{"description":"Name of the invoice category.","example":"Software costs","type":"string"},"statusActive":{"description":"Status of the invoice category, whether the invoice category is active. Only active categories can be used in an invoice.","example":true,"type":"boolean"}},"type":"object"},"InvoiceExportArtefact":{"properties":{"generatedFiles":{"description":"List of file names of the additional files generated with the export.","items":{"example":"summary.pdf","type":"string"},"type":"array"},"id":{"description":"Yokoy unique ID of the artefact.","example":"5l2jRoqlA6DfsgApHnEZ","type":"string"},"originalFormat":{"description":"Original format of the serialized artefact.","example":"application/json","type":"string"},"relatedDocumentIds":{"description":"List of Yokoy invoice IDs contained in the artefact.","items":{"description":"Yokoy ID of the exported invoice.","example":"9L7rovNzNhTCsJSTkbfq","type":"string"},"type":"array"},"serializedArtefact":{"description":"Serialized artefact of the form `InvoiceExportPayload`.","example":"{\"journalEntry\":{\"journalEntryType\":\"invoice\",\"lineItems\":[{\"account\":\"6630\",\"categoryId\":\"aquNlTt8v2NOqzOruWtE\",\"amountNet\":18.5,\"amountGross\":18.5,\"costCenterCode\":\"1234\",\"costCenterId\":\"4neg0miskYbpOvKkMBd4\",\"amountGrossOriginalCurrency\":18.5,\"amountNetOriginalCurrency\":18.5}],\"taxItems\":[],\"currency\":\"EUR\",\"originalCurrency\":\"EUR\",\"supplierId\":\"9L7rovNzNhTCsJSTkbfq\",\"postingDate\":\"2023-01-01\"}}","type":"string"}},"type":"object"},"InvoiceExportPayload":{"properties":{"journalEntry":{"$ref":"#/components/schemas/InvoiceJournalEntry"}},"type":"object"},"InvoiceExportTaskInformation":{"properties":{"resource":{"properties":{"created":{"description":"Timestamp (date and time) when the export was triggered. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-04-01T17:08:45.478Z","format":"date-time","type":"string"},"earliestPostingDate":{"description":"Earliest allowed posting date specified for the export.","example":"2023-03-31","pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string"},"exporterId":{"description":"Yokoy unique ID of the user on behalf of whom the export job is performed.","example":"9L7rovNzNhTCsJSTkbfq","type":"string"},"exporterName":{"description":"Last name of the user on behalf of whom the export job is performed.","example":"Yokoy","type":"string"},"facilityId":{"description":"Yokoy unique ID of the invoice export facility.","example":"dfP59n4vLVvO6KWj27pS","type":"string"},"generatedFiles":{"description":"List of file names of the additional files generated with the export.","items":{"example":"summary.pdf","type":"string"},"type":"array"},"id":{"description":"ID of the export job.","example":"h6tplNlvNxnHUpeAwd7D","type":"string"},"isPending":{"description":"Status of the export job, whether the export job is still pending.","example":true,"type":"boolean"},"method":{"description":"Method used to trigger the export job.","enum":["api","manual","automatic"],"example":"api","type":"string"}},"type":"object"}},"type":"object"},"InvoiceJournalEntry":{"properties":{"amountGross":{"description":"Gross amount in the journal entry currency.","example":91.55,"type":"number"},"amountGrossOriginalCurrency":{"description":"Gross amount in the original invoice currency.","example":91.55,"type":"number"},"amountNet":{"description":"Net amount in the journal entry currency.","example":85,"type":"number"},"amountNetOriginalCurrency":{"description":"Net amount in the original invoice currency.","example":85,"type":"number"},"currency":{"description":"Currency of the journal entry. ISO 4217 three-letter code.","example":"CHF","type":"string"},"journalEntryType":{"description":"Type of the journal entry","enum":["invoice","creditNote"],"example":"invoice","type":"string"},"lineItems":{"description":"Line items in the journal entry","items":{"$ref":"#/components/schemas/InvoiceJournalEntryLineItem"},"type":"array"},"originalCurrency":{"description":"Original currency of the invoice. ISO 4217 three-letter code.","example":"CHF","type":"string"},"paymentTermExternalId":{"description":"External ID of the payment term of the invoice.","type":"string"},"paymentTermId":{"description":"Yokoy unique ID of the payment term of the invoice.","example":"06x2u4nagAMEq3gGoMch","type":"string"},"postingDate":{"description":"Posting date of the invoice.","example":"2024-04-09","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"supplierExternalId":{"description":"External ID of the supplier of the invoice.","type":"string"},"supplierId":{"description":"Yokoy ID of the organization-level supplier of the invoice.","example":"8ef7a04a-ce91-4b60-a624-e209f748f86a","type":"string"},"taxItems":{"description":"Consolidated tax items","items":{"$ref":"#/components/schemas/InvoiceTaxItem"},"type":"array"}},"type":"object"},"InvoiceJournalEntryLineItem":{"properties":{"account":{"description":"Account of the line item.","example":"6800","type":"string"},"amountGross":{"description":"Gross amount in the journal entry currency.","example":91.55,"type":"number"},"amountGrossOriginalCurrency":{"description":"Gross amount in original invoice currency","example":91.55,"type":"number"},"amountNet":{"description":"Net amount in the journal entry currency.","example":85,"type":"number"},"amountNetOriginalCurrency":{"description":"Net amount in original invoice currency","example":85,"type":"number"},"categoryId":{"description":"Yokoy unique ID of the invoice category.","example":"hm0qUnb8s","type":"string"},"costCenterCode":{"description":"Code (ERP) of the cost object. External reference.","example":"1112100","type":"string"},"costCenterId":{"description":"Yokoy unique ID of the cost object (cost center).","example":"Mt34DVcI8R2sdLutWViu","type":"string"},"description":{"description":"Description of the line item.","type":"string"},"purchaseOrderExternalId":{"description":"External ID of the purchase order.","example":"PO1245","type":"string"},"purchaseOrderId":{"description":"Yokoy ID of the purchase order.","example":"UBp50QWBch","type":"string"},"purchaseOrderItemExternalId":{"description":"External ID of the purchase order item.","example":"SMFsnAY1m","type":"string"},"purchaseOrderItemId":{"description":"Yokoy ID of the purchase order item.","example":"7IdM0mUWXb","type":"string"},"quantity":{"description":"Quantity of the line item.","example":10,"type":"number"},"tags":{"description":"Tags on the line item. Mapping from tag dimension code to tag code.","type":"object"},"taxItem":{"$ref":"#/components/schemas/InvoiceTaxItem"},"unit":{"description":"Unit of the line item.","example":"pk","type":"string"}},"type":"object"},"InvoiceLineItem":{"properties":{"categoryId":{"description":"Yokoy unique ID of the invoice category associated with the line item.","example":"hm0qUnb8s","nullable":true,"type":"string"},"costObjectId":{"description":"Yokoy unique ID of the cost object associated with the line item.","example":"Y6cp2G30M","nullable":true,"type":"string"},"customInformation":{"additionalProperties":true,"description":"Dictionary of custom information associated with the line item.","example":{"lineItemCustomField":"customValue","lineItemCustomField2":{"nestedField1":["value 1","value 2"],"nestedField2":123,"nestedField3":true}},"nullable":true,"type":"object"},"description":{"description":"Description of the line item.","example":"Threaded inserts 5 mm diameter, 18 mm depth, M5, box of 100","nullable":true,"type":"string"},"goodsReceiptId":{"description":"Yokoy unique ID of the goods receipt associated with the line item. Only present in 3-way matching.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"type":"string"},"goodsReceiptItemId":{"description":"Yokoy unique ID of the goods receipt line item associated with the line item. Only present in 3-way matching.","nullable":true,"type":"string"},"goodsReceiptNumber":{"description":"Yokoy goods receipt number associated with the line item. Only present in 3-way matching.","nullable":true,"type":"string"},"gross":{"description":"Gross amount of the line item.","example":19.78,"minimum":0,"type":"number"},"isTaxOnly":{"description":"Indicates whether a line item a tax-only item. This means that the total amount of the invoice line item is entirely tax. There is no net amount.","example":false,"nullable":true,"readOnly":true,"type":"boolean"},"itemPrice":{"description":"Item price of the line item.","example":7.99,"minimum":0,"nullable":true,"type":"number"},"matchStatus":{"description":"Indicates matching status of purchase order line item (two-way matching) / goods receipt line item (three-way matching) with invoice line item. The status can be `notmatched`, `matched`, `nonPurchaseOrder`, `overspent` (two-way matching), `mismatch` (three-way matching).\nCalculated internally in Yokoy during matching. It cannot be imported or changed.\n","enum":["notmatched","matched","nonPurchaseOrder","overspent","mismatch"],"nullable":true,"readOnly":true,"type":"string"},"net":{"description":"Net amount of the line item.","example":15.98,"minimum":0,"type":"number"},"nonRecoverableTaxAmount":{"description":"Total non-recoverable tax amount of the line item.","example":1.4,"nullable":true,"readOnly":true,"type":"number"},"purchaseOrderId":{"description":"Yokoy unique ID of the purchase order associated with the line item.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"type":"string"},"purchaseOrderItemId":{"description":"Yokoy unique ID of the purchase order line item associated with the line item.","example":"7IdM0mUWXb","nullable":true,"type":"string"},"purchaseOrderNumber":{"description":"Purchase order number associated with the line item.","example":"PO-1234567890","nullable":true,"type":"string"},"quantity":{"description":"Quantity of the line item.","example":2,"minimum":0,"nullable":true,"type":"number"},"selfAssessedTaxAmount":{"description":"Total self-assessed tax amount of the line item.","example":20.5,"nullable":true,"readOnly":true,"type":"number"},"serviceEndDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Service period end date for the line item. Expressed in `YYYY-MM-DD` format. Only used when service periods are enabled for invoices in the legal entity. You must set this attribute if `serviceStartDate` is set.","nullable":true}]},"serviceStartDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Service period start date for the line item. Expressed in `YYYY-MM-DD` format. Only used when service periods are enabled for invoices in the legal entity.","nullable":true}]},"tags":{"additionalProperties":{"description":"Yokoy unique ID associated with the tag dimensions.","type":"string"},"description":"Tags associated with the line item.","example":"{ \"tagDimension1\": \"tagValueOfDimension1\", \"tagDimension2\": \"tagValueOfDimension2\"}","type":"object"},"taxAmount":{"description":"Total tax amount of the line item.","nullable":true,"readOnly":true,"type":"number"},"taxRateComponents":{"items":{"$ref":"#/components/schemas/InvoiceLineItemTaxComponent"},"nullable":true,"readOnly":true,"type":"array"},"taxRateId":{"description":"Yokoy unique ID of the tax rate associated with the line item.","example":"06x2u4nagAMEq3gGMoch","nullable":true,"type":"string"},"unit":{"description":"Unit of the line item.","example":"PK","nullable":true,"type":"string"}},"required":["gross","net"],"type":"object"},"InvoiceLineItemTaxComponent":{"additionalProperties":false,"properties":{"name":{"description":"Indicates description of the tax component.","example":"Netherlands Standard - 50% recoverable","type":"string"},"nonRecoverableTaxAmount":{"description":"Non-recoverable tax amount. 100 is understood as 100%.","example":1.4,"nullable":true,"type":"number"},"rate":{"description":"Tax rate in percentage.","example":2.8,"type":"number"},"selfAssessedTaxAmount":{"description":"Self-assessed tax amount.","example":0,"nullable":true,"type":"number"},"taxAmount":{"description":"Tax amount.","example":2.8,"nullable":true,"type":"number"}},"required":["name","rate"],"type":"object"},"InvoicePaymentTerms":{"properties":{"discounts":{"description":"List of discounts applied if an invoice is paid within a given time-frame.","items":{"properties":{"days":{"description":"Days that determines early invoice payment. If paid within this period, a discount is applied to the invoice.","example":3,"type":"number"},"discount":{"description":"Discount (percentage) applied to the invoice. For example, 5% == 5.","example":5,"type":"number"}},"type":"object"},"nullable":true,"type":"array"},"externalId":{"description":"External reference to the payment term.","example":"externalId1","nullable":true,"type":"string"},"id":{"description":"Yokoy unique ID of the invoice payment term.","example":"06x2u4nagAMEq3gGoMch","pattern":"[\\w-]+","readOnly":true,"type":"string"},"name":{"description":"Name of the payment term","example":"Supplier payment term - 90 days","type":"string"},"netPaymentPeriod":{"description":"Period (days) within which the payment is required.","example":90,"type":"number"},"supplierSpecific":{"default":false,"description":"Restricts the payment term to a specific supplier. If set to `true`, the payment term can only be used with that supplier (specified by the payment term ID in the supplier payload). If set to `false`, the payment term is considered to be generic and can be used with any supplier of the legal entity.","type":"boolean"}},"required":["id","name"],"type":"object"},"InvoiceQrInformation":{"description":"Invoice QR information. Supports Swiss QR-bill.","properties":{"iban":{"description":"IBAN (International Bank Account Number). It can be a standard IBAN or a QR-IBAN associated with the payment creditor. Only Swiss IBAN numbers are allowed.","example":"CH5604835012345678009","nullable":true,"type":"string"},"referenceNumber":{"description":"Payment reference. It can be either a QR reference or a Creditor reference. QR reference or Creditor Reference (ISO 11649). The QR reference is printed in blocks of 5 characters (beginning with 2 characters, then 5x5-character groups). The Creditor Reference is printed in blocks of 4 characters.","example":"210000000003139471430009017","nullable":true,"type":"string"},"structuredMessage":{"description":"Billing information. Coded information for automated booking of the payment. This information may be used for automating accounts payable processes, for instance. The data is not forwarded with the payment but it is printed on the payment part of the bill. The coding of the element always begins with \u201c//\u201d (slash slash) followed by the double-digit, abbreviated name of the proposed version of the \u201cStructured information for the bill issuer\u201d that is being used. The first two characters are reserved as the code for the rule defining how the remaining characters of this field should be interpreted. For more information on coding, see www.paymentstandards.ch.","example":"//S1/10/1234/11/201021/30/102673386/32/7.7/40/0:30","nullable":true,"type":"string"},"type":{"description":"Reference type. If `iban` is a QR-IBAN, then the type is `QRR` (QR reference). Otherwise, it can be `SCOR` (Creditor reference) or `NON` (without reference).\n","example":"NON","nullable":true,"type":"string"},"unstructuredMessage":{"description":"Additional description. Used give the payment purpose or for additional textual information about payments with a structured reference. Unstructured references are printed on the payment part under the heading \u201cAdditional information\u201d.","example":"Order from 15.10. 2020","nullable":true,"type":"string"}},"readOnly":true,"type":"object"},"InvoiceTaxItem":{"properties":{"tax":{"description":"Tax amount in the journal entry currency.","example":6.55,"type":"number"},"taxCode":{"description":"Code (ERP) of the tax rate.","example":"tax77","type":"string"},"taxOriginalCurrency":{"description":"Tax amount in the original invoice currency.","example":6.55,"type":"number"},"taxRateId":{"description":"Yokoy unique ID of the tax rate.","example":"06x2u4nagAMEq3gGMoch","type":"string"},"taxReverseCharge":{"description":"Tax amount reverse charge in the journal entry currency.","example":"null","type":"number"},"taxReverseChargeOriginalCurrency":{"description":"Tax amount reverse charge in the original invoice currency.","example":"null","type":"number"}},"type":"object"},"LegalEntity":{"properties":{"categories":{"items":{"properties":{"accountReference":{"description":"Account (ERP). Expense account on which the expense is booked.","example":"3200","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information attributes associated with the expense category.","example":{"externalId":"Cat1"},"nullable":true,"type":"object"},"id":{"description":"Yokoy unique ID of the expense category.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"name":{"description":"Name of the expense category.","example":"Lunch","type":"string"},"statusActive":{"description":"Status of the expense category. Only active categories can be used for new expenses.","example":true,"type":"boolean"}},"required":["name","accountReference","statusActive"],"type":"object"},"type":"array"},"code":{"description":"Code (ERP). The legal entity's account in the ERP system.","example":"11","type":"string"},"id":{"description":"Yokoy unique ID of the legal entity (company).","example":"aB9jQoE3HE","pattern":"[\\w-]+","readOnly":true,"type":"string"},"language":{"description":"Main language of the legal entity. Expressed as ISO 639 two-letter language code (exceptions: German (CH) and English (UK)).\n","enum":["de","de-ch","en","en-gb","es","fr","nl","pl","zh","ja"],"example":"de","type":"string"},"name":{"description":"Name of the legal entity's name.","example":"Company A - CH","type":"string"},"policies":{"items":{"properties":{"code":{"description":"Code (ERP) of the employee policy. ERP reference.","example":"policy0","type":"string"},"id":{"description":"Yokoy ID of the employee policy.","example":"06x2u4nagAMEq3gGoMch","pattern":"[\\w-]+","type":"string"},"name":{"description":"Name of the employee policy.","example":"Employee Policy","type":"string"},"statusActive":{"description":"Status of the employee policy.","example":true,"type":"boolean"}},"required":["name","code","statusActive"],"type":"object"},"type":"array"},"taxRates":{"items":{"properties":{"code":{"description":"Code (ERP) of the tax rate.","example":"tax77","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information attributes associated with the tax rate.","example":{"externalId":"Tax1"},"nullable":true,"type":"object"},"id":{"description":"Yokoy unique ID of the tax rate.","example":"06x2u4nagAMEq3gGMoch","pattern":"[\\w-]+","type":"string"},"name":{"description":"Name of the tax rates.","example":"7.7% Standard Rate","type":"string"},"statusActive":{"description":"Status of the tax rate. Inactive tax rates cannot be used in expenses, trips, and invoices.","example":true,"type":"boolean"}},"required":["name","code","statusActive"],"type":"object"},"nullable":true,"type":"array"}},"required":["code","language","policies","categories"],"type":"object"},"LegalEntitySupplier":{"properties":{"autoSubmissionSettings":{"$ref":"#/components/schemas/SupplierAutoSubmissionSettings","nullable":true},"codingType":{"description":"Determines how invoices from this supplier should be processed by Yokoy.\n- `smart`: If selected, Yokoy tries to smart-code all invoices for the supplier.\n- `supplierDefault`: If selected, Yokoy picks the default cost object and category that you have set up in the supplier settings.\n- `entity`: If this option is selected, Yokoy follows whatever coding logic is determined for the company. If smart coding is enabled for the legal entity, Yokoy performs smart coding of the invoice. If smart coding is not enabled for the legal entity, then no smart coding is performed.\n","enum":["smart","supplierDefault","entity"],"example":"smart","nullable":true,"type":"string"},"customInformation":{"additionalProperties":true,"nullable":true,"type":"object"},"defaultApproverFirstName":{"description":"The first name of the default invoice approver.","example":"Alex","nullable":true,"type":"string"},"defaultApproverId":{"description":"Yokoy unique ID of the default approver.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"pattern":"[\\w-]+","type":"string"},"defaultApproverLastName":{"description":"The last name of the default invoice approver.","example":"Doe","nullable":true,"type":"string"},"defaultCategoryId":{"description":"Yokoy unique ID of the default invoice category.","example":"uhmkC9Mzzn","nullable":true,"pattern":"[\\w-]+","type":"string"},"defaultCategoryName":{"description":"Name of the default invoice category for this supplier.","example":"Category A","nullable":true,"type":"string"},"defaultCostCenterId":{"description":"Yokoy unique ID of the default cost object.","example":"Mt34DVcI8R2sdLutWViu","nullable":true,"pattern":"[\\w-]+","type":"string"},"defaultCostCenterName":{"description":"Name of the default cost object.","example":"Default cost center","nullable":true,"type":"string"},"defaultPaymentTermId":{"description":"Yokoy unique ID of the default payment term.","example":"uhmkC9Mzzn","nullable":true,"pattern":"[\\w-]+","type":"string"},"id":{"description":"Yokoy unique ID of supplier linked to a specific legal entity.","example":"8ef7a04a-ce91-4b60-a624-e209f748f86a","pattern":"[\\w-]+","readOnly":true,"type":"string"},"isInternalSupplier":{"description":"Identifies the supplier as intercompany supplier.","example":false,"nullable":true,"type":"boolean"},"isPurchaseOrderSupplier":{"description":"Indicates if the supplier requires a purchase order for each invoice.","example":false,"nullable":true,"type":"boolean"},"paymentTermIds":{"description":"Array of Yokoy IDs of payment terms.","example":["06x2u4nagAMEq3gGoMch","34e5u4nqgBMWq4gRalmX"],"items":{"type":"string"},"nullable":true,"type":"array"},"statusActive":{"type":"boolean"},"supplierId":{"description":"Yokoy ID of the organization supplier. It must reference an existing organization-level supplier.","example":"8ef7a04a-ce91-4b60-a624-e209f748f86a","type":"string"},"triggerAutoMatchWithoutPO":{"description":"Trigger auto-match without purchase order number data. For PO suppliers (i.e. suppliers with invoices that must always have an associated PO), if set as `true`, Yokoy tries to match the invoice to a purchase order if no purchase order data is provided.","example":false,"nullable":true,"type":"boolean"}},"required":["id","legalEntityId","supplierId","statusActive"],"type":"object"},"OneTimeSupplierInfo":{"description":"Information related to one-time vendor.","properties":{"bankAccount":{"description":"Bank account number. Often used if no IBAN exists.","example":"CH987654321","nullable":true,"type":"string"},"bankCountry":{"allOf":[{"$ref":"#/components/schemas/Country"},{"description":"Country of the bank. Expressed as an ISO 3166 Alpha-2 code.","nullable":true}]},"city":{"description":"City where the one-time supplier is located.","example":"Munich","nullable":false,"type":"string"},"country":{"allOf":[{"$ref":"#/components/schemas/Country"},{"description":"Country where the one-time supplier is located. Expressed as an ISO 3166 Alpha-2 code.","example":"DE"}]},"iban":{"description":"IBAN (International Bank Account Number).","example":"CH5604835012345678009","nullable":true,"type":"string"},"street":{"description":"Street where the one-time supplier is located.","example":"Isartorpl 8","nullable":false,"type":"string"},"supplierId":{"description":"This supplier ID links to the template legal-entity supplier. The template supplier is displayed in the one-time supplier list and can be selected as a supplier in invoices.","nullable":false,"type":"string"},"supplierName":{"description":"Name of the one-time supplier.","example":"Temporary Supplier Company A","nullable":false,"type":"string"},"swiftCode":{"description":"Swift code (also called the BIC).","example":"UBSWCHZHXXX","nullable":true,"type":"string"},"taxNumber":{"description":"Legal tax number of the one-time supplier.","example":"DE327990207","nullable":true,"type":"string"},"zipCode":{"description":"Postal code where the one-time supplier is located.","example":"D7890","nullable":false,"type":"string"}},"required":["supplierId","supplierName","street","zipCode","city","country"],"type":"object"},"OrganizationSupplier":{"properties":{"bankAccounts":{"items":{"$ref":"#/components/schemas/InvoiceBankAccount"},"nullable":true,"type":"array"},"city":{"description":"City where the supplier is located.","example":"M\u00fcnchen","nullable":true,"type":"string"},"contacts":{"default":[],"items":{"$ref":"#/components/schemas/SupplierContact"},"nullable":true,"type":"array"},"countryCode":{"description":"Country where the supplier is located. Expressed as an ISO 3166 Alpha-2 code.","example":"DE","nullable":true,"type":"string"},"customInformation":{"additionalProperties":true,"nullable":true,"type":"object"},"externalId":{"description":"External ID of the organization supplier. This must be unique within the organization and cannot be changed after creation.","example":"S33998","type":"string"},"id":{"description":"Yokoy ID of the organization supplier.","example":"8ef7a04a-ce91-4b60-a624-e209f748f86a","pattern":"[\\w-]+","readOnly":true,"type":"string"},"internalSupplierId":{"description":"ID of the internal supplier. Only mandatory when the `Enable InternalSupplierID` setting is active at organization level, | It must have the format of the organization supplier's external identifier + '_' + Yokoy legal entity ID.","example":"S33998_aB9jQoE3HE","type":"string"},"isTemplateOneTimeSupplier":{"default":false,"description":"Determines whether the supplier is to be imported as a one-time vendor or not. One-time vendors are only supported in SAP systems. If the supplier is a template to be used for non-recurring one-time suppliers, you must set this attribute as `true`.","nullable":false,"type":"boolean"},"name":{"description":"Full company name of the supplier.","example":"Acme INC","type":"string"},"secondaryName":{"description":"Additional information about the supplier name.","example":"Department A","nullable":true,"type":"string"},"shortName":{"description":"Short name of the supplier for display.","example":"Acme","nullable":true,"type":"string"},"statusActive":{"default":false,"type":"boolean"},"street":{"description":"Street where the supplier is located.","example":"Isartorpl 8","nullable":true,"type":"string"},"taxNumber":{"deprecated":true,"description":"Legal tax number of the supplier. Use `taxNumbers` instead.","example":"123456789","nullable":true,"type":"string"},"taxNumbers":{"default":[],"description":"An array of the supplier's legal tax numbers. Use this attribute instead of `taxNumber` after setting `taxNumber` to null.","example":["CH123456789","CH115222333"],"items":{"nullable":false,"type":"string"},"nullable":true,"type":"array"},"url":{"description":"Website of the supplier.","example":"https://www.example.com","nullable":true,"type":"string"},"zipCode":{"description":"Postal code where the supplier is located.","example":"D18 V6K0","nullable":true,"type":"string"}},"required":["id","externalId","name"],"type":"object"},"PaginationItemsPerPage":{"description":"Returns the number of items in the paginated result. This attribute is only included in paginated results with `count`.","example":30,"type":"number"},"PaginationNextCursor":{"description":"Cursor to be used to fetch the next set of items.\nIt is only resulted in calls that pass `count`in the query parameters to retrieve paginated results. When there are no further results, the attribute is not returned.\n","example":"06x2u4nagAMEq3gGMoch","type":"string"},"Policy":{"properties":{"categoryIds":{"description":"List of applicable expense categories to be displayed to users with this policy.","items":{"description":"Yokoy unique ID of the expense category.","example":"1WOspYIfp6","pattern":"[\\w-]+","type":"string"},"type":"array"},"code":{"description":"Code (ERP) of the employee policy. ERP reference.","example":"policy0","type":"string"},"id":{"description":"Yokoy unique identifier of the policy.","example":"06x2u4nagAMEq3gGoMch","pattern":"[\\w-]+","readOnly":true,"type":"string"},"name":{"description":"Name of the policy.","example":"Default policy - Managers only","type":"string"},"statusActive":{"description":"Status of the policy. Only active policies can be applied to users.","example":true,"type":"boolean"}},"required":["name","code","categoryIds","statusActive"],"type":"object"},"PurchaseOrder":{"properties":{"currency":{"description":"Currency of the purchase order. ISO 4217 three-letter code.","example":"CHF","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information associated with the purchase order.","example":{"externalId":"I123"},"nullable":true,"type":"object"},"description":{"description":"Description of the purchase order.","example":"PO - Metal rod supply for Company A.","nullable":true,"type":"string"},"externalId":{"description":"External ID of the purchase order.","example":"external-1234567890","nullable":true,"type":"string"},"grossAmount":{"description":"Gross amount of the purchase order. This is calculated from the purchase order's line items.","example":466.82,"minimum":0,"readOnly":true,"type":"number"},"id":{"description":"Yokoy unique ID of the purchase order.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","readOnly":true,"type":"string"},"items":{"description":"Purchase order line items","items":{"$ref":"#/components/schemas/PurchaseOrderItem"},"nullable":false,"type":"array"},"netAmount":{"description":"The purchase order's net amount. This is calculated from the purchase order's line items.","example":421.96,"minimum":0,"readOnly":true,"type":"number"},"paymentTermsId":{"description":"Payment terms associated with the purchase order. It must link to an existing invoice payment term.","example":"44UX9MYYP","nullable":true,"type":"string"},"purchaseOrderNumber":{"description":"Number of the purchase order.","example":"PO-1234567890","type":"string"},"purchaseOrderOwnerId":{"description":"Yokoy unique ID of the user responsible for the purchase order.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"pattern":"[\\w-]+","type":"string"},"quantity":{"description":"Sum of the quantities of all PO line items.","example":123,"nullable":false,"readOnly":true,"type":"number"},"status":{"default":"active","description":"Status of the purchase order. Purchase orders can\u2018t be deleted from Yokoy. However, you can make a PO inactive so it is not taken into account for matching.","enum":["active","inactive","expired","deleted","blocked"],"example":"active","type":"string"},"statusActive":{"deprecated":true,"description":"Status of the purchase order. Purchase orders can\u2018t be deleted from Yokoy. However, you can make a PO inactive so it is not taken into account for matching.\nDeprecated. Use `status` instead. If both `status` and `statusActive` are provided, the value of `status` is taken.\n","example":true,"nullable":false,"type":"boolean"},"supplierId":{"description":"Yokoy ID of the legal entity supplier associated with the purchase order. It must link to an existing legal entity supplier.","example":"bbebb9a0-87ef-439c-9ac3-e320e47d85d5","pattern":"[\\w-]+","type":"string"},"validityEndDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Validity end date for the purchase order.","nullable":true}]},"validityStartDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Validity start date for the purchase order.","nullable":true}]}},"required":["id","purchaseOrderNumber","supplierId","statusActive","currency","items"],"type":"object"},"PurchaseOrderItem":{"properties":{"categoryId":{"description":"Yokoy unique ID of the invoice category associated with the line item. It must link to an existing invoice category.","example":"hm0qUnb8s","nullable":true,"type":"string"},"costObjectId":{"description":"Yokoy unique ID of the cost object associated with the line item. It must link to an existing cost object.","example":"Y6cp2G30M","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information associated with the purchase order item.","example":{"externalId":"I123"},"nullable":true,"type":"object"},"description":{"description":"Description of the PO line item.","example":"Headless screw (grub screw) Flat End Cl 45H","nullable":true,"type":"string"},"eanupc":{"description":"EAN or UPC or barcode of the item.","example":"1234 5678 90","nullable":true,"type":"string"},"externalId":{"description":"External ID of the PO line item.","example":"external-1234567890","nullable":true,"type":"string"},"grossAmount":{"description":"Gross amount of the PO line item.","example":226.06,"minimum":0,"type":"number"},"id":{"description":"Yokoy unique ID of the purchase order.\nFor new items, Yokoy generates the ID. For existing items, you can reference that ID.\n","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"itemNumber":{"description":"Position of the PO line item.","example":"1234567890","nullable":true,"type":"string"},"itemPrice":{"description":"Item price of the PO line item.","example":6.0,"minimum":0,"nullable":true,"readOnly":false,"type":"number"},"materialId":{"description":"ERP ID of the material associated with line item.","example":"45678952","nullable":true,"type":"string"},"netAmount":{"description":"Net amount of the PO line item.","example":186.0,"minimum":0,"type":"number"},"quantity":{"description":"Quantity of the PO line item.","example":31,"minimum":0,"nullable":false,"type":"number"},"requireGoodsReceipt":{"description":"If enabled, Yokoy performs three way matching for this item, and requires a goods receipt. If no goods receipt data is sent, the line item cannot be matched.","example":true,"type":"boolean"},"status":{"default":"active","description":"Status of the purchase order item, indicating its current state.","enum":["active","inactive","deleted","blocked"],"example":"active","type":"string"},"statusActive":{"deprecated":true,"description":"Status of the purchase order item, whether the purchase order item is active. Deprecated. Use `status` instead. If both `status` and `statusActive` are provided, the value of `status` is taken.","example":true,"nullable":false,"type":"boolean"},"supplierMaterialId":{"description":"Description/ID that the supplier provided for the goods/service stated in the PO line item.","example":"SCREW X1231","nullable":true,"type":"string"},"taxRateId":{"description":"Yokoy unique ID of the tax rate associated with the line item. It must link to an existing tax rate.","example":"06x2u4nagAMEq3gGMoch","nullable":true,"type":"string"},"unit":{"description":"Unit of the PO line item.","example":"kg","nullable":true,"type":"string"}},"type":"object"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/OrganizationSupplier"},{"$ref":"#/components/schemas/LegalEntitySupplier"}]},"SupplierAutoSubmissionDocumentSettings":{"properties":{"amount":{"description":"Threshold amount (**Max. allowed amount**) below which the supplier document is submitted automatically by Yokoy when all other conditions are met.\nThe amount is converted to the currency of the legal entity.\nA 0 or `null` amount means that all documents are auto-submitted.\n","example":1000,"minimum":0,"nullable":true,"type":"number"},"enabled":{"example":false,"type":"boolean"}},"required":["enabled"],"type":"object"},"SupplierAutoSubmissionSettings":{"properties":{"nonPoCreditNotes":{"allOf":[{"$ref":"#/components/schemas/SupplierAutoSubmissionDocumentSettings"},{"description":"Auto-submission settings for credit note without a PO documents","nullable":true}]},"nonPoInvoices":{"allOf":[{"$ref":"#/components/schemas/SupplierAutoSubmissionDocumentSettings"},{"description":"Auto-submission settings for invoice documents without a PO","nullable":true}]},"poCreditNotes":{"allOf":[{"$ref":"#/components/schemas/SupplierAutoSubmissionDocumentSettings"},{"description":"Auto-submission settings for credit note with a PO documents","nullable":true}]},"poInvoices":{"allOf":[{"$ref":"#/components/schemas/SupplierAutoSubmissionDocumentSettings"},{"description":"Auto-submission settings for invoice documents with a PO","nullable":true}]},"status":{"description":"Status of the auto-submission settings.\n- `disabled`: Invoices and/or credit notes for the supplier are not auto-submitted. This overrides any auto-submission settings defined at company level.\n- `enabled`: Invoices and/or credit notes for the supplier are auto-submitted using the auto-submission settings specified.\n- `entity`: Invoices and/or credit notes may be auto-submitted according to the setting defined at company level.\n","enum":["disabled","enabled","entity"],"example":"entity","nullable":false,"type":"string"}},"required":["status"],"type":"object"},"SupplierContact":{"properties":{"email":{"description":"Email address of the supplier's contact.","example":"quinn.leavy@example.com","type":"string"},"firstName":{"description":"Given name of the supplier's contact.","example":"Quinn","type":"string"},"lastName":{"description":"Family name of the supplier's contact.","example":"Leavy","type":"string"},"phone":{"description":"Phone number of the supplier's contact.","example":"+49 12 3456789","type":"string"},"role":{"description":"Contact's role in the supplier company.","example":"Sales representative","type":"string"}},"required":["email","firstName","lastName","phone","role"],"type":"object"},"Tag":{"properties":{"code":{"description":"External reference used by the ERP. If not required, it can be the same as the dimension code.","example":11,"type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information attributes associated with the tag.","example":"{\"requiresEscalation\": true, \"ledgerCode\": \"ABC123\" }","nullable":true,"type":"object"},"dimensionCode":{"description":"Dimension code associated with the tag.","example":"miscellaneous","type":"string"},"expenseApproverIds":{"description":"List of expense approvers identified by their Yokoy unique ID. This is used in expense-based workflows.","items":{"description":"Yokoy ID of the user.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"nullable":true,"type":"array"},"id":{"description":"Yokoy unique ID of the tag.","example":"CP0YGe9VwzWixLOZdTK8","pattern":"[\\w-]+","readOnly":true,"type":"string"},"invoiceApproverIds":{"description":"List of invoice approvers identified by their Yokoy unique ID. This is used in invoice-based workflows.","items":{"description":"Yokoy ID of the user.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","type":"string"},"nullable":true,"type":"array"},"name":{"description":"Descriptive name of the tag.","example":"Relocation services","type":"string"},"statusActive":{"description":"Status of the tag.","example":true,"type":"boolean"}},"required":["name","code","dimensionCode","statusActive"],"type":"object"},"TaxComponents":{"description":"Advanced tax configuration has to be enabled for the legal entity to use tax rate components. Applicable only for invoices. If tax components are present, tax rate version is set to `two` internally.","properties":{"assessmentType":{"description":"Whether the tax component is self-assessed or seller-assessed.","enum":["selfAssessed","sellerAssessed"],"example":"sellerAssessed","nullable":false,"type":"string"},"expenseAccount":{"description":"Expense account to be used to post the tax component.","example":"GST-5","type":"string"},"inputAccount":{"description":"Input account for the tax component","example":"GST-5 IN","type":"string"},"name":{"description":"Name of the tax rate component.","example":"GST","type":"string"},"outputAccount":{"description":"The output account for the tax component","example":"GST-5 OUT","type":"string"},"rate":{"description":"Rate of the tax component.","example":5,"nullable":true,"type":"number"},"recoverablePercentage":{"description":"Recoverable percentage of the tax component. 100 is interpreted as 100%","example":0,"type":"number"}},"required":["name","rate","recoverablePercentage","assessmentType"],"type":"object"},"TaxItem":{"properties":{"gross":{"description":"Gross amount subject to the tax rate in the expense currency.","example":150.0,"type":"number"},"rateId":{"description":"Yokoy's unique ID of the tax rate.","example":"06x2u4nagAMEq3gGMoch","pattern":"[\\w-]+","type":"string"},"tax":{"description":"Tax amount in the expense currency.","example":15.0,"type":"number"}},"type":"object"},"TaxRate":{"properties":{"accountReference":{"description":"Account (ERP) associated with the tax rate. Relevant for posting bookings.","example":6300,"type":"string"},"code":{"description":"Code (ERP). External reference of the tax rate.","example":"tax77","type":"string"},"country":{"description":"Country of the tax rate. Expressed as an ISO 3166 Alpha-2 code.","example":"CH","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information attributes associated with the tax rate.","example":{"externalId":"Tax1"},"nullable":true,"type":"object"},"id":{"description":"Yokoy unique ID of the tax rate.","example":"06x2u4nagAMEq3gGMoch","pattern":"[\\w-]+","readOnly":true,"type":"string"},"name":{"description":"Name of the tax rate.","example":"Standard rate","type":"string"},"rate":{"description":"Tax rate in percentage. Used to match tax rate when digitizing expenses. Accepts numbers up to 15 decimal places.","example":19,"type":"number"},"statusActive":{"description":"Status of the tax rate. Only active rates are considered in expenses and invoices.","example":true,"type":"boolean"},"type":{"description":"Category that classifies the tax rate. Used to determine the tax rate in e-invoices.","enum":["standard","reduced","specialReduced","zero","exempt","domesticReverseCharge"],"example":"standard","nullable":false,"type":"string"},"validityEndDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Validity end date for the tax rate.","example":"2024-01-01","nullable":true}]},"validityStartDate":{"allOf":[{"$ref":"#/components/schemas/DateString"},{"description":"Validity start date for the tax rate.","example":"2020-01-01","nullable":true}]},"version":{"description":"Applicable only for invoices. Version set to `two` internally if tax rate has components; otherwise `one`. If no version is present, the version is considered to be `one`.","enum":["one","two"],"nullable":false,"readOnly":true,"type":"string"}},"required":["name","code","accountReference","rate","country","statusActive"],"type":"object"},"Transaction":{"properties":{"billingAmount":{"description":"Amount of the transaction, expressed in the billing currency.","example":"23.88","exclusiveMinimum":true,"minimum":0,"type":"number"},"billingCurrency":{"description":"Billing currency of the transaction. ISO 4217 three-letter code.","example":"EUR","pattern":"\\W{3}","type":"string"},"bookingDate":{"description":"Date when the transaction was booked, also known as posting date. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2025-02-24T15:38:02Z","format":"date-time","nullable":true,"type":"string"},"cardId":{"description":"Yokoy unique ID of the card to which the transaction is associated.","example":"Y6c2p3G0x","pattern":"[\\w-]+","type":"string"},"country":{"description":"Code of the country where the transaction took place. Expressed as an ISO 3166 Alpha-2 code.","example":"CH","nullable":true,"pattern":"\\W{2}","type":"string"},"created":{"description":"Timestamp (date and time) when the transaction was created. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2025-03-01T11:08:45.478Z","format":"date-time","readOnly":true,"type":"string"},"expenseId":{"description":"Yokoy unique ID of the expense to which the transaction is associated.","example":"aB9jQoE3HE","nullable":true,"pattern":"[\\w-]+","readOnly":true,"type":"string"},"expenseStatus":{"description":"Read-only field.\nWhenever a transaction is matched to an expense, this attribute indicates the status of the associated expense:\n - `0`: Expense is not ready for export.\n - `1`: Expense is ready for export.\n - `2`: Expense is exported.\n","enum":[0,1,2],"example":1,"nullable":true,"readOnly":true,"type":"number"},"id":{"description":"Yokoy unique ID of a transaction.","example":"2OAxBAFT9","pattern":"[\\w-]+","readOnly":true,"type":"string"},"isCreditNote":{"description":"Indicates whether the transaction is a credit note or a refund.","nullable":false,"type":"boolean"},"legalEntityId":{"description":"Yokoy unique ID of the legal entity to which the transaction is assigned.","example":"wrOWz6e_33I0vNzQPMWyY","pattern":"[\\w-]+","type":"string"},"matchingStatus":{"description":"Indicates whether a transaction document is matched with an expense document.\n - `0`: Transaction is not matched.\n - `1`: Transaction is matched.\n - `2`: [deprecated] Transaction is private.\n - `5`: Transaction is archived. Archived transactions cannot be matched against expenses and are ignored by Yokoy in auto-matching.\n","enum":[0,1,2,5],"example":1,"readOnly":true,"type":"number"},"mccSicCode":{"description":"Merchant category transaction classification. ISO 18245.","example":"9999","nullable":true,"pattern":"\\d{4}","type":"string"},"merchant":{"description":"Merchant or description of the transaction.","example":"Store XYZ. Street 0, City, Country","pattern":"[\\w-]+","type":"string"},"sourceAmount":{"description":"Amount of the transaction, expressed in the source currency.","example":"25.00","exclusiveMinimum":true,"minimum":0,"nullable":true,"type":"number"},"sourceCurrency":{"description":"Source currency of the transaction (i.e. a foreign currency). ISO 4217 three-letter code.","example":"USD","nullable":true,"pattern":"\\W{3}","type":"string"},"statementReference":{"description":"External reference to the associated statement. Depending on the provider, this information may or may not be provided. Not available for Yokoy's Platinum Visa and Business Mastercard products.","example":"abc_ABC-09","pattern":"[\\w-]+","readOnly":true,"type":"string"},"transactionDate":{"description":"Date when the transaction occurred. Expressed in `YYYY-MM-DD` format.","example":"2025-02-24","pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string"}},"required":["transactionDate","legalEntityId","cardId","merchant","billingAmount","billingCurrency"],"type":"object"},"Trip":{"properties":{"created":{"description":"Timestamp (date and time) of when the trip was created. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","type":"string"},"currency":{"description":"Original trip currency. ISO 4217 three-letter code.","example":"EUR","type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information associated with the trip.","example":{"bookingType":"ASDF1234"},"nullable":true,"type":"object"},"endDatetime":{"description":"End timestamp of the trip. Expressed in `YYYY-MM-DDThh:mm` format.","example":"2023-06-14T23:11","type":"string"},"id":{"description":"Yokoy unique ID of the trip.","example":"uhmkC9zMzn","pattern":"[\\w-]+","readOnly":true,"type":"string"},"lastModified":{"description":"Timestamp (date and time) of when the trip was last modified. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","type":"string"},"legalEntityId":{"description":"Yokoy unique ID of the legal entity to which the trip is assigned.","example":"aB9jQoE3HE","type":"string"},"name":{"description":"Name or short description of the trip (free text descriptions added by users).","example":"Business travel to NYC","type":"string"},"startDatetime":{"description":"Start date timestamp (date and time) of the trip. Expressed in `YYYY-MM-DDThh:mm` format.","example":"2023-06-14T23:11","type":"string"},"status":{"description":"Status of the trip. Indicates the overall status of all expenses included in the trip.","enum":["draft","needsRevision","forApproval","forReview","forExpenseExport","rejected","expenseExported","forTransactionExport","transactionExported","readyForTripSubmission","travelDraft","tripPreApprovalDraft","tripPreApprovalNeedsRevision","tripPreApprovalInPreApproval","tripPreApprovalPreApproved","tripPreApprovalRejected"],"example":"draft","type":"string"},"totalClaim":{"description":"Total claim of the trip.","example":1000.0,"minimum":0.0,"nullable":true,"type":"number"},"userId":{"description":"Yokoy unique ID of the user.","example":"9L7rovNzNhTCsJSTkbfq","nullable":true,"pattern":"[\\w-]+","type":"string"}},"required":["id","status","totalClaim"],"type":"object"},"UpdateInvoice":{"description":"Update the custom information associated with the invoice.\nAny attributes are added to existing attributes.\nTo reset or delete a specific attribute, set it to `null`.\n","example":{"customInformation":{"department":"Engineering","project":"Tokyo"},"lineItems":[{"customInformation":{"city":null,"targetCountry":"Switzerland"}},{"customInformation":{}},{"customInformation":null},{}]},"properties":{"customInformation":{"additionalProperties":true,"description":"Dictionary of custom information associated with the invoice.\nThe data of the object is merged with the existing values on a top level.\nDeeper levels are overwritten by the new data and not merged.\nTo reset a specific attribute, set it to `null`. Yokoy treats empty values as `null`.\n","example":{"customKey":"customValue"},"nullable":true,"type":"object"},"lineItems":{"description":"List of changes to custom information to update at line item level.\nLine items are identified by their index in the list.\nThe list must contain exactly the same number of items as line items of the invoice.\n","items":{"$ref":"#/components/schemas/UpdateInvoiceLineItem"},"nullable":true,"type":"array"}},"type":"object"},"UpdateInvoiceLineItem":{"properties":{"customInformation":{"additionalProperties":true,"description":"Dictionary of custom information associated with the invoice.\nThe data of the object is merged with the existing values on a top level.\nDeeper levels are overwritten by the new data and not merged.\nTo reset a specific attribute, set it to `null`. Yokoy treats empty values as `null`.\n","nullable":true,"type":"object"}},"type":"object"},"User":{"properties":{"costCenterId":{"description":"Yokoy unique ID of the associated cost object.","example":"Mt34DVcI8R2sdLutWViu","nullable":true,"pattern":"[\\w-]+","type":"string"},"created":{"description":"Timestamp (date and time) when the user was created. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","type":"string"},"currency":{"description":"User's currency. Relevant when bookings are converted to the employee's currency. ISO 4217 three-letter code.","example":"CHF","nullable":true,"type":"string"},"customInformation":{"additionalProperties":{"type":"string"},"description":"Dictionary of custom information attributes associated with the user.","example":{"externalId":"E111"},"nullable":true,"type":"object"},"email":{"description":"User's email address. Used to log into Yokoy. The email address must be unique for the organization.","example":"alex.perez@example.com","format":"email","type":"string"},"employeeId":{"description":"Creditor account number of the user to be used to book any privately paid expenses. It can be a vendor account (for expenses booked on Accounts Payable) or a transit account (for General Ledger). Otherwise, this field can be used for a unique identifier.\n","example":5599,"type":"string"},"firstName":{"description":"Given name or preferred name of the user.","example":"Alex","type":"string"},"id":{"description":"Yokoy ID of the user.","example":"9L7rovNzNhTCsJSTkbfq","pattern":"[\\w-]+","readOnly":true,"type":"string"},"invitationOnCreation":{"description":"Send an invitation to access Yokoy to the user when created.","example":false,"nullable":true,"type":"boolean"},"language":{"description":"Preferred language for using Yokoy. Expressed as ISO 639 two-letter language code (except German (CH) and English (UK)).","enum":["de","de-ch","en","en-gb","es","fr","nl","pl","zh","ja"],"example":"en","nullable":true,"type":"string"},"lastModified":{"description":"Timestamp (date and time) when the user was last modified. Expressed in ISO 8601 format. Coordinated Universal Time (UTC).","example":"2022-11-15T17:08:45.478Z","format":"date-time","type":"string"},"lastName":{"description":"Family name of the user.","example":"Perez","type":"string"},"legalEntityId":{"description":"Yokoy ID of the legal entity to which the user belongs.","example":"aB9jQoE3HE","pattern":"[\\w-]+","type":"string"},"lineManagerDelegateId":{"description":"Yokoy unique ID of the user who can approve on behalf of the line manager.","example":"MExmmEkr2KqE9onO0BDN","nullable":true,"pattern":"[\\w-]+","type":"string"},"lineManagerId":{"description":"Yokoy unique ID of the user who is the user's line manager.","example":"OYwMfJJcAdOtUvT292a7","nullable":true,"pattern":"[\\w-]+","type":"string"},"lineManagerThreshold":{"description":"Approval limit in the legal entity's currency.","example":1000.0,"minimum":0.0,"nullable":true,"type":"number"},"notifyAssistant":{"description":"Send a notification (if enabled in Company settings) to the assistant identified in `submissionDelegateId`.","example":true,"nullable":true,"type":"boolean"},"policyId":{"description":"Yokoy unique ID of the associated employee policy ID.","example":"0QP9qtsCUJ1rkt5s6qtI","nullable":true,"pattern":"[\\w-]+","type":"string"},"statusActive":{"description":"Status of the user. If active, the user can log into Yokoy.","example":true,"type":"boolean"},"submissionDelegateId":{"description":"Yokoy unique ID of the user who can act on the user's behalf as an assistant.","example":"IfukBQl9lopuuwJRASnS","nullable":true,"pattern":"[\\w-]+","type":"string"}},"required":["firstName","lastName","legalEntityId","email","employeeId","statusActive"],"type":"object"},"UserBankInformation":{"properties":{"BIC":{"description":"Branch Identifier Code of the user\u2018s bank account.","example":"BARCGB22XXX","nullable":true,"type":"string"},"IBAN":{"description":"IBAN of the user\u2018s bank account.","example":"CH9300762011623852957","nullable":true,"type":"string"},"accountHolderName":{"description":"Account holder name associated with the user\u2018s bank account.","example":"Jo Smith","nullable":true,"type":"string"}},"type":"object"}},"securitySchemes":{"OAuth2":{"description":"Authentication to the Yokoy API relies on the standard OAuth2 client credentials flow.\n\n**1. Obtain an access token**\n\nPerform a `POST` request to\n`https://accounts.yokoy.ai/oauth2/token`. Pass the client ID\nand client secret as username and password in a basic auth\nheader. Set the content-type to\n`application/x-www-form-urlencoded` and specify\n`grant_type=client_credentials` in the body.\n\n> Note: For the Yokoy test environment, use `https://accounts.test.yokoy.ai/oauth2/token` instead.\n\nExample request for the client ID `ClientId` and client\nsecret `ClientSecret`:\n```\nPOST https://accounts.yokoy.ai/oauth2/token\nAuthorization: Basic Q2xpZW50SWQ6Q2xpZW50U2VjcmV0\nContent-Type: application/x-www-form-urlencoded\ngrant_type=client_credentials\n```\nIn this example, the string `Q2xpZW50SWQ6Q2xpZW50U2VjcmV0` is\nobtained by base64-encoding the string\n`ClientId:ClientSecret`, as required for basic access authentication.\n\n> Note: Yokoy does not require or use scopes.\n\n\nThe JSON response contains the access token in the attribute\n`access_token`. The response also contains the expiration in\nseconds.\n\nExample response:\n```\n{\n    \"access_token\": \"SOME_KEY\",\n    \"expires_in\": 3900,\n    \"token_type\": \"Bearer\"\n}\n```\n\n**2. Pass the bearer token**\n\nPass the access token from step 1 as a bearer token in subsequent requests to the API.\n\nExample header field for the example response from step 1:\n```\nAuthorization: Bearer 4lDvPkrBF87WHuyvlINQD\n```\n\nFor more information, see (Authentication & authorization)[https://developer.yokoy.ai/docs/overview/authentication].\n","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://accounts[.test].yokoy.ai/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"Public API of the Yokoy Application","title":"Yokoy API","version":"1.41.0"},"openapi":"3.0.0","paths":{"/expenses":{"get":{"description":"Returns all expenses for the legal entity specified as a path parameter.","operationId":"listExpenses","parameters":[{"$ref":"#/components/parameters/QueryFilter"},{"$ref":"#/components/parameters/PaginationCount"},{"$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"expenses":{"items":{"$ref":"#/components/schemas/Expense"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all expenses","tags":["Expense"]},"parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/expenses/{expenseId}":{"get":{"description":"Retrieves an expense identified by its Yokoy unique ID.","operationId":"getExpense","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Expense"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get expense by ID","tags":["Expense"]},"parameters":[{"description":"Yokoy unique ID of the expense.","example":"aB9jQoE3HE","in":"path","name":"expenseId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/expenses/{expenseId}/attachments/{attachmentName}":{"get":{"description":"Retrieves an expense attachment. The expense is identified by its Yokoy unique ID and the attachment by its name. The response contains a URL redirect to the location of the receipt. The URL redirect expires after 15 minutes for security reasons. The response header contains the content type that indicates the type of file. For example, `application/pdf` or `image/jpeg`.","operationId":"getExpenseAttachment","responses":{"302":{"$ref":"#/components/responses/Found"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get expense attachment","tags":["Expense"]},"parameters":[{"description":"Yokoy unique ID of the expense.","example":"aB9jQoE3HE","in":"path","name":"expenseId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"description":"Name of an attachment from attachments array","example":"attachment.jpeg","in":"path","name":"attachmentName","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/expenses/{expenseId}/receipt":{"get":{"description":"Retrieves the receipt of an expense identified by its Yokoy unique ID. The response contains a URL redirect to the location of the receipt. The URL link expires after 15 minutes for security reasons. The response header contains the content type that indicates the type of file. For example, `application/pdf` or `image/jpeg`.","operationId":"getExpenseReceipt","responses":{"302":{"$ref":"#/components/responses/Found"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get expense receipt","tags":["Expense"]},"parameters":[{"description":"Yokoy unique ID of the expense.","example":"aB9jQoE3HE","in":"path","name":"expenseId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/fx-rate-sources":{"get":{"description":"Returns all foreign exchange rate sources.","operationId":"listFxRateSources","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"fxRateSources":{"items":{"$ref":"#/components/schemas/FxRateSource"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"example":{"code":400,"message":"Invalid request"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List FX rate sources","tags":["FX rates"]},"parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new foreign exchange rate source and returns the created entity.","operationId":"createFxRateSource","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRateSource"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRateSource"}}},"description":"Created"},"400":{"content":{"application/json":{"example":{"code":400,"message":"ValidationError: name has to be set"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create FX rate source","tags":["FX rates"]}},"/fx-rate-sources/{fxRateSourceId}/fx-rates/{isoDate}":{"parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"},{"description":"Yokoy ID of the foreign exchange rate source.","example":"aB9jQoE3HE","in":"path","name":"fxRateSourceId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"description":"Effective date of the exchange rate. Expressed in YYYY-MM-DD format.","in":"path","name":"isoDate","required":true,"schema":{"example":"2023-03-31","pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string"}}],"put":{"description":"Sets the foreign exchange rates as per the specified source and date.","operationId":"applyFxRate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRates"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRates"}}},"description":"OK"},"400":{"content":{"application/json":{"example":{"code":400,"message":"ValidationError: fxRates have to be set"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Apply FX rate","tags":["FX rates"]}},"/legal-entities":{"get":{"description":"Returns all legal entities for the organization specified by its Yokoy unique ID in the path.","operationId":"listLegalEntities","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"legalEntities":{"items":{"$ref":"#/components/schemas/LegalEntity"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all legal entities","tags":["Legal entity"]},"parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/legal-entities/{legalEntityId}":{"get":{"description":"Returns the legal entity specified by its Yokoy unique ID in the path.","operationId":"getLegalEntity","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntity"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a legal entity (company) by ID","tags":["Legal entity"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/legal-entities/{legalEntityId}/card-accounts":{"get":{"description":"Retrieves all card accounts for the legal entity.","operationId":"listCardAccounts","parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"cardAccounts":{"items":{"$ref":"#/components/schemas/CardAccount"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all card accounts","tags":["Card account"]}},"/legal-entities/{legalEntityId}/card-accounts/{cardAccountId}":{"get":{"description":"Retrieves a card account identified by its Yokoy unique ID.","operationId":"getCardAccount","parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the card account.","example":"ZwdGXln3gohDDdMeDUsW","in":"path","name":"cardAccountId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardAccount"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get card account by ID","tags":["Card account"]}},"/legal-entities/{legalEntityId}/card-accounts/{cardAccountId}/balance":{"get":{"description":"Retrieves the current balance of a card account identified by its Yokoy unique ID. Only available for Yokoy Platinum Visa.","operationId":"getBalance","parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the card account.","example":"ZwdGXln3gohDDdMeDUsW","in":"path","name":"cardAccountId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardAccountBalance"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get card account balance","tags":["Card account"]}},"/legal-entities/{legalEntityId}/card-accounts/{cardAccountId}/daily-statements":{"get":{"description":"Retrieves daily statement references for the card account identified by its Yokoy unique ID.","operationId":"listDailyStatements","parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the card account.","example":"ZwdGXln3gohDDdMeDUsW","in":"path","name":"cardAccountId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/QueryFilter"},{"$ref":"#/components/parameters/PaginationCount"},{"$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"dailyStatementReferences":{"items":{"$ref":"#/components/schemas/DailyStatementReference"},"type":"array"},"nextCursor":{"$ref":"#/components/schemas/PaginationNextCursor"}},"required":["dailyStatementReferences"],"type":"object"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List daily statements","tags":["Daily statement"]}},"/legal-entities/{legalEntityId}/card-accounts/{cardAccountId}/daily-statements/{statementId}":{"get":{"description":"Downloads the CAMT statement file for the given statement ID.","operationId":"getDailyStatement","parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the card account.","example":"ZwdGXln3gohDDdMeDUsW","in":"path","name":"cardAccountId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"description":"Unique ID of the daily statement.","example":"2025-02-05","in":"path","name":"statementId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/xml":{"schema":{"type":"string"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Download daily statement","tags":["Daily statement"]}},"/legal-entities/{legalEntityId}/categories":{"get":{"description":"Retrieves all categories belonging to the legal entity identified in the path.","operationId":"listExpenseCategories","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all expense categories for a legal entity","tags":["Expense category"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new category for the legal entity specified by its Yokoy unique ID in the path. It returns the created entity.","operationId":"createExpenseCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":"Created"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create an expense category","tags":["Expense category"]}},"/legal-entities/{legalEntityId}/categories/{categoryId}":{"get":{"description":"Retrieves an expense category by specifying its Yokoy unique ID in the path.","operationId":"getExpenseCategory","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get an expense category by ID","tags":["Expense category"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the expense category.","example":"1WOspYIfp6","in":"path","name":"categoryId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates an expense category by replacing some attributes. The legal entity and expense category are specified by their unique IDs in the path. Only the attributes specified in the body are updated. Other attributes are not updated. The whole entity is returned.","operationId":"modifyExpenseCategory","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of expense category attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify an expense category","tags":["Expense category"]},"put":{"description":"Updates an expense category by replacing all attributes. The legal entity and expense category are specified by their unique IDs in the path. Any category attributes that are not specified in the request body are updated with null or \"\". If any required attributes are updated as null, the category is marked as inactive. The whole entity is returned.","operationId":"updateExpenseCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update an expense category","tags":["Expense category"]}},"/legal-entities/{legalEntityId}/company-cards":{"get":{"description":"Retrieves all company cards for the legal entity specified by its Yokoy unique ID in the path.","operationId":"listCompanyCards","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"companyCards":{"items":{"$ref":"#/components/schemas/CompanyCard"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all company cards","tags":["Company card"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new company card for the legal entity specified by the unique ID in the path. It returns the created entity.","operationId":"createCompanyCard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCard"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCard"}}},"description":"Created."},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a company card","tags":["Company card"]}},"/legal-entities/{legalEntityId}/company-cards/{companyCardId}":{"get":{"description":"Retrieves a company card for a specific legal entity as specified by their unique IDs in the path.","operationId":"getCompanyCard","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCard"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a company card by ID","tags":["Company card"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID for the company card.","example":"Y6c2p3G0x","in":"path","name":"companyCardId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a company card by replacing some attributes. Only attributes specified in the request body are updated. The other attributes remain unchanged. The whole entity is returned.","operationId":"modifyCompanyCard","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of company card attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCard"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a company card","tags":["Company card"]},"put":{"description":"Updates a specific company card for a legal entity by replacing all attributes. The legal entity and card are specified by their unique IDs in the path. Any card attributes that are not specified in the request body are updated with null or \"\". If any required attributes are updated as null, the card is marked as inactive. The whole entity is returned.","operationId":"updateCompanyCard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCard"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCard"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a company card","tags":["Company card"]}},"/legal-entities/{legalEntityId}/cost-centers":{"get":{"description":"Retrieves all cost objects for the legal entity (company) specified by its Yokoy unique ID in the path.","operationId":"listCostObjects","parameters":[{"description":"Filter string used to restrict the data returned. You can use [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) filters. All public fields are supported, except `created`, `lastModified`, `accessType` and `scopes`.","example":"customInformation.customField eq foo and approvalLimit le 1000","in":"query","name":"filter","schema":{"type":"string"}},{"$ref":"#/components/parameters/PaginationCount"},{"$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"costCenters":{"items":{"$ref":"#/components/schemas/CostCenter"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all cost objects","tags":["Cost center"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new cost object for the legal entity specified by its Yokoy unique ID in the path and returns the created entity.\nThe request body should contain `code`, `name`, and `statusActive` attributes. If you don\u2018t include these attributes, the cost object is created with `Draft` status. You can use the `statusActive` attribute to activate a cost object afterwards.\nTo set an expiry date for the delegate, edit the cost object in Yokoy (**Admin > Cost objects**).\n","operationId":"createCostObject","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}},"description":"Created"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a cost object","tags":["Cost center"]}},"/legal-entities/{legalEntityId}/cost-centers/{costCenterId}":{"delete":{"description":"Deletes a cost cobject specified by its Yokoy unique ID in the path.","operationId":"deleteCostObject","responses":{"204":{"description":"Cost object deleted."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Remove a cost object by ID","tags":["Cost center"]},"get":{"description":"Returns a cost object specified by its Yokoy unique ID in the path.","operationId":"getCostObject","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a cost object by ID","tags":["Cost center"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the cost object.","example":"Mt34DVcI8R2sdLutWViu","in":"path","name":"costCenterId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Update a cost object by replacing some attributes. The cost object and legal entity are specified in the path by their unique IDs. Only attributes specified in the request body are updated. The whole entity is returned. Optionally, you can specify a list of users that should be explicitly granted access to this cost object via the `userAccessGrants` property.","operationId":"modifyCostObject","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":true,"description":"Dictionary of cost object attributes to update. Explicit null values mark optional attributes for deletion. Mandatory attributes are marked as null.","type":"object"},{"properties":{"userAccessGrants":{"description":"A list of users that should be explicitly granted access to this cost object. This option is only allowed if the configured access type of the cost object is `specificUsers`.","example":[{"userId":"9L7rovNzNhTCsJSTkbfq"},{"userId":"0bbdZUtXFDD74cQVq5Mb"}],"items":{"properties":{"userId":{"type":"string"}},"required":["userId"],"type":"object"},"type":"array"}},"type":"object"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a cost object","tags":["Cost center"]},"put":{"description":"Updates a specific cost object by replacing all attributes. The legal entity and cost object are specified in the path by their unique IDs. The request body should contain `code`, `name`, and `statusActive` attributes. Otherwise, the cost object is flagged as inactive. Any other cost object attributes that are not specified in the request body are updated with null. The whole entity is returned.","operationId":"updateCostObject","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a cost object","tags":["Cost center"]}},"/legal-entities/{legalEntityId}/expense-export-facilities/{exportFacility}/export-tasks":{"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Type of expense that determines the export facility to be used. There are three standard types:\n- `expense` for single expenses, per diems and mileage expenses,\n- `card` for card transactions,\n- `travel` for travel expenses from third-party solutions.\n","in":"path","name":"exportFacility","required":true,"schema":{"enum":["expense","card","travel"],"example":"expense","type":"string"}}],"post":{"description":"Triggers an expense export in Yokoy. It returns the ID of the export job.","operationId":"triggerExpenseExport","requestBody":{"content":{"application/json":{"schema":{"properties":{"documentIds":{"description":"List of Yokoy expense IDs to be exported.\nRequired if `exportScope` is `documentIds`. It returns an error if the array length is less than one.\n","example":["aB9jQoE3HE"],"items":{"type":"string"},"type":"array"},"earliestPostingDate":{"description":"Earliest allowed posting date. For expenses with an earlier posting date, the posting date is replaced with the earliest allowed posting date (to avoid posting to already closed books).\nThe earlier posting date must follow these rules:\n  - it must be an ISO date in the format YYYY-MM-DD (e.g. 2025-03-18)\n  - it must be within 1 year (both past and future) of when an export was triggered.\n  For example, if the date on which you trigger the export job is 2025-03-18, then any date between `2024-03-18` and `2026-03-18` is valid.\n","example":"2023-03-31","pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string"},"exportScope":{"description":"Determines the expenses to be exported. You can export either all expenses in the scope of the export facility that are ready for export (`all`) or a determined set of expenses that are specified by their Yokoy unique IDs (`documentIds`).\n","enum":["all","documentIds"],"example":"all","type":"string"},"exporterId":{"description":"Yokoy unique ID of the user on behalf of which the export job is run. The user must have the finance role for the legal entity to trigger an export.","example":"zbRCb62OlcF8WcuOKVs9","type":"string"}},"required":["exportScope","exporterId","earliestPostingDate"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Task ID of the export job","example":"h6tplNlvNxnHUpeAwd7D","type":"string"}},"type":"object"}}},"description":"OK"},"204":{"description":"Nothing to export"},"400":{"content":{"application/json":{"example":{"code":400,"message":"Invalid request body"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The provided request body is invalid"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/InsufficientData"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Trigger expense export","tags":["Finance export"]}},"/legal-entities/{legalEntityId}/export-tasks":{"get":{"description":"Returns information on all the export jobs that have been triggered for a legal entity. Use query filters to restrict the number of export jobs returned.","operationId":"listExportJobs","parameters":[{"$ref":"#/components/parameters/ExportTaskQueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpenseExportTaskInformation"},{"$ref":"#/components/schemas/InvoiceExportTaskInformation"}]}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all export jobs","tags":["Finance export"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/legal-entities/{legalEntityId}/export-tasks/{exportTaskId}":{"get":{"description":"Returns the status of the asynchronous export job.","operationId":"getExportStatus","responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpenseExportTaskInformation"},{"$ref":"#/components/schemas/InvoiceExportTaskInformation"}]}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get export job status","tags":["Finance export"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Export job ID that identifies the task when triggering the export.","example":"aB9jQoE3HE","in":"path","name":"exportTaskId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/legal-entities/{legalEntityId}/export-tasks/{exportTaskId}/artefacts":{"get":{"description":"Retrieves the export artefacts where the selected export facility supports this feature.","operationId":"getExportArefacts","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Resources":{"items":{"oneOf":[{"$ref":"#/components/schemas/ExpenseExportArtefact"},{"$ref":"#/components/schemas/InvoiceExportArtefact"}]},"type":"array"}},"type":"object"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get export artefacts","tags":["Finance export"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the export job task.","example":"aB9jQoE3HE","in":"path","name":"exportTaskId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/legal-entities/{legalEntityId}/external-invoices":{"get":{"description":"Retrieves all external invoices for the legal entity specified by its Yokoy unique ID in the path.","operationId":"listExternalInvoices","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"external-invoices":{"items":{"$ref":"#/components/schemas/ExternalInvoice"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all external invoices","tags":["External invoice"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new external invoice for the legal entity specified by its Yokoy unique ID and returns the created entity.","operationId":"createExternalInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInvoice"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInvoice"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create an external invoice","tags":["External invoice"]}},"/legal-entities/{legalEntityId}/external-invoices/{externalInvoiceId}":{"get":{"description":"Retrieves an external invoice specified by its Yokoy unique ID in the path.","operationId":"getExternalInvoice","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInvoice"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get an external invoice by ID","tags":["External invoice"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the external invoice.","example":"9L7rovNzNhTCsJSTkbfq","in":"path","name":"externalInvoiceId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a external invoice by replacing some attributes. The external invoice is specified in the path by its Yokoy unique ID. The whole entity is returned.","operationId":"modifyExternalInvoice","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of external invoice attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify an external invoice","tags":["External invoice"]},"put":{"description":"Updates a specific external invoice by replacing all attributes. The external invoice is specified by its Yokoy unique ID. The whole entity is returned.","operationId":"updateExternalInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInvoice"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update an external invoice","tags":["External invoice"]}},"/legal-entities/{legalEntityId}/invoice-categories":{"get":{"description":"Retrieves all invoice categories for the legal entity identified in the path.","operationId":"listInvoiceCategories","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"invoice-categories":{"items":{"$ref":"#/components/schemas/InvoiceCategory"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all invoice categories","tags":["Invoice category"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new invoice category and returns the created entity.","operationId":"createInvoiceCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCategory"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCategory"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create an invoice category","tags":["Invoice category"]}},"/legal-entities/{legalEntityId}/invoice-categories/{categoryId}":{"get":{"description":"Retrieves an invoice category identified by its Yokoy unique ID.","operationId":"getInvoiceCategory","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCategory"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get an invoice category by ID","tags":["Invoice category"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the invoice category.","example":"hm0qUnb8s","in":"path","name":"categoryId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates an invoice category by replacing some attributes. The whole entity is returned.","operationId":"modifyInvoiceCategory","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of invoice category attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCategory"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify an invoice category","tags":["Invoice category"]},"put":{"description":"Updates an invoice category by replacing all attributes. The whole entity is returned.","operationId":"updateInvoiceCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCategory"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCategory"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update an invoice category","tags":["Invoice category"]}},"/legal-entities/{legalEntityId}/invoice-export-facilities/{exportFacility}/export-tasks":{"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"ID of the invoice export facility. The ID can be found in **Admin > Integrations** in the **Invoice export** tab by opening the wizard for the required export facility.\n\nThis export facility must be active in Yokoy.\n","example":"dfP59n4vLVvO6KWj27pS","in":"path","name":"exportFacility","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Triggers an invoice export in Yokoy. It returns the ID of the export job.","operationId":"triggerInvoiceExport","requestBody":{"content":{"application/json":{"schema":{"properties":{"documentIds":{"description":"List of Yokoy invoice IDs to be exported (only required if `exportScope` is `documentIds`)","items":{"type":"string"},"type":"array"},"earliestPostingDate":{"description":"Earliest allowed posting date. For invoices with an earlier posting date, the posting date is replaced with the earliest allowed posting date (to avoid posting to already closed books).\nThe earlier posting date must follow these rules:\n- it must be an ISO date in the format YYYY-MM-DD (e.g. 2025-03-18)\n- it must be within 1 year (both past and future) of when an export was triggered.\nFor example, if the date on which you trigger the export job is 2025-03-18, then any date between `2024-03-18` and `2026-03-18` is valid.\n","example":"2023-03-31","pattern":"\\d{4}-\\d{2}-\\d{2}","type":"string"},"exportScope":{"description":"Determines the expenses to be exported. You can export either all invoices in the scope of the export facility that are ready for export are exported (`all`) or a determined set of invoices that are specified by their Yokoy unique IDs (`documentIds`).","enum":["all","documentIds"],"example":"all","type":"string"},"exporterId":{"description":"Yokoy unique ID of the user on behalf of which the export job is run. The user must have the finance role for the legal entity to trigger an export.","example":"zbRCb62OlcF8WcuOKVs9","type":"string"}},"required":["exportScope","exporterId","earliestPostingDate"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Task ID of the export job","example":"h6tplNlvNxnHUpeAwd7D","type":"string"}},"type":"object"}}},"description":"OK"},"204":{"description":"Nothing to export"},"400":{"content":{"application/json":{"example":{"code":400,"message":"Invalid request body"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The provided request body is invalid"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Trigger invoice export","tags":["Finance export"]}},"/legal-entities/{legalEntityId}/invoice-goods-receipts":{"get":{"description":"Retrieves all goods receipt for the legal entity identified in the path.","operationId":"listGRs","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"invoice-goods-receipts":{"items":{"$ref":"#/components/schemas/GoodsReceipt"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all goods receipts","tags":["Goods receipt"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new invoice goods receipt and returns the created entity.","operationId":"createGR","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceipt"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceipt"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a goods receipt","tags":["Goods receipt"]}},"/legal-entities/{legalEntityId}/invoice-goods-receipts/{goodsReceiptId}":{"get":{"description":"Retrieves a goods receipt identified by its Yokoy unique ID.","operationId":"getGR","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceipt"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a goods receipt by ID","tags":["Goods receipt"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the goods receipt.","example":"9L7rovNzNhTCsJSTkbfq","in":"path","name":"goodsReceiptId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a goods receipt by replacing some attributes. The goods receipt is specified by its Yokoy unique ID. The whole entity is returned.","operationId":"modifyGR","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of invoice goods receipt attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a goods receipt","tags":["Goods receipt"]},"put":{"description":"Updates an invoice goods receipt by replacing all attributes. The goods receipt is identified by its Yokoy unique ID. The whole entity is returned.","operationId":"UpdateGR","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a goods receipt","tags":["Goods receipt"]}},"/legal-entities/{legalEntityId}/invoice-payment-terms":{"get":{"description":"Returns all payment terms for the legal entity identified in the path.","operationId":"listPaymentTerms","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"invoice-payment-terms":{"items":{"$ref":"#/components/schemas/InvoicePaymentTerms"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all payment terms","tags":["Invoice payment terms"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new invoice payment term and returns the created entity.","operationId":"createPaymentTerm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTerms"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTerms"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a payment term","tags":["Invoice payment terms"]}},"/legal-entities/{legalEntityId}/invoice-payment-terms/{paymentTermId}":{"get":{"description":"Retrieves an invoice payment term identified by its Yokoy unique ID.","operationId":"getPaymentTerm","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTerms"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a payment term by ID","tags":["Invoice payment terms"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the invoice payment term.","example":"06x2u4nagAMEq3gGoMch","in":"path","name":"paymentTermId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates an invoice payment term by replacing some attributes. The payment term is specified by its Yokoy unique ID. The whole entity is returned.","operationId":"modifyPaymentTerm","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of invoice payment term attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTerms"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a payment term","tags":["Invoice payment terms"]},"put":{"description":"Updates an invoice payment term, identified by its Yokoy unique ID, by replacing all attributes. The whole entity is returned.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTerms"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTerms"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a payment term","tags":["Invoice payment terms"]}},"/legal-entities/{legalEntityId}/invoice-purchase-orders":{"get":{"description":"Retrieves all purchase orders for the legal entity identified in the path.","operationId":"listPOs","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"invoice-purchase-orders":{"items":{"$ref":"#/components/schemas/PurchaseOrder"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all purchase orders","tags":["Purchase order"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new purchase order and returns the created entity.","operationId":"createPO","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a purchase order","tags":["Purchase order"]}},"/legal-entities/{legalEntityId}/invoice-purchase-orders/{purchaseOrderId}":{"get":{"description":"Retrieves a purchase order identified by its Yokoy unique ID.","operationId":"getPO","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a purchase order by ID","tags":["Purchase order"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the purchase order.","example":"9L7rovNzNhTCsJSTkbfq","in":"path","name":"purchaseOrderId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a invoice purchase order by replacing some attributes. The purchase order is specified by its Yokoy unique ID. The whole entity is returned.","operationId":"modifyPO","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of purchase order attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a purchase order","tags":["Purchase order"]},"put":{"description":"Updates an invoice purchase order by replacing all attributes. The purchase order is specified by its Yokoy unique ID. The whole entity is returned.","operationId":"updatePO","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a purchase order","tags":["Purchase order"]}},"/legal-entities/{legalEntityId}/invoices":{"get":{"description":"Retrieves all invoices for the legal entity identified in the path.","operationId":"listInvoices","parameters":[{"$ref":"#/components/parameters/QueryFilter"},{"$ref":"#/components/parameters/PaginationCount"},{"$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"invoices":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"},"itemsPerPage":{"$ref":"#/components/schemas/PaginationItemsPerPage"},"nextCursor":{"$ref":"#/components/schemas/PaginationNextCursor"}},"required":["invoices"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all invoices","tags":["Invoice"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new invoice and returns the created entity.","operationId":"createInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create an invoice","tags":["Invoice"]}},"/legal-entities/{legalEntityId}/invoices/einvoice":{"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Uploads a new e-invoice for the legal entity specified by its Yokoy unique ID and returns the details for the created invoice.\n","operationId":"uploadEinvoice","requestBody":{"content":{"multipart/form-data":{"encoding":{"pdf":{"contentType":"application/pdf"}},"schema":{"properties":{"invoiceData":{"description":"All e-invoice structure data, according to the selected standard.\nIt can be expressed as a string as-is or as a base64 encoded version of the data to be used to create the invoice.\n","type":"string"},"pdf":{"description":"The PDF file to be used as the preview file for the invoice within Yokoy.\n","format":"binary","type":"string"},"standard":{"description":"Provides the standard format to which the invoiceData field adheres.\n`peppolBis` means the e-invoice is in UBL XML format following the Peppol BIS 3.0 specification.\n","enum":["peppolBis"],"example":"peppolBis","type":"string"}},"required":["standard","invoiceData","pdf"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"peppolBis":{"value":[{"country":"NL","created":"2024-12-03T08:51:48.742Z","currency":"EUR","customInformation":null,"date":"2024-12-01","documentData":null,"dueDate":"2025-01-30","eventLog":[{"actionType":"added","autoComment":{"key":"invoiceUploadEInvoice"},"comment":"","name":"Yokoy API","timestamp":"2024-12-03T08:51:48.742Z"}],"fxRates":null,"grossAmount":1620,"id":"njx2YwXAF","invoiceNumber":"INV-001","isCreditNote":false,"lastModified":"2024-12-03T08:51:48.742Z","legalEntityId":"wrOWz6e_33I0vNzQPMWyY","lineItems":[{"categoryId":null,"costObjectId":null,"customInformation":null,"description":"Insurance","goodsReceiptId":null,"goodsReceiptItemId":null,"goodsReceiptNumber":null,"gross":1620,"itemPrice":1350,"matchStatus":null,"net":1350,"nonRecoverableTaxAmount":null,"purchaseOrderId":null,"purchaseOrderItemId":null,"purchaseOrderNumber":null,"quantity":1,"selfAssessedTaxAmount":null,"serviceEndDate":null,"serviceStartDate":null,"tags":null,"taxAmount":null,"taxRateComponents":null,"taxRateId":null,"unit":"PC"}],"netAmount":1350,"oneTimeSupplierInfo":null,"paymentBlocked":false,"paymentInformation":{"bankAccount":987654321,"bankCountry":"NL","bankKey":"XXX","bankNumber":124567895,"externalId":null,"iban":"NL1234567891234445","paymentTermId":"06x2u4nagAMEq3gGoMch","postingDate":null,"purchaseOrderIds":[],"qrInfo":null,"swiftCode":"DEUTDEFFXXX"},"serviceDate":["2024-12-01","2025-01-30"],"status":"new","submitters":[],"supplierId":"bbebb9a0-87ef-439c-9ac3-e320e47d85d5","taxableAmount":null}]}},"schema":{"$ref":"#/components/schemas/Invoice"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Upload a new e-invoice to Yokoy","tags":["Invoice"]}},"/legal-entities/{legalEntityId}/invoices/upload":{"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Uploads a new invoice to be processed by the Yokoy AI. The invoice\u2018s attributes may be empty initially but are updated once the AI has run.\n","operationId":"uploadAiInvoice","requestBody":{"content":{"multipart/form-data":{"encoding":{"file":{"contentType":"application/pdf"}},"schema":{"properties":{"file":{"format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Upload a new invoice to be processed by Yokoy AI","tags":["Invoice"]}},"/legal-entities/{legalEntityId}/invoices/{invoiceId}":{"get":{"description":"Retrieves an invoice identified by its Yokoy unique ID.","operationId":"getInvoice","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get an invoice","tags":["Invoice"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the invoice.","example":"9L7rovNzNhTCsJSTkbfq","in":"path","name":"invoiceId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates an invoice identified by its Yokoy unique ID.","operationId":"updateInvoice","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdateInvoice"},{"description":"Only custom information fields at header and line item level can be updated."}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update an invoice","tags":["Invoice"]}},"/legal-entities/{legalEntityId}/invoices/{invoiceId}/base64":{"get":{"description":"Retrieves the supplier invoice PDF file. The response contains a base64 string of the PDF file.\n","operationId":"getInvoiceBase64","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceBase64"}}},"description":"Invoice file in base64 format"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get the invoice PDF file (base64)","tags":["Invoice"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the invoice.","example":"9L7rovNzNhTCsJSTkbfq","in":"path","name":"invoiceId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/legal-entities/{legalEntityId}/invoices/{invoiceId}/presentation":{"get":{"description":"Downloads the supplier invoice file in PDF format\n","operationId":"getInvoicePdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Invoice file in PDF format"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get the invoice file in PDF format","tags":["Invoice"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the invoice.","example":"9L7rovNzNhTCsJSTkbfq","in":"path","name":"invoiceId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/legal-entities/{legalEntityId}/policies":{"get":{"description":"Returns all employee policies for the legal entity specified by its Yokoy unique ID in the path.","operationId":"listPolicies","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"policies":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all policies for a legal entity","tags":["Policy"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new employee policy and returns the created entity.","operationId":"createPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"Created"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a policy","tags":["Policy"]}},"/legal-entities/{legalEntityId}/policies/{policyId}":{"get":{"description":"Retrieves an employee policy specified by its Yokoy unique ID.","operationId":"getPolicy","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a policy by ID","tags":["Policy"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the employee policy.","example":"06x2u4nagAMEq3gGoMch","in":"path","name":"policyId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates an employee policy by replacing some attributes. The legal entity and policy are specified by their unique IDs in the path. `name` and `id` must be passed in the request body. The whole entity is returned.","operationId":"modifyPolicy","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of policy attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a policy","tags":["Policy"]},"put":{"description":"Updates an employee policy identified by its Yokoy unique ID, replacing all attributes. The legal entity and policy are specified by their unique IDs in the path. Any policy attributes that are not specified in the request body are updated with null or \"\". The whole entity is returned.","operationId":"updatePolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a policy","tags":["Policy"]}},"/legal-entities/{legalEntityId}/suppliers":{"get":{"description":"Retrieves all suppliers for a legal entity.","operationId":"listEntitySupplier","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"suppliers":{"items":{"$ref":"#/components/schemas/Supplier"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all suppliers (legal entity)","tags":["Supplier"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Adds an organization supplier to a legal entity, specifying entity-specific information.","operationId":"createEntitySupplier","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntitySupplier"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Add a supplier (legal entity)","tags":["Supplier"]}},"/legal-entities/{legalEntityId}/suppliers/{supplierId}":{"get":{"description":"Retrieves a legal entity supplier identified by its Yokoy legal entity supplier ID.","operationId":"getEntitySupplier","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a supplier by ID (legal entity)","tags":["Supplier"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the legal entity supplier.","example":"bbebb9a0-87ef-439c-9ac3-e320e47d85d5","in":"path","name":"supplierId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a legal entity supplier that is identified by its Yokoy legal entity supplier ID, replacing some entity specific attributes. The whole entity is returned. To change the name, address, or contact person for a legal entity supplier, you must update the organization level supplier. Changes to the legal entity supplier are made automatically from the organization supplier.","operationId":"modifyEntitySupplier","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LegalEntitySupplier"},{"description":"First modify the organization supplier. Then modify the legal entity supplier to update all relevant fields. Explicit null values mark attributes for deletion."}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a supplier (legal entity)","tags":["Supplier"]},"put":{"description":"Updates a legal entity supplier that is identified by its Yokoy unique ID, replacing all entity-specific attributes. The whole entity is returned. To change the name, address, or contact person for a legal entity supplier, you must update the organization level supplier. Changes to the legal entity supplier are made automatically from the organization supplier.","operationId":"updateEntitySupplier","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntitySupplier"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a supplier (legal entity)","tags":["Supplier"]}},"/legal-entities/{legalEntityId}/tags":{"get":{"description":"Retrieves all tags for the legal entity identified by its Yokoy unique ID in the path.","operationId":"listTags","parameters":[{"$ref":"#/components/parameters/QueryFilter"},{"$ref":"#/components/parameters/PaginationCount"},{"$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all tags","tags":["Tag"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new tag and returns the created entity.","operationId":"createTag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"Created"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a tag","tags":["Tag"]}},"/legal-entities/{legalEntityId}/tags/{tagId}":{"delete":{"description":"Deletes a tag identified by its Yokoy unique ID.","operationId":"deleteTag","responses":{"204":{"description":"Tag deleted."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Remove a tag","tags":["Tag"]},"get":{"description":"Retrieves a tag identified by its Yokoy unique ID.","operationId":"getTag","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get tag by ID","tags":["Tag"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the tag.","example":"CP0YGe9VwzWixLOZdTK8","in":"path","name":"tagId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a tag by replacing some attributes. The tag is identified by its Yokoy unique ID passed as a path parameter. The whole entity is returned.","operationId":"modifyTag","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of tag attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a tag","tags":["Tag"]},"put":{"description":"Updates a tag identified by its Yokoy unique ID by replacing all attributes. The whole entity is returned.","operationId":"updateTag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a tag","tags":["Tag"]}},"/legal-entities/{legalEntityId}/tax-rates":{"get":{"description":"Retrieves all tax rates for the legal entity identified by its Yokoy unique ID in the path.","operationId":"listTaxRates","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":[{"accountReference":6300,"code":"tax77","country":"CH","customInformation":{"externalId":"Tax77"},"name":"Standard rate - CH","rate":19,"statusActive":true,"validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"one"},{"accountReference":6300,"code":"tax01","components":[{"assessmentType":"sellerAssessed","expenseAccount":"GST-5","inputAccount":"GST-5 IN","name":"GST","outputAccount":"GST-5 OUT","rate":5,"recoverablePercentage":0},{"assessmentType":"sellerAssessed","expenseAccount":"QST-9","inputAccount":"QST-9 IN","name":"QST","outputAccount":"QST-9 OUT","rate":9.975,"recoverablePercentage":0}],"country":"CA","customInformation":{"externalId":"Tax1"},"id":"06x2u4nagAMEq3gGMoch","name":"Standard rate - CA","rate":14.975,"statusActive":true,"type":"standard","validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"two"}],"properties":{"taxRates":{"items":{"anyOf":[{"$ref":"#/components/schemas/TaxRate"},{"$ref":"#/components/schemas/AdvancedTaxRate"}]},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all tax rates","tags":["Tax rates"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new tax rate and returns the created entity.","operationId":"createTaxRate","requestBody":{"content":{"application/json":{"examples":{"AdvancedTaxRate":{"value":{"accountReference":6300,"code":"tax01","components":[{"assessmentType":"sellerAssessed","expenseAccount":"GST-5","inputAccount":"GST-5 IN","name":"GST","outputAccount":"GST-5 OUT","rate":5,"recoverablePercentage":0},{"assessmentType":"sellerAssessed","inputAccount":"QST-9 IN","name":"QST","outputAccount":"QST-9 OUT","rate":9.975,"recoverablePercentage":0}],"country":"CA","customInformation":{"externalId":"Tax1"},"expenseAccount":"QST-9","name":"Standard rate - CA","rate":14.975,"statusActive":true,"type":"standard","validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT"}},"TaxRate":{"value":{"accountReference":6300,"code":"tax77","country":"CH","customInformation":{"externalId":"Tax77"},"name":"Standard rate - CH","rate":19,"statusActive":true,"type":"standard","validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/TaxRate"},{"$ref":"#/components/schemas/AdvancedTaxRate"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"AdvancedTaxRate":{"value":{"accountReference":6300,"code":"tax01","components":[{"assessmentType":"sellerAssessed","expenseAccount":"GST-5","inputAccount":"GST-5 IN","name":"GST","outputAccount":"GST-5 OUT","rate":5,"recoverablePercentage":0},{"assessmentType":"sellerAssessed","inputAccount":"QST-9 IN","name":"QST","outputAccount":"QST-9 OUT","rate":9.975,"recoverablePercentage":0}],"country":"CA","customInformation":{"externalId":"Tax1"},"expenseAccount":"QST-9","id":"06x2u4nagAMEq3gGMoch","name":"Standard rate - CA","rate":14.975,"statusActive":true,"type":"standard","validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"two"}},"TaxRate":{"value":{"accountReference":6300,"code":"tax77","country":"CH","customInformation":{"externalId":"Tax77"},"id":"220ZSEO2l9","name":"Standard rate - CH","rate":19,"statusActive":true,"validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"one"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/TaxRate"},{"$ref":"#/components/schemas/AdvancedTaxRate"}]}}},"description":"Created"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a tax rate","tags":["Tax rates"]}},"/legal-entities/{legalEntityId}/tax-rates/{taxRateId}":{"get":{"description":"Retrieves a tax rate by its Yokoy unique ID.","operationId":"getTaxRate","responses":{"200":{"content":{"application/json":{"examples":{"AdvancedTaxRate":{"value":{"accountReference":6300,"code":"tax01","components":[{"assessmentType":"sellerAssessed","expenseAccount":"GST-5","inputAccount":"GST-5 IN","name":"GST","outputAccount":"GST-5 OUT","rate":5,"recoverablePercentage":0},{"assessmentType":"sellerAssessed","inputAccount":"QST-9 IN","name":"QST","outputAccount":"QST-9 OUT","rate":9.975,"recoverablePercentage":0}],"country":"CA","customInformation":{"externalId":"Tax1"},"expenseAccount":"QST-9","id":"06x2u4nagAMEq3gGMoch","name":"Standard rate - CA","rate":14.975,"statusActive":true,"type":"standard","validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"two"}},"TaxRate":{"value":{"accountReference":6300,"code":"tax77","country":"CH","customInformation":{"externalId":"Tax77"},"id":"220ZSEO2l9","name":"Standard rate - CH","rate":19,"statusActive":true,"type":"standard","validityEndDate":"Mon, 01 Jan 2024 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"one"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/TaxRate"},{"$ref":"#/components/schemas/AdvancedTaxRate"}]}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a tax rate by ID","tags":["Tax rates"]},"parameters":[{"$ref":"#/components/parameters/LegalEntityIdInPath"},{"description":"Yokoy unique ID of the tax rate.","example":"06x2u4nagAMEq3gGMoch","in":"path","name":"taxRateId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a tax rate by replacing some attributes. The legal entity and the tax rate are specified by their unique IDs in the path. The whole entity is returned.","operationId":"modifyTaxRate","requestBody":{"content":{"application/json":{"examples":{"AdvancedTaxRate":{"value":{"name":"Standard rate - Updated description"}},"TaxRate":{"value":{"name":"Standard rate - Updated description"}}},"schema":{"additionalProperties":true,"description":"Dictionary of tax rate attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"AdvancedTaxRate":{"value":{"accountReference":6300,"code":"tax01","components":[{"assessmentType":"sellerAssessed","expenseAccount":"GST-5","inputAccount":"GST-5 IN","name":"GST","outputAccount":"GST-5 OUT","rate":5,"recoverablePercentage":0},{"assessmentType":"sellerAssessed","inputAccount":"QST-9 IN","name":"QST","outputAccount":"QST-9 OUT","rate":10,"recoverablePercentage":0}],"country":"CA","customInformation":null,"expenseAccount":"QST-9","externalId":"Tax1","id":"06x2u4nagAMEq3gGMoch","name":"Standard rate - Updated description","rate":15,"statusActive":true,"type":"standard","validityEndDate":"Wed, 01 Jan 2025 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"two"}},"TaxRate":{"value":{"accountReference":6300,"code":"tax77","country":"CH","customInformation":{"externalId":"Tax77"},"id":"220ZSEO2l9","name":"Standard rate - Updated description","rate":19,"statusActive":true,"validityEndDate":"Wed, 01 Jan 2025 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"one"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/TaxRate"},{"$ref":"#/components/schemas/AdvancedTaxRate"}]}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a tax rate","tags":["Tax rates"]},"put":{"description":"Updates a tax rate identified by replacing all attributes. The legal entity and the tax rate are specified by their unique IDs in the path. Any attributes that are not specified in the request body are updated with null or \"\" and is flagged as inactive. The whole entity is returned.","operationId":"updateTaxRate","requestBody":{"content":{"application/json":{"examples":{"AdvancedTaxRate":{"value":{"accountReference":6300,"code":"tax01","components":[{"assessmentType":"sellerAssessed","expenseAccount":"GST-5","inputAccount":"GST-5 IN","name":"GST","outputAccount":"GST-5 OUT","rate":5,"recoverablePercentage":0},{"assessmentType":"sellerAssessed","inputAccount":"QST-9 IN","name":"QST","outputAccount":"QST-9 OUT","rate":10,"recoverablePercentage":0}],"country":"CA","customInformation":null,"expenseAccount":"QST-9","externalId":"Tax1","id":"06x2u4nagAMEq3gGMoch","name":"Standard rate - CA 2025","rate":15,"statusActive":true,"type":"standard","validityEndDate":"Wed, 01 Jan 2025 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"two"}},"TaxRate":{"value":{"accountReference":6300,"code":"tax77","country":"CH","customInformation":{"externalId":"Tax77"},"id":"220ZSEO2l9","name":"Standard rate - CH 2025","rate":19,"statusActive":true,"validityEndDate":"Wed, 01 Jan 2025 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"one"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/TaxRate"},{"$ref":"#/components/schemas/AdvancedTaxRate"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"AdvancedTaxRate":{"value":{"accountReference":6300,"code":"tax01","components":[{"assessmentType":"sellerAssessed","expenseAccount":"GST-5","inputAccount":"GST-5 IN","name":"GST","outputAccount":"GST-5 OUT","rate":5,"recoverablePercentage":0},{"assessmentType":"sellerAssessed","inputAccount":"QST-9 IN","name":"QST","outputAccount":"QST-9 OUT","rate":10,"recoverablePercentage":0}],"country":"CA","customInformation":null,"expenseAccount":"QST-9","externalId":"Tax1","id":"06x2u4nagAMEq3gGMoch","name":"Standard rate - CA 2025","rate":15,"statusActive":true,"type":"standard","validityEndDate":"Wed, 01 Jan 2025 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"two"}},"TaxRate":{"value":{"accountReference":6300,"code":"tax77","country":"CH","customInformation":{"externalId":"Tax77"},"id":"220ZSEO2l9","name":"Standard rate - CH 2025","rate":19,"statusActive":true,"validityEndDate":"Wed, 01 Jan 2025 00:00:00 GMT","validityStartDate":"Wed, 01 Jan 2020 00:00:00 GMT","version":"one"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/TaxRate"},{"$ref":"#/components/schemas/AdvancedTaxRate"}]}}},"description":"OK"},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a tax rate","tags":["Tax rates"]}},"/suppliers":{"get":{"description":"Returns all suppliers set up in the organization. Organization suppliers provide the basic details of the supplier, such as name, address, and contacts. To create, update or modify a legal entity supplier (for example, to include the name of the supplier, contact or banking information), you need to first call the organization suppliers endpoint.\nWith a subsequent call to the legal entity supplier endpoint, you can then update the default settings of the supplier at legal entity level.\n**NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.\nIt must have the format: `externalId` of the organization supplier + '_' + Yokoy `legalEntityId`. For example, `S33998_aB9jQoE3HE`.\n","operationId":"listOrgSuppliers","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"organization-suppliers":{"items":{"$ref":"#/components/schemas/OrganizationSupplier"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all suppliers (organization)","tags":["Supplier"]},"parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Companies that supply your company with goods, services, and/or items. The supplier contains general\ninformation of the supplier (ie. name, address, bank accounts, payment terms, etc.) and can be set up with\ndefault settings that are specific per legal entity. Suppliers need to be created first at an organization\nlevel and then added at a company (legal entity) level. Without creating a legal entity supplier, the\nsupplier does not appear in Yokoy (in **Invoice processor > Suppliers**). For more information, see\n(/docs/tutorials/upload-suppliers).\n","operationId":"createOrgSupplier","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSupplier"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSupplier"}}},"description":"Created"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a supplier (organization)","tags":["Supplier"]}},"/suppliers/{supplierId}":{"get":{"description":"Retrieves an organization-level supplier identified by its Yokoy unique ID.","operationId":"getOrgSupplier","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSupplier"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get an organization supplier by ID","tags":["Supplier"]},"parameters":[{"description":"Yokoy unique ID of the organization-level supplier.","example":"8ef7a04a-ce91-4b60-a624-e209f748f86a","in":"path","name":"supplierId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a organization supplier by replacing some attributes. The supplier is identified by its Yokoy unique ID. The whole entity is returned.\n**NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.\nIt must use this format: `externalId` of the organization supplier + '_' + Yokoy `legalEntityId`. For example, `S33998_aB9jQoE3HE`\n","operationId":"modifyOrgSupplier","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of organization supplier attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSupplier"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a supplier (organization)","tags":["Supplier"]},"put":{"description":"Updates an organization supplier by replacing all attributes. The organization supplier is identified by its Yokoy unique ID. The whole entity is returned.\n**NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.\nIt must use this pattern: `externalId` of the organization supplier + '_' + Yokoy `legalEntityId`. For example, `S33998_aB9jQoE3HE`.\n","operationId":"updateOrgSupplier","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSupplier"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSupplier"}}},"description":"OK"},"400":{"$ref":"#/components/responses/HttpValidationError"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a supplier (organization)","tags":["Supplier"]}},"/transactions":{"get":{"description":"Retrieves all transactions for the organization.","operationId":"listTransactions","parameters":[{"$ref":"#/components/parameters/QueryFilter"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"transactions":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all transactions","tags":["Transaction"]},"post":{"description":"Creates a new card transaction in Yokoy that is associated with a specific company card, scoped to a legal entity.","operationId":"addTransaction","parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK."},"400":{"description":"The request was not valid."},"401":{"description":"The server was unable to establish the identity of the client."},"409":{"description":"Unable to process the request."},"429":{"description":"The request cannot be processed by the server due to too many concurrent requests."}},"summary":"Create a card transaction","tags":["Transaction"]}},"/transactions/{transactionId}":{"get":{"description":"Retrieves a transaction identified by its unique ID.","operationId":"getTransaction","parameters":[{"description":"Yokoy unique ID of the transaction.","example":"aB9jQoE3HE","in":"path","name":"transactionId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get transaction by ID","tags":["Transaction"]}},"/trips":{"get":{"description":"Returns all trips for the organization identified by its Yokoy unique ID passed as a path parameter.","operationId":"listTrips","parameters":[{"$ref":"#/components/parameters/QueryFilter"},{"$ref":"#/components/parameters/PaginationCount"},{"$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"trips":{"items":{"$ref":"#/components/schemas/Trip"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all trips for the organization","tags":["Trip"]},"parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/trips/{tripId}":{"get":{"description":"Retrieves a trip identified by its Yokoy unique ID.","operationId":"getTrip","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trip"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a trip by ID","tags":["Trip"]},"parameters":[{"description":"Yokoy unique ID of the trip.","example":"aB9jQoE3HE","in":"path","name":"tripId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}]},"/users":{"get":{"description":"Retrieves all users for the organization ID passed as a parameter in the path.","operationId":"listUsers","parameters":[{"$ref":"#/components/parameters/QueryFilter"},{"$ref":"#/components/parameters/PaginationCount"},{"$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/InvalidFilter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"List all users for the organization","tags":["User"]},"parameters":[{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"post":{"description":"Creates a new user for the organization and returns the created entity (excluding bank information).","operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/UserBankInformation"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created"},"400":{"content":{"application/json":{"example":{"code":400,"message":"ValidationError: Email is mandatory"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Create a user","tags":["User"]}},"/users/{userId}":{"delete":{"description":"Deletes a user identified by its Yokoy unique ID.","operationId":"deleteUser","responses":{"204":{"description":"User deleted."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Delete a user","tags":["User"]},"get":{"description":"Retrieves a user identified by its Yokoy unique ID.","operationId":"getUser","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Get a user by ID","tags":["User"]},"parameters":[{"description":"Yokoy unique ID for the user.","example":"9L7rovNzNhTCsJSTkbfq","in":"path","name":"userId","required":true,"schema":{"pattern":"[\\w-]+","type":"string"}},{"$ref":"#/components/parameters/YokoyAuthMethod"},{"$ref":"#/components/parameters/YokoyCorrelationId"}],"patch":{"description":"Updates a user identified by replacing some attributes. The user is identified by its Yokoy unique ID passed as a path parameter. The whole entity (excluding bank information) is returned.","operationId":"modifyUser","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Dictionary of user attributes to update. Explicit null values mark attributes for deletion.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"example":{"code":400,"message":"ValidationError: email is mandatory"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Modify a user","tags":["User"]},"put":{"description":"Updates a user, replacing attributes provided in the payload. The whole entity (excluding bank information) is returned.","operationId":"updateUser","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/UserBankInformation"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"content":{"application/json":{"example":{"code":400,"message":"ValidationError: email is mandatory"},"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was not valid."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalError"},"502":{"$ref":"#/components/responses/GatewayError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"OAuth2":[]}],"summary":"Update a user","tags":["User"]}}},"servers":[{"description":"API server scoped to organization with ID `organizationId`","url":"https://api.yokoy.ai/v1/organizations/{organizationId}","variables":{"organizationId":{"default":"AbcDeF1234","description":"Yokoy organization ID"}}},{"description":"API test server scoped to organization with ID `organizationId`","url":"https://api.test.yokoy.ai/v1/organizations/{organizationId}","variables":{"organizationId":{"default":"AbcDeF1234","description":"Yokoy organization ID"}}}],"tags":[{"description":"Legal entity or company. An organization can have multiple legal entities.","name":"Legal entity"},{"description":"Cost objects (also called cost centers) is a hierarchical construct to which costs that occur within a company can be assigned. Cost objects are created at legal entity level and can be used for expenses, trips, and invoices.\nApprovers and delegates should be specified using the Yokoy user ID. For any unrecognized IDs, Yokoy creates or updates the cost object attribute with the value `null`. For example, if you pass `Y6cp2G30M` as the `approverId` and no user exists for that ID, Yokoy updates the approver ID attribute as `null`.\n","name":"Cost center"},{"description":"Extend the offered and Yokoy-managed foreign exchange rates (Open Exchange Rates, CNB, NPB and NBS national bank rates) with your own customer-specific FX rates. The created FX rate sources are equivalent to Yokoy-managed FX rate sources and can be applied in **Admin > Company**, **General**. Currencies are assigned on a legal entity level.\n","name":"FX rates"},{"description":"Tax rates. Tax rates apply to expenses, trips, and invoices. In Yokoy, you can consult them in **Admin > VAT / Tax rates**. For invoices, you can set up advanced tax components to adjust to complex tax scenarios. See [Set up advanced tax rates for invoices](https://help.yokoy.ai/en/articles/223727-set-up-advanced-tax-rates-for-invoices).","name":"Tax rates"},{"description":"Company card entity in Yokoy. Company cards can be Yokoy Pay cards or external cards.","name":"Company card"},{"description":"Tag is a custom dimension that can be added to each category that help map additional information to that spend and use it at multiple levels, such as analytics or for accounting purposes.\nTags are often used to enhance Yokoy\u2019s data model for:\n- **management reporting** along multi-dimensional classifications (matrix model).\nFor example, project accounting next to cost accounting (cost centers and cost carriers/projects in a matrix), activity-based controlling (ABC) alongside cost or project accounting, or asset management (e.g. asset capitalisation schedules)\n- **classifications** for processing purposes.\nFor example, approval groups independent of cost center or project accounting structure.\nEach tag belongs to a tag dimension. Tag dimensions are created in Yokoy (**Admin > Company**).\n","name":"Tag"},{"description":"Users in Yokoy reflect the fundamental roles of submitter, approver, and finance user. Mandatory user information depends on the specific organization requirements and Yokoy features enabled.\nEmail addresses must be unique for the organization. You cannot create two users with the same email address. If the email address provided already exists in the organization, the API returns an error.\n\nBank information can be provided as part of POST, PUT, and PATCH requests, however, the response does not return this information for security reasons.\n\n**Note**: You can\u2018t use the User endpoints to determine the roles and permissions assigned to a user. You can only use the endpoints to create a new user.\nRoles and permissions are granted to a user in Yokoy (**Admin > Finance/HR roles**). You must have previously created the user before assigning roles and permissions.\n\n- **Booking strategy**: You can export expenses based on the user selected currency (instead of the company currency or the original expense currency). If you choose this option, you need to provide the user's currency.\n- **Approval strategy**: If you plan to approve expenses using a line manager approval strategy, then you need to enter a line manager for each user.\n- **Expense accounting**: If expenses are to be posted via the employee vendor account, the field `employeeId` should reflect employee vendor account number. If you want to track the employee number, you should set up a custom field to add this information.\n- **User policy**: You can assign rank-specific expense policies to certain users and user groups to determine applicable expense rules, per diem and mileage rates, as well as expense categories. If you choose this option, then you need to enter the policy ID.\n\nFor any unrecognized IDs, Yokoy creates or updates the user attribute with the value `null`. For example, if you pass `Y6cp2G30M` as the `lineManagerId` and no user exists for that ID, Yokoy updates the line manager ID attribute as `null`.\n\nTo guarantee spend data traceability, when you delete a user via the Yokoy API, the email is changed to an email address with the format: `deleted_user_` + user ID. For example, `deleted_user_lK6jo1GmSkXJzSyZSA2f@localhost.invalid`. The user is still displayed in **HR > User management** with a deleted tag and can\u2019t be re-activated or edited. The user can still be retrieved via the Yokoy API using the Yokoy user ID. However, the user is not returned if you retrieve all users using a GET method. Deleted users can\u2019t be re-activated in any way.\n","name":"User"},{"description":"An expense is a cost incurred during the performance of a business activity. Employees can create reimbursable or non-reimbursable expenses. The Expense endpoints let you query all expense types managed in Yokoy: receipt, receiptless, mileage, and per diem. You can query individual expenses included as part of a trip.\n","name":"Expense"},{"description":"A transaction is a cleared payment that is made using a credit, debit, or prepaid card. The card issuer can be either Yokoy or a third party that has been integrated with Yokoy.\n","name":"Transaction"},{"description":"Card account associated to one of Yokoy's card programs. Only active card accounts are allowed to order new cards.\n","name":"Card account"},{"description":"Daily CAMT statement files associated with a card account. Statements provide a daily summary of transactions in a standardized banking format.\n","name":"Daily statement"},{"description":"Categories for expenses (also called booking accounts). These categories only apply to expenses and trips. For invoices, use supplier invoice categories.","name":"Expense category"},{"description":"An employee policy determines the settings made available to a group of employees. A policy determines:\n- **categories**: the categories available to users to select.\n- **tags**: tags applicable to those users\n- **expense rules**: the expense rules used to calculate expenses for those users.\n- **per diems**: applicable rules per diems at a global level, irrespective of whether the conditions are met for applicability.\n- **mileage*: applicable rates at a global level, irrespective of the employee\u2019s mileage counter or border crossings.\n\nYou can use the API to set the categories available to users who have been assigned the policy. To set tags, expense rules, per diems and mileage rates, use the Yokoy UI.\n","name":"Policy"},{"description":"A trip is a collection of various types of expenses that occurred on a business trip over a period of time.","name":"Trip"},{"description":"In the Yokoy API, invoices can only be created or retrieved. You can only update custom information via API.\nTo update other attributes or delete the invoice, use the Yokoy web app.\n","name":"Invoice"},{"description":"Categories for invoices (equivalent to GL accounts in financial systems). These categories only apply to invoices. For expenses and trips, use expense categories.","name":"Invoice category"},{"description":"Payment terms determine the expectation of payment agreed between the company and the supplier. By default, all payment terms can be used with any supplier of the legal entity. However, you can restrict a payment term to a specific supplier by setting `supplierSpecific` to `true` and associating the payment term ID in the Supplier master data.","name":"Invoice payment terms"},{"description":"Companies that supply your company with goods, services, items. The Supplier entity contains information on the name, address, and bank accounts of the supplier.\nSuppliers can be set up for different legal entities with default settings at each legal entity level.\nSuppliers must first be created for the organization at `/suppliers` with their basic definition such as name, address, tax number and bank accounts.\nThen they can be created legal entity-level at `/legal-entities/{entityId}/suppliers` with the organization supplier ID in `supplierId`. Without creating a legal entity supplier, the supplier does not appear in Yokoy (in **Invoice processor > Suppliers**).\nLegal entity suppliers can be updated/created just for certain applicable fields.\nTo add (POST) or update (PATCH or PUT) a complete legal entity supplier record (e.g. the name of the supplier, contact or banking information), you need to add or update the organization supplier first. These changes are automatically progpaged to the legal entity suppliers (i.e. the same supplier may supply several legal entities) linked to that organization supplier. Then in a subsequent call to the legal entity supplier endpoint, you can update the legal entity supplier.\n\n**NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.\nIt must use the following pattern: `externalId` of the organization supplier + '_' + Yokoy ID of the legal entity.\n","name":"Supplier"},{"description":"Purchase orders are legal orders that companies send to their suppliers to buy items, services, products. Yokoy uses purchase orders to perform two-way and three-way matching (matching invoice line items with purchase order line items).","name":"Purchase order"},{"description":"Goods receipt are usually provided by suppliers when the goods of an order are delivered. Yokoy uses goods receipts to perform three-way matching (controlling invoice spending by checking quantities invoiced against the quantities delivered in the goods receipt).","name":"Goods receipt"},{"description":"Invoices that are not present in Yokoy, but that are used for matching in purchase orders and goods receipts.","name":"External invoice"},{"description":"Finance export mechanism in Yokoy. The Yokoy API exposes three different endpoints for the management of finance exports:\n1. `/export-tasks` to trigger an export (separate endpoints for the expense and the invoice module).\nThis action is equivalent to clicking the \"Export\" button under Finance > Export within the Yokoy application.\nAs a result of a successful export, the expenses/invoices are set to the exported state.\n2. `/export-tasks/{exportTaskId}` to poll the details (in particular the status) of the asynchronous export job.\n3. `/export-tasks/{exportTaskId}/artefacts` to fetch the artefacts for those export facilities that support this functionality.\n\nTo generate the standard Yokoy export artefacts, the export facility \"Yokoy Standard Export (API)\" must be selected in Yokoy (Admin > Integrations).\nThe data model of the standard export artefacts (ExpenseExportArtefact and InvoiceExportArtefact) is described in the <a href=\"https://api.yokoy.ai/v1/swagger.json\">following OpenAPI specification</a>.\n","name":"Finance export"}]}